Create International Payout

Initiates an international payout to an existing recipient, created via the Create Recipient API. The destination currency and corridor are determined by the recipient's bank details.

Requires an Idempotency-Key header to safely retry the request without risking a duplicate payout.

Exactly one of source_amount or destination_amount must be provided — not both.

Body Params
string
required
Defaults to REP-081BCADE9A

The identifier of an existing recipient (created via the Create Recipient API) to send the payout to.

string
required
Defaults to supplier_payment

The reason / category for this payout.

string

A free-text description of what the payout is for.

string
≥ 100
Defaults to 500.00

The amount to deduct from the merchant's balance, as a string, always in AED. Minimum 100 AED. Provide either source_amount or destination_amount, not both.

string

The amount the recipient should receive, as a string, in the recipient's destination currency. Provide either source_amount or destination_amount, not both.

Headers
string
required

A unique key (e.g. a UUID) identifying this request. Retrying a request with the same key will not create a duplicate payout.

Responses

500

Unexpected error

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json