Sign in

v1

latestOpenAPI 3.0.02026-07-2623060.7 KB

Start payout

put/payouts/start

Request body

idinteger required

Payout ID

scheduled_atstring date-time

Date and time the payout is scheduled to be sent.

Example request

[
  {
    "id": 1,
    "scheduled_at": "2024-10-23T14:30:00Z",
    "phone_number": {
      "number": "+22997808080",
      "country": "BJ"
    }
  }
]

Response

Payouts started 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 to be sent.

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 related to the payout.

custom_metadataobject

Custom metadata associated with the payout.

payment_method_idinteger

Payment method ID used for the payout.

transaction_keystring

Unique key associated with the payout.

merchant_referencestring

Merchant reference provided for the payout.

account_idinteger

Account ID associated with the payout.

balance_idinteger

Balance ID associated with the payout.

Example response

[
  {
    "id": 1,
    "reference": "PAYOUT-123456",
    "amount": 1000,
    "status": "sent",
    "customer_id": 42,
    "currency_id": 840,
    "mode": "automatic",
    "last_error_code": "NO_ERROR",
    "commission": 50,
    "fees": 5,
    "fixed_commission": 10,
    "amount_transferred": 935,
    "amount_debited": 1000,
    "created_at": "2024-10-23T14:00:00Z",
    "updated_at": "2024-10-23T14:00:00Z",
    "scheduled_at": "2024-10-23T14:30:00Z",
    "sent_at": "2024-10-23T14:31:00Z",
    "failed_at": "2024-10-23T14:32:00Z",
    "deleted_at": "2024-10-23T14:33:00Z",
    "payment_method_id": 1,
    "transaction_key": "TRANSACTION-XYZ",
    "merchant_reference": "MERCHANT-456",
    "account_id": 5,
    "balance_id": 10
  }
]