Get Payout Summary
POST
/payout/summary
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
Header Params
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.bokumonie.com/v2/payout/summary' \
--header 'Accept: application/json' \
--header 'Idempotency-Key: {{$randomUUID}}' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'Response Response Example
{
"status": "Successful",
"message": "Payout summary retrieved",
"data": {
"total_transfers": 38,
"successful": 2,
"pending": 36,
"failed": 0,
"total_sent": 7281.78,
"wallet_transfers": 5,
"bank_transfers": 33
},
"timestamp": "2026-04-03T15:00:29.135216Z"
}Modified at 2026-04-05 02:10:05