Passer au contenu principal
PUT
Start payout

Autorisations

Authorization
string
header
requis

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

Corps

application/json
id
integer
requis

Payout ID

Exemple:

1

scheduled_at
string<date-time>

Date and time the payout is scheduled to be sent.

Exemple:

"2024-10-23T14:30:00Z"

phone_number
object

Phone number details

Réponse

Payouts started successfully.

id
integer

Payout ID.

Exemple:

1

reference
string

Payout reference.

Exemple:

"PAYOUT-123456"

amount
integer

Payout amount.

Exemple:

1000

status
string

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

Exemple:

"sent"

customer_id
integer

Customer ID associated with the payout.

Exemple:

42

currency_id
integer

Currency ID associated with the payout.

Exemple:

840

mode
string

Payout mode.

Exemple:

"automatic"

last_error_code
string

Last error code encountered during the payout.

Exemple:

"NO_ERROR"

commission
integer

Payout commission.

Exemple:

50

fees
integer

Payout fees.

Exemple:

5

fixed_commission
integer

Fixed commission applied to the payout.

Exemple:

10

amount_transferred
integer

Amount transferred to the beneficiary.

Exemple:

935

amount_debited
integer

Amount debited from the payer.

Exemple:

1000

created_at
string<date-time>

Date and time of payout creation.

Exemple:

"2024-10-23T14:00:00Z"

updated_at
string<date-time>

Date and time of last payout update.

Exemple:

"2024-10-23T14:00:00Z"

scheduled_at
string<date-time>

Date and time the payout is scheduled to be sent.

Exemple:

"2024-10-23T14:30:00Z"

sent_at
string<date-time>

Date and time the payout was sent.

Exemple:

"2024-10-23T14:31:00Z"

failed_at
string<date-time>

Date and time the payout failed.

Exemple:

"2024-10-23T14:32:00Z"

deleted_at
string<date-time>

Date and time of payout deletion.

Exemple:

"2024-10-23T14:33:00Z"

metadata
object

Additional metadata related to the payout.

custom_metadata
object

Custom metadata associated with the payout.

payment_method_id
integer

Payment method ID used for the payout.

Exemple:

1

transaction_key
string

Unique key associated with the payout.

Exemple:

"TRANSACTION-XYZ"

merchant_reference
string

Merchant reference provided for the payout.

Exemple:

"MERCHANT-456"

account_id
integer

Account ID associated with the payout.

Exemple:

5

balance_id
integer

Balance ID associated with the payout.

Exemple:

10