Sign in

v1

latestOpenAPI 3.0.02026-07-2623060.7 KB

Send payment to user

post/transactions/{mode}

Path parameters

modestring required

Transaction mode.

Request body

tokeninteger required

Transaction token

Example request

{
  "token": 1,
  "phone_number": {
    "number": "+22997808080",
    "country": "BJ"
  }
}

Response

Transaction sent successfully.

referencestring

Payment intent reference.

amountinteger

Payout amount.

statusstring

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

currency_idinteger

Currency ID associated with the payout.

modestring

Payout mode.

last_error_codestring

Last error code encountered during the payout.

created_atstring date-time

Date and time of payout creation.

updated_atstring date-time

Date and time of last payout update.

approved_atstring date-time

Date and time the payout was sent.

canceled_atstring date-time

Date and time the payout failed.

deleted_atstring date-time

Date and time of payout deletion.

payment_method_idinteger

Payment method ID used for the payout.

transaction_keystring

Unique key associated with the payout.

account_idinteger

Account ID associated with the payout.

Example response

[
  {
    "reference": "pi_xdc_123456",
    "amount": 1000,
    "status": "pending",
    "currency_id": 840,
    "mode": "automatic",
    "last_error_code": "NO_ERROR",
    "created_at": "2024-10-23T14:00:00Z",
    "updated_at": "2024-10-23T14:00:00Z",
    "approved_at": "2024-10-23T14:31:00Z",
    "canceled_at": "2024-10-23T14:32:00Z",
    "deleted_at": "2024-10-23T14:33:00Z",
    "payment_method_id": 1,
    "transaction_key": "TRANSACTION-XYZ",
    "account_id": 5
  }
]