POST
/
payouts

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
amount
integer
required

Amount of the payout.

currency
object
required

Currency information.

customer
object
required

Customer information.

mode
string
required

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

Response

201 - application/json
id
integer

Payout ID.

reference
string

Payout reference.

amount
integer

Payout amount.

status
string

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

customer_id
integer

Customer ID associated with the payout.

currency_id
integer

Currency ID associated with the payout.

mode
string

Payout mode.

last_error_code
string

Last error code encountered during the payout.

commission
integer

Payout commission.

fees
integer

Payout fees.

fixed_commission
integer

Fixed commission applied to the payout.

amount_transferred
integer

Amount transferred to the beneficiary.

amount_debited
integer

Amount debited from the payer.

created_at
string

Date and time of payout creation.

updated_at
string

Date and time of last payout update.

scheduled_at
string

Date and time the payout is scheduled.

sent_at
string

Date and time the payout was sent.

failed_at
string

Date and time the payout failed.

deleted_at
string

Date and time of payout deletion.

metadata
object

Additional metadata.

custom_metadata
object

Custom metadata.

payment_method_id
integer

Payment method ID.

transaction_key
string

Unique transaction key.

merchant_reference
string

Merchant reference.

account_id
integer

Account ID.

balance_id
integer

Balance ID.

Get a payoutUpdate a payout.