v1

latestOpenAPI 3.0.02026-07-2623060.7 KB

Create a payout

This endpoint creates a new payout.

post/payouts

Request body

amountinteger required

Amount of the payout.

modestring required

Payout mode (e.g., 'bank_transfer', 'mobile_money').

Response

Payout created successfully.

idinteger

Payout ID.

referencestring

Payout reference.

amountinteger

Payout amount.

statusstring

Payout status (e.g., 'pending', 'scheduled', 'sent', 'failed').

customer_idinteger

Customer ID associated with the payout.

currency_idinteger

Currency ID associated with the payout.

modestring

Payout mode.

last_error_codestring

Last error code encountered during the payout.

commissioninteger

Payout commission.

feesinteger

Payout fees.

fixed_commissioninteger

Fixed commission applied to the payout.

amount_transferredinteger

Amount transferred to the beneficiary.

amount_debitedinteger

Amount debited from the payer.

created_atstring date-time

Date and time of payout creation.

updated_atstring date-time

Date and time of last payout update.

scheduled_atstring date-time

Date and time the payout is scheduled.

sent_atstring date-time

Date and time the payout was sent.

failed_atstring date-time

Date and time the payout failed.

deleted_atstring date-time

Date and time of payout deletion.

metadataobject

Additional metadata.

custom_metadataobject

Custom metadata.

payment_method_idinteger

Payment method ID.

transaction_keystring

Unique transaction key.

merchant_referencestring

Merchant reference.

account_idinteger

Account ID.

balance_idinteger

Balance ID.