Payouts APIPayout

Initiate a payout transaction

Creates a new payout transaction for the specified recipient

Request

This endpoint expects an object.
merchantIdstringRequired
Merchant ID for the payout
merchantReferencestringRequired
Merchant reference for the payout
amountintegerRequired0-1000000000000

Payment amount in minor units (e.g. cents)

currencystringRequired

3-character ISO currency code

paymentMethodIdenumRequired

Payment method identifier (e.g., “banktransfer”)

paymentLocationstringRequired

3-letter ISO country code

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

Response

Payout transaction initiated successfully

Errors