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.

Installation & Usage

Requirements

PHP 7.3 and later. Should also work with PHP 8.0 but has not been tested.

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-live.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
AccountInformationServicesApi	createForBankConnectionUpdate	POST /api/webForms/bankConnectionUpdate	Update a bank connection (BETA - DEPRECATED)
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
ProfilesApi	createProfile	POST /api/profiles	Create a profile
ProfilesApi	deleteProfile	DELETE /api/profiles/{id}	Delete a profile
ProfilesApi	editProfile	PATCH /api/profiles/{id}	Edit a profile
ProfilesApi	getProfile	GET /api/profiles/{id}	Get a profile
ProfilesApi	getProfiles	GET /api/profiles	Get profiles
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.277.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

adaptech / finapi-webform

Maintainers

Details