README

The following pages give you some general information on how to use our APIs.
The actual API services documentation then follows further below. You can use the menu to jump between API sections.

This page has a built-in HTTP(S) client, so you can test the services directly from within this page, by filling in the request parameters and/or body in the respective services, and then hitting the TRY button. Note that you need to be authorized to make a successful API call. To authorize, refer to the 'Authorization' section of Access, or in case you already have a valid user token, just use the QUICK AUTH on the left.
Please also remember that all user management functions should be looked up in Access.

You should also check out the Web Form 2.0 Public Documentation as well as Access Public Documentation for more information. If you need any help with the API, contact support@finapi.io.
<h2 id="general-information">General information<h3 id="general-request-ids">Request IDsWith any API call, you can pass a request ID via a header with name "X-Request-Id". The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error.

If you don't pass a request ID for a call, finAPI will generate a random ID internally.

The request ID is always returned back in the response of a service, as a header with name "X-Request-Id".

We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response(especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.<h3 id="type-coercion">Type CoercionIn order to ease the integration for some languages, which do not natively support high precision number representations, Web Form 2.0 API supports relax type binding for the openAPI type number, which is used for money amount fields. If you use one of those languages, to avoid precision errors that can appear from float values, you can pass the amount as a string.<h3 id="general-faq">FAQIs there a finAPI SDK?
Currently we do not offer a native SDK, but there is the option to generate an SDKfor almost any target language via OpenAPI. Use the 'Download SDK' button on this page for SDK generation.

Why do I need to keep authorizing when calling services on this page?
This page is a "one-page-app". Reloading the page resets the OAuth authorization context. There is generally no need to reload the page, so just don't do it and your authorization will persist.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https:////.git"
    }
  ],
  "require": {
    "/": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure OAuth2 access token for authorization: BearerAccessToken
$config = OpenAPIWebForm\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPIWebForm\Client\Api\AccountInformationServicesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$bank_connection_update_task_details = new \OpenAPIWebForm\Client\Model\BankConnectionUpdateTaskDetails(); // \OpenAPIWebForm\Client\Model\BankConnectionUpdateTaskDetails

try {
    $result = $apiInstance->createBankConnectionUpdateTask($bank_connection_update_task_details);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountInformationServicesApi->createBankConnectionUpdateTask: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://webform-sandbox.finapi.io

Class	Method	HTTP request	Description
AccountInformationServicesApi	createBankConnectionUpdateTask	POST /api/tasks/backgroundUpdate	Update a bank connection
AccountInformationServicesApi	createForBankConnectionImport	POST /api/webForms/bankConnectionImport	Import a bank connection
CustomisationProfilesApi	createProfile	POST /api/profiles	Create a profile
CustomisationProfilesApi	deleteProfile	DELETE /api/profiles/{id}	Delete a profile
CustomisationProfilesApi	editProfile	PATCH /api/profiles/{id}	Edit a profile
CustomisationProfilesApi	getProfile	GET /api/profiles/{id}	Get a profile
CustomisationProfilesApi	getProfiles	GET /api/profiles	Get profiles
CustomisationTranslationsBETAApi	createTranslation	POST /api/translations	Create a translation (BETA)
CustomisationTranslationsBETAApi	deleteTranslation	DELETE /api/translations/{id}	Delete a translation (BETA)
CustomisationTranslationsBETAApi	getTranslation	GET /api/translations/{id}	Get a translation (BETA)
CustomisationTranslationsBETAApi	getTranslations	GET /api/translations	Get translations (BETA)
PaymentInitiationServicesApi	createForDirectDebitWithAccountId	POST /api/webForms/directDebitWithAccountId	Create a direct debit with account ID
PaymentInitiationServicesApi	createForPaymentWithAccountId	POST /api/webForms/paymentWithAccountId	Create a payment with account ID
PaymentInitiationServicesApi	createForStandalonePayment	POST /api/webForms/standalonePayment	Create a standalone payment
PaymentInitiationServicesApi	createForStandingOrder	POST /api/webForms/standingOrder	Create a standing order
TasksApi	getTask	GET /api/tasks/{id}	Get a task
TasksApi	getTasks	GET /api/tasks	Get tasks
WebFormsApi	deleteWebForm	DELETE /api/webForms/{id}	Delete a web form
WebFormsApi	getWebForm	GET /api/webForms/{id}	Get a web form
WebFormsApi	getWebForms	GET /api/webForms	Get web forms

Models

Authorization

BearerAccessToken

Type: OAuth
Flow: password
Authorization URL: ``
Scopes:
- all: no limitations

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 2.685.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

eciboadaptech / finapi-webform

Maintainers

Details