Payments

Available Operations

addAccountToPool - Add an account to a pool
connectorsTransfer - Transfer funds between Connector accounts
createAccount - Create an account
createBankAccount - Create a BankAccount in Payments and on the PSP
createPayment - Create a payment
createPool - Create a Pool
createTransferInitiation - Create a TransferInitiation
deletePool - Delete a Pool
deleteTransferInitiation - Delete a transfer initiation
forwardBankAccount - Forward a bank account to a connector
getAccountBalances - Get account balances
getBankAccount - Get a bank account created by user on Formance
~~getConnectorTask~~ - Read a specific task of the connector ⚠️ Deprecated
getConnectorTaskV1 - Read a specific task of the connector
getPayment - Get a payment
getPool - Get a Pool
getPoolBalances - Get pool balances
getTransferInitiation - Get a transfer initiation
installConnector - Install a connector
listAllConnectors - List all installed connectors
listBankAccounts - List bank accounts created by user on Formance
listConfigsAvailableConnectors - List the configs of each available connector
~~listConnectorTasks~~ - List tasks from a connector ⚠️ Deprecated
listConnectorTasksV1 - List tasks from a connector
listPayments - List payments
listPools - List Pools
listTransferInitiations - List Transfer Initiations
paymentsgetAccount - Get an account
paymentsgetServerInfo - Get server info
paymentslistAccounts - List accounts
~~readConnectorConfig~~ - Read the config of a connector ⚠️ Deprecated
readConnectorConfigV1 - Read the config of a connector
removeAccountFromPool - Remove an account from a pool
~~resetConnector~~ - Reset a connector ⚠️ Deprecated
resetConnectorV1 - Reset a connector
retryTransferInitiation - Retry a failed transfer initiation
reverseTransferInitiation - Reverse a transfer initiation
udpateTransferInitiationStatus - Update the status of a transfer initiation
~~uninstallConnector~~ - Uninstall a connector ⚠️ Deprecated
uninstallConnectorV1 - Uninstall a connector
updateBankAccountMetadata - Update metadata of a bank account
updateConnectorConfigV1 - Update the config of a connector
updateMetadata - Update metadata

addAccountToPool

Add an account to a pool

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\AddAccountToPoolRequest();
    $request->addAccountToPoolRequest = new Shared\AddAccountToPoolRequest();
    $request->addAccountToPoolRequest->accountID = '<value>';
    $request->poolId = 'XXX';;

    $response = $sdk->payments->addAccountToPool($request);

    if ($response->statusCode === 200) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\AddAccountToPoolRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\AddAccountToPoolResponse

connectorsTransfer

Execute a transfer between two accounts.

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\ConnectorsTransferRequest();
    $request->transferRequest = new Shared\TransferRequest();
    $request->transferRequest->amount = 100;
    $request->transferRequest->asset = 'USD';
    $request->transferRequest->destination = 'acct_1Gqj58KZcSIg2N2q';
    $request->transferRequest->source = 'acct_1Gqj58KZcSIg2N2q';
    $request->connector = Shared\Connector::BankingCircle;;

    $response = $sdk->payments->connectorsTransfer($request);

    if ($response->transferResponse !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\ConnectorsTransferRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\ConnectorsTransferResponse

createAccount

Create an account

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Shared\AccountRequest();
    $request->accountName = '<value>';
    $request->connectorID = '<value>';
    $request->createdAt = DateTime::createFromFormat('Y-m-d\TH:i:s+', '2024-08-19T02:15:08.668Z');
    $request->defaultAsset = '<value>';
    $request->metadata = [
        'grey' => '<value>',
    ];
    $request->reference = '<value>';
    $request->type = Shared\AccountType::Unknown;;

    $response = $sdk->payments->createAccount($request);

    if ($response->paymentsAccountResponse !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Shared\AccountRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\CreateAccountResponse

createBankAccount

Create a bank account in Payments and on the PSP.

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Shared\BankAccountRequest();
    $request->accountNumber = '<value>';
    $request->connectorID = '<value>';
    $request->country = 'GB';
    $request->iban = 'HU80500236840980904027018003';
    $request->metadata = [
        'Manganese' => '<value>',
    ];
    $request->name = 'My account';
    $request->swiftBicCode = '<value>';;

    $response = $sdk->payments->createBankAccount($request);

    if ($response->bankAccountResponse !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Shared\BankAccountRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\CreateBankAccountResponse

createPayment

Create a payment

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Shared\PaymentRequest();
    $request->amount = 100;
    $request->asset = 'USD';
    $request->connectorID = '<value>';
    $request->createdAt = DateTime::createFromFormat('Y-m-d\TH:i:s+', '2024-11-09T01:03:21.153Z');
    $request->destinationAccountID = '<value>';
    $request->reference = '<value>';
    $request->scheme = Shared\PaymentScheme::GooglePay;
    $request->sourceAccountID = '<value>';
    $request->status = Shared\PaymentStatus::DisputeWon;
    $request->type = Shared\PaymentType::Transfer;;

    $response = $sdk->payments->createPayment($request);

    if ($response->paymentResponse !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Shared\PaymentRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\CreatePaymentResponse

createPool

Create a Pool

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Shared\PoolRequest();
    $request->accountIDs = [
        '<value>',
    ];
    $request->name = '<value>';;

    $response = $sdk->payments->createPool($request);

    if ($response->poolResponse !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Shared\PoolRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\CreatePoolResponse

createTransferInitiation

Create a transfer initiation

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Shared\TransferInitiationRequest();
    $request->amount = 256698;
    $request->asset = 'USD';
    $request->connectorID = '<value>';
    $request->description = 'Multi-tiered incremental methodology';
    $request->destinationAccountID = '<value>';
    $request->metadata = [
        'deposit' => '<value>',
    ];
    $request->provider = Shared\Connector::Mangopay;
    $request->reference = 'XXX';
    $request->scheduledAt = DateTime::createFromFormat('Y-m-d\TH:i:s+', '2022-05-20T07:14:32.431Z');
    $request->sourceAccountID = '<value>';
    $request->type = Shared\TransferInitiationRequestType::Payout;
    $request->validated = false;;

    $response = $sdk->payments->createTransferInitiation($request);

    if ($response->transferInitiationResponse !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Shared\TransferInitiationRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\CreateTransferInitiationResponse

deletePool

Delete a pool by its id.

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\DeletePoolRequest();
    $request->poolId = 'XXX';;

    $response = $sdk->payments->deletePool($request);

    if ($response->statusCode === 200) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\DeletePoolRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\DeletePoolResponse

deleteTransferInitiation

Delete a transfer initiation by its id.

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\DeleteTransferInitiationRequest();
    $request->transferId = 'XXX';;

    $response = $sdk->payments->deleteTransferInitiation($request);

    if ($response->statusCode === 200) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\DeleteTransferInitiationRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\DeleteTransferInitiationResponse

forwardBankAccount

Forward a bank account to a connector

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\ForwardBankAccountRequest();
    $request->forwardBankAccountRequest = new Shared\ForwardBankAccountRequest();
    $request->forwardBankAccountRequest->connectorID = '<value>';
    $request->bankAccountId = 'XXX';;

    $response = $sdk->payments->forwardBankAccount($request);

    if ($response->bankAccountResponse !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\ForwardBankAccountRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\ForwardBankAccountResponse

getAccountBalances

Get account balances

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\GetAccountBalancesRequest();
    $request->accountId = 'XXX';
    $request->asset = '<value>';
    $request->cursor = 'aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==';
    $request->from = DateTime::createFromFormat('Y-m-d\TH:i:s+', '2023-02-05T05:11:20.042Z');
    $request->limit = 743236;
    $request->pageSize = 100;
    $request->sort = [
        '<value>',
    ];
    $request->to = DateTime::createFromFormat('Y-m-d\TH:i:s+', '2022-05-18T12:09:40.608Z');;

    $response = $sdk->payments->getAccountBalances($request);

    if ($response->balancesCursor !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\GetAccountBalancesRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\GetAccountBalancesResponse

getBankAccount

Get a bank account created by user on Formance

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\GetBankAccountRequest();
    $request->bankAccountId = 'XXX';;

    $response = $sdk->payments->getBankAccount($request);

    if ($response->bankAccountResponse !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\GetBankAccountRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\GetBankAccountResponse

getConnectorTask

Get a specific task associated to the connector.

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\GetConnectorTaskRequest();
    $request->connector = Shared\Connector::Adyen;
    $request->taskId = 'task1';;

    $response = $sdk->payments->getConnectorTask($request);

    if ($response->taskResponse !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\GetConnectorTaskRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\GetConnectorTaskResponse

getConnectorTaskV1

Get a specific task associated to the connector.

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\GetConnectorTaskV1Request();
    $request->connector = Shared\Connector::BankingCircle;
    $request->connectorId = 'XXX';
    $request->taskId = 'task1';;

    $response = $sdk->payments->getConnectorTaskV1($request);

    if ($response->taskResponse !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\GetConnectorTaskV1Request	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\GetConnectorTaskV1Response

getPayment

Get a payment

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\GetPaymentRequest();
    $request->paymentId = 'XXX';;

    $response = $sdk->payments->getPayment($request);

    if ($response->paymentResponse !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\GetPaymentRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\GetPaymentResponse

getPool

Get a Pool

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\GetPoolRequest();
    $request->poolId = 'XXX';;

    $response = $sdk->payments->getPool($request);

    if ($response->poolResponse !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\GetPoolRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\GetPoolResponse

getPoolBalances

Get pool balances

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\GetPoolBalancesRequest();
    $request->at = DateTime::createFromFormat('Y-m-d\TH:i:s+', '2023-05-05T06:40:23.018Z');
    $request->poolId = 'XXX';;

    $response = $sdk->payments->getPoolBalances($request);

    if ($response->poolBalancesResponse !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\GetPoolBalancesRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\GetPoolBalancesResponse

getTransferInitiation

Get a transfer initiation

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\GetTransferInitiationRequest();
    $request->transferId = 'XXX';;

    $response = $sdk->payments->getTransferInitiation($request);

    if ($response->transferInitiationResponse !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\GetTransferInitiationRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\GetTransferInitiationResponse

installConnector

Install a connector by its name and config.

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\InstallConnectorRequest();
    $request->requestBody = '<value>';
    $request->connector = Shared\Connector::Wise;;

    $response = $sdk->payments->installConnector($request);

    if ($response->connectorResponse !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\InstallConnectorRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\InstallConnectorResponse

listAllConnectors

List all installed connectors.

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
    $response = $sdk->payments->listAllConnectors();

    if ($response->connectorsResponse !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Response

?\formance\stack\Models\Operations\ListAllConnectorsResponse

listBankAccounts

List all bank accounts created by user on Formance.

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\ListBankAccountsRequest();
    $request->cursor = 'aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==';
    $request->pageSize = 100;
    $request->sort = [
        '<value>',
    ];;

    $response = $sdk->payments->listBankAccounts($request);

    if ($response->bankAccountsCursor !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\ListBankAccountsRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\ListBankAccountsResponse

listConfigsAvailableConnectors

List the configs of each available connector.

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
    $response = $sdk->payments->listConfigsAvailableConnectors();

    if ($response->connectorsConfigsResponse !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Response

?\formance\stack\Models\Operations\ListConfigsAvailableConnectorsResponse

listConnectorTasks

List all tasks associated with this connector.

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\ListConnectorTasksRequest();
    $request->connector = Shared\Connector::Modulr;
    $request->cursor = 'aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==';
    $request->pageSize = 100;;

    $response = $sdk->payments->listConnectorTasks($request);

    if ($response->tasksCursor !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\ListConnectorTasksRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\ListConnectorTasksResponse

listConnectorTasksV1

List all tasks associated with this connector.

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\ListConnectorTasksV1Request();
    $request->connector = Shared\Connector::BankingCircle;
    $request->connectorId = 'XXX';
    $request->cursor = 'aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==';
    $request->pageSize = 100;;

    $response = $sdk->payments->listConnectorTasksV1($request);

    if ($response->tasksCursor !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\ListConnectorTasksV1Request	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\ListConnectorTasksV1Response

listPayments

List payments

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\ListPaymentsRequest();
    $request->cursor = 'aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==';
    $request->pageSize = 100;
    $request->query = '<value>';
    $request->sort = [
        '<value>',
    ];;

    $response = $sdk->payments->listPayments($request);

    if ($response->paymentsCursor !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\ListPaymentsRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\ListPaymentsResponse

listPools

List Pools

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\ListPoolsRequest();
    $request->cursor = 'aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==';
    $request->pageSize = 100;
    $request->query = '<value>';
    $request->sort = [
        '<value>',
    ];;

    $response = $sdk->payments->listPools($request);

    if ($response->poolsCursor !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\ListPoolsRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\ListPoolsResponse

listTransferInitiations

List Transfer Initiations

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\ListTransferInitiationsRequest();
    $request->cursor = 'aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==';
    $request->pageSize = 100;
    $request->query = '<value>';
    $request->sort = [
        '<value>',
    ];;

    $response = $sdk->payments->listTransferInitiations($request);

    if ($response->transferInitiationsCursor !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\ListTransferInitiationsRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\ListTransferInitiationsResponse

paymentsgetAccount

Get an account

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\PaymentsgetAccountRequest();
    $request->accountId = 'XXX';;

    $response = $sdk->payments->paymentsgetAccount($request);

    if ($response->paymentsAccountResponse !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\PaymentsgetAccountRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\PaymentsgetAccountResponse

paymentsgetServerInfo

Get server info

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
    $response = $sdk->payments->paymentsgetServerInfo();

    if ($response->serverInfo !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Response

?\formance\stack\Models\Operations\PaymentsgetServerInfoResponse

paymentslistAccounts

List accounts

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\PaymentslistAccountsRequest();
    $request->requestBody = [
        'Rustic' => '<value>',
    ];
    $request->cursor = 'aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==';
    $request->pageSize = 100;
    $request->query = '<value>';
    $request->sort = [
        '<value>',
    ];;

    $response = $sdk->payments->paymentslistAccounts($request);

    if ($response->accountsCursor !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\PaymentslistAccountsRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\PaymentslistAccountsResponse

readConnectorConfig

Read connector config

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\ReadConnectorConfigRequest();
    $request->connector = Shared\Connector::Generic;;

    $response = $sdk->payments->readConnectorConfig($request);

    if ($response->connectorConfigResponse !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\ReadConnectorConfigRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\ReadConnectorConfigResponse

readConnectorConfigV1

Read connector config

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\ReadConnectorConfigV1Request();
    $request->connector = Shared\Connector::CurrencyCloud;
    $request->connectorId = 'XXX';;

    $response = $sdk->payments->readConnectorConfigV1($request);

    if ($response->connectorConfigResponse !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\ReadConnectorConfigV1Request	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\ReadConnectorConfigV1Response

removeAccountFromPool

Remove an account from a pool by its id.

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\RemoveAccountFromPoolRequest();
    $request->accountId = 'XXX';
    $request->poolId = 'XXX';;

    $response = $sdk->payments->removeAccountFromPool($request);

    if ($response->statusCode === 200) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\RemoveAccountFromPoolRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\RemoveAccountFromPoolResponse

resetConnector

Reset a connector by its name. It will remove the connector and ALL PAYMENTS generated with it.

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\ResetConnectorRequest();
    $request->connector = Shared\Connector::Atlar;;

    $response = $sdk->payments->resetConnector($request);

    if ($response->statusCode === 200) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\ResetConnectorRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\ResetConnectorResponse

resetConnectorV1

Reset a connector by its name. It will remove the connector and ALL PAYMENTS generated with it.

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\ResetConnectorV1Request();
    $request->connector = Shared\Connector::Generic;
    $request->connectorId = 'XXX';;

    $response = $sdk->payments->resetConnectorV1($request);

    if ($response->statusCode === 200) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\ResetConnectorV1Request	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\ResetConnectorV1Response

retryTransferInitiation

Retry a failed transfer initiation

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\RetryTransferInitiationRequest();
    $request->transferId = 'XXX';;

    $response = $sdk->payments->retryTransferInitiation($request);

    if ($response->statusCode === 200) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\RetryTransferInitiationRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\RetryTransferInitiationResponse

reverseTransferInitiation

Reverse transfer initiation

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\ReverseTransferInitiationRequest();
    $request->reverseTransferInitiationRequest = new Shared\ReverseTransferInitiationRequest();
    $request->reverseTransferInitiationRequest->amount = 327549;
    $request->reverseTransferInitiationRequest->asset = 'USD';
    $request->reverseTransferInitiationRequest->description = 'Streamlined high-level local area network';
    $request->reverseTransferInitiationRequest->metadata = [
        'sky' => '<value>',
    ];
    $request->reverseTransferInitiationRequest->reference = 'XXX';
    $request->transferId = 'XXX';;

    $response = $sdk->payments->reverseTransferInitiation($request);

    if ($response->statusCode === 200) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\ReverseTransferInitiationRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\ReverseTransferInitiationResponse

udpateTransferInitiationStatus

Update a transfer initiation status

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\UdpateTransferInitiationStatusRequest();
    $request->updateTransferInitiationStatusRequest = new Shared\UpdateTransferInitiationStatusRequest();
    $request->updateTransferInitiationStatusRequest->status = Shared\Status::Validated;
    $request->transferId = 'XXX';;

    $response = $sdk->payments->udpateTransferInitiationStatus($request);

    if ($response->statusCode === 200) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\UdpateTransferInitiationStatusRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\UdpateTransferInitiationStatusResponse

uninstallConnector

Uninstall a connector by its name.

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\UninstallConnectorRequest();
    $request->connector = Shared\Connector::Modulr;;

    $response = $sdk->payments->uninstallConnector($request);

    if ($response->statusCode === 200) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\UninstallConnectorRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\UninstallConnectorResponse

uninstallConnectorV1

Uninstall a connector by its name.

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\UninstallConnectorV1Request();
    $request->connector = Shared\Connector::Generic;
    $request->connectorId = 'XXX';;

    $response = $sdk->payments->uninstallConnectorV1($request);

    if ($response->statusCode === 200) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\UninstallConnectorV1Request	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\UninstallConnectorV1Response

updateBankAccountMetadata

Update metadata of a bank account

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\UpdateBankAccountMetadataRequest();
    $request->updateBankAccountMetadataRequest = new Shared\UpdateBankAccountMetadataRequest();
    $request->updateBankAccountMetadataRequest->metadata = [
        'West' => '<value>',
    ];
    $request->bankAccountId = 'XXX';;

    $response = $sdk->payments->updateBankAccountMetadata($request);

    if ($response->statusCode === 200) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\UpdateBankAccountMetadataRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\UpdateBankAccountMetadataResponse

updateConnectorConfigV1

Update connector config

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\UpdateConnectorConfigV1Request();
    $request->requestBody = '<value>';
    $request->connector = Shared\Connector::Stripe;
    $request->connectorId = 'XXX';;

    $response = $sdk->payments->updateConnectorConfigV1($request);

    if ($response->statusCode === 200) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\UpdateConnectorConfigV1Request	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\UpdateConnectorConfigV1Response

updateMetadata

Update metadata

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \formance\stack;
use \formance\stack\Models\Shared;
use \formance\stack\Models\Operations;

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Operations\UpdateMetadataRequest();
    $request->requestBody = [
        'synthesizing' => '<value>',
    ];
    $request->paymentId = 'XXX';;

    $response = $sdk->payments->updateMetadata($request);

    if ($response->statusCode === 200) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	\formance\stack\Models\Operations\UpdateMetadataRequest	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\UpdateMetadataResponse

Files

README.md

Latest commit

History

README.md

File metadata and controls

Payments

Available Operations

addAccountToPool

Example Usage

Parameters

Response

connectorsTransfer

Example Usage

Parameters

Response

createAccount

Example Usage

Parameters

Response

createBankAccount

Example Usage

Parameters

Response

createPayment

Example Usage

Parameters

Response

createPool

Example Usage

Parameters

Response

createTransferInitiation

Example Usage

Parameters

Response

deletePool

Example Usage

Parameters

Response

deleteTransferInitiation

Example Usage

Parameters

Response

forwardBankAccount

Example Usage

Parameters

Response

getAccountBalances

Example Usage

Parameters

Response

getBankAccount

Example Usage

Parameters

Response

getConnectorTask

Example Usage

Parameters

Response

getConnectorTaskV1

Example Usage

Parameters

Response

getPayment

Example Usage

Parameters

Response

getPool

Example Usage

Parameters

Response

getPoolBalances

Example Usage

Parameters

Response

getTransferInitiation

Example Usage

Parameters

Response