Sign in

v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
Client Account Transfer Endpoints

account/client-accounts/transfer-withdraw

This endpoint will transfer money from the debitor client account to the recipient client account, and then immediately withdraw the money from the recipient client account into their default bank account.

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

post/account/client-accounts/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

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.