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.

payoutIdstringOptional

Unique identifier for the payout.

statusenumOptional

Current status of the payout.

Allowed values:
createdAtdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

Timestamp when the payout was created.

recipientobjectOptional
currencystringOptional

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

amountdoubleOptional

The payout amount.

referencestringOptional

Merchant-provided reference for the payout.

metadatamap from strings to anyOptional

Optional metadata object for additional information.

Errors