v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Client Account Transfer Endpoints

account/client-accounts/fund-transfer-withdraw

This endpoint will fund the debitor client account using their default bank account, and then transfer the money to the recipient client account once the funds have been cleared. Once the funds are transferred, a withdraw transaction will be triggered to send the funds to the recipient client account's default bank account.

To set a default bank account, please use the /bank-account/set-my-bank-account endpoint.

post/account/client-accounts/fund-transfer-withdraw

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

FundingTransactionIDinteger

The unique ID of the funding transaction that was just created. This ID should be saved as it is required order to look up the status information on the transaction.

WithdrawTransactionIDinteger

The unique ID of the withdrawal transaction that was just created. This ID should be saved as it is required order to look up the status information on the transaction.

AccountTransferIDinteger

The unique ID of the account transfer that was just created. This ID should be saved as it is required order to look up the status information on the transaction.