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.

Merchant_BackendBalance_APIAccount_Payouts_APIRequest your account balanceSend account balanceSend request to make a payout to beneficiarySuccessful responseSend request to search for payoutsResponse with payout detailsMerchant_BackendBalance_APIAccount_Payouts_API



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

Merchant_BackendAccount_Payouts_APISend request to make a multiple payouts to multiple beneficiariesSuccessful responseSearch using different filtersResponse with payout detailsMerchant_BackendAccount_Payouts_API



Make a payout with an FX quote

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

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



Reconcilation

Reconcile returns due to unsuccessful payouts.

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