Skip to content

Account payouts - sequence diagrams

Below are some of the most common use cases involving our Account Payouts, FX and Account APIs.

Get an account balance before making a successful payout

Check your account balance before sending a payout to a beneficiary.

Account_Payouts_APIBalance_APIMerchant_BackendAccount_Payouts_APIBalance_APIMerchant_BackendRequest your account balanceSend account balanceSend request to make a payout to beneficiarySuccessful responseSend request to search for payoutsResponse with payout details
Account_Payouts_APIBalance_APIMerchant_BackendAccount_Payouts_APIBalance_APIMerchant_BackendRequest your account balanceSend account balanceSend request to make a payout to beneficiarySuccessful responseSend request to search for payoutsResponse with payout details


Make multiple payouts to multiple different beneficiaries and search by a specific criteria after.

Account_Payouts_APIMerchant_BackendAccount_Payouts_APIMerchant_BackendSend request to make a multiple payouts to multiple beneficiariesSuccessful responseSearch using different filtersResponse with payout details
Account_Payouts_APIMerchant_BackendAccount_Payouts_APIMerchant_BackendSend request to make a multiple payouts to multiple beneficiariesSuccessful responseSearch using different filtersResponse with payout details


Make a payout with an FX quote

Retrieve an FX quote which you can supply for up to 30 days in your payout request.

Account_Payouts_APIFX_APIMerchant_BackendAccount_Payouts_APIFX_APIMerchant_BackendRequest an FX quoteReceive response with a quoteIdSend request to make a payout to beneficiary using quoteIdSuccessful responseSend request to search for payoutsResponse with payout details
Account_Payouts_APIFX_APIMerchant_BackendAccount_Payouts_APIFX_APIMerchant_BackendRequest an FX quoteReceive response with a quoteIdSend request to make a payout to beneficiary using quoteIdSuccessful responseSend request to search for payoutsResponse with payout details


Reconciliation

Reconcile returns due to unsuccessful payouts.

Statement_APIAccount_Payouts_APIBalance_APIMerchant_BackendStatement_APIAccount_Payouts_APIBalance_APIMerchant_BackendRequest account balanceBalance responseSend request to make a payout to beneficiarySuccessful responseCheck statement to ensure funds haven't been returnedStatement returned
Statement_APIAccount_Payouts_APIBalance_APIMerchant_BackendStatement_APIAccount_Payouts_APIBalance_APIMerchant_BackendRequest account balanceBalance responseSend request to make a payout to beneficiarySuccessful responseCheck statement to ensure funds haven't been returnedStatement returned