PayoutsPayouts

Create Payout (Single)

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)

destinationValueobjectRequired
paymentMethodIdenumRequired
Payment method identifier
Allowed values:
paymentLocationstringRequired

3-letter ISO country code (e.g., NGA, KEN, EGY)

recipientobjectRequired
Recipient details for the payout
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 or null

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 or null
Merchant reference from the original session
sessionIdstring or nullformat: "uuid"
Session ID associated with the transaction
identifiersmap from strings to strings or null
Additional identifiers related to the transaction
paymentAttributesmap from strings to strings or null

Payment-specific attributes and metadata

paymentMethodIdstring or null
Payment method identifier
processorNamestring or null
Payment processor name
processorReferencestring or null
Payment processor reference
financialTransactionReferencestring or null
Financial transaction reference from the processor
currentAttemptIdstring or null
Current attempt identifier
batchPayoutIdstring or null
Batch payout identifier, if the transaction is part of a batch payout

Errors