Payouts APIPayouts

Initiate Payout

Initiates a third-party payment (payout) to a specified recipient.

Request

This endpoint expects an object.
recipientobjectRequired
currencystringRequired

The currency code (e.g., ‘USD’).

amountdoubleRequired
The payout amount.
referencestringRequired

Merchant-provided reference for the payout.

metadatamap from strings to anyOptional
Optional metadata object for additional information.

Response

Payout initiated successfully.
payoutIdstring or null
Unique identifier for the payout.
statusenum or null
Current status of the payout.
Allowed values:
createdAtdatetime or nullDefaults to 1970-01-01T00:00:00.000Z
Timestamp when the payout was created.
recipientobject or null
currencystring or null

The currency code (e.g., ‘USD’).

amountdouble or null
The payout amount.
referencestring or null

Merchant-provided reference for the payout.

metadatamap from strings to any or null
Optional metadata object for additional information.

Errors