Get a Payout
GET
/payout/{transactionId}
Uses Bearer token authentication. The token is sourced from the
Api-Key environment variable.An
Idempotency-Key header is automatically generated as a random UUID on each request. This ensures that retrying a failed request does not result in duplicate payouts.| Field | Type | Description |
|---|---|---|
amount | number | The payout amount to be transferred. |
currency | string | The currency code for the payout (e.g., SLE). |
payoutId | string | A unique identifier for this payout transaction (auto-generated UUID). |
walletId | string | The ID of the source wallet from which funds will be debited. |
recipient.type | string | The recipient channel — either bank or wallet. |
recipient.accountDetails.name | string | Full name of the recipient. |
recipient.accountDetails.provider | string | The recipient's bank or wallet provider (e.g., ecobank). |
recipient.accountDetails.accountNumber | string | The recipient's account number. |
recipient.accountDetails.phoneNumber | string | The recipient's phone number (required for wallet transfers). |
recipient.accountDetails.note | string | An optional note or payment reference. |
metadata | object | Optional key-value pairs for additional context or internal tracking. |
Request
Path Params
Header Params
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.bokumonie.com/v2/payout/TXN-BOK-FF051A7F00A49EB6AF225D10EA' \
--header 'Accept: application/json' \
--header 'Idempotency-Key: {{$randomUUID}}' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'Response Response Example
{
"status": "Successful",
"message": "Transfer status retrieved",
"data": {
"transaction_id": "TXN-BOK-FF051A7F00A49EB6AF225D10EA",
"status": "successful",
"amount": "1,000.00",
"currency": "SLE",
"fee": "5.00",
"total_amount": "1,005.00",
"recipient": {
"transfer_type": "bank",
"account_number": "0127500182",
"name": "John Doe",
"bank": "ECOBANK"
},
"description": "Payment for services",
"created_at": "2026-04-02T15:30:04.000000Z",
"updated_at": "2026-04-02T15:30:04.000000Z",
"provider_reference": "ORD-79A7C916A37B46BA"
},
"timestamp": "2026-04-03T13:53:51.064163Z"
}Modified at 2026-04-05 02:10:05