Send a one-time payout to a recipient’s bank account or mobile wallet.
Authentication
AuthorizationBearer
OAuth 2.0 access token
Request
This endpoint expects an object.
merchantIdstringRequired
Merchant ID for the payout
merchantReferencestringRequired
Merchant reference for the payout (used for idempotency and your tracking)
destinationValueobjectRequired
paymentMethodIdenumRequired
Payment method identifier
Allowed values:
paymentLocationstringRequired
3-letter ISO country code (e.g., NGA, KEN, EGY)
recipientobjectRequired
Recipient details for the payout
beneficiaryReferencestringOptional
Reference that appears on the beneficiary’s bank statement. Optional. Use this when you want the recipient to see a specific reference (e.g. invoice number, order ID) on their statement. Separate from merchantReference, which is for your tracking and idempotency. Only applies to certain destinations (e.g. ZAR bank payouts).
clearingTypeenumOptional
Clearing speed for the payout. Only applies to ZAR bank payouts (paymentMethodId banktransfer, paymentLocation ZAF).
- `instant` — Attempt to clear with the beneficiary bank immediately; may incur an additional cost; not supported by all South African banks (falls back to standard when unsupported).
- `standard` — Same-day clearing (default). Omit or set to `standard` for all other currencies or when instant is not required.
Allowed values:
attributesmap from strings to stringsOptional
Additional payout attributes as key-value pairs
senderobjectOptional
Optional sender details for the payout (required for some destinations)
Response
Payout transaction initiated successfully
statusstring
Current transaction status
transactionIdstring
Unique transaction identifier
messagestring
Status message describing the transaction state
authStateobject
Indicates additional steps required to complete a transaction. The shape varies by payment method and processor.
Use type to determine which fields are present.
merchantReferencestring
Merchant reference from the original session
sessionIdstringformat: "uuid"
Session ID associated with the transaction
identifiersmap from strings to strings
Additional identifiers related to the transaction
paymentAttributesmap from strings to strings
Payment-specific attributes and metadata
paymentMethodIdstring
Payment method identifier
processorNamestring
Payment processor name
processorReferencestring
Payment processor reference
financialTransactionReferencestring
Financial transaction reference from the processor
currentAttemptIdstring
Current attempt identifier
batchPayoutIdstring
Batch payout identifier, if the transaction is part of a batch payout
Errors
400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error
Clearing speed for the payout. Only applies to ZAR bank payouts (paymentMethodId banktransfer, paymentLocation ZAF).
instant — Attempt to clear with the beneficiary bank immediately; may incur an additional cost; not supported by all South African banks (falls back to standard when unsupported).
standard — Same-day clearing (default). Omit or set to standard for all other currencies or when instant is not required.
