Get payouts

Initiates a payout from a specified source wallet to a recipient's bank account or mobile wallet.

Authentication
Uses Bearer token authentication. The token is sourced from the Api-Key environment variable.

Idempotency
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.

Request Body

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.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location --request GET 'https://api.bokumonie.com/v2/payout/list' \ --header 'Accept: application/json' \ --header 'Idempotency-Key: {{$randomUUID}}' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{}'

{ "status": "Successful", "message": "Transfers retrieved", "data": { "data": [ { "transaction_id": "TXN-BOK-83BD4FB5EF52C8CB2329510901", "status": "Pending", "amount": "500.00", "fee": "5.00", "currency": "SLE", "transfer_type": "wallet", "provider": "ORANGE_MONEY", "recipient": "23270343533", "description": "Payment for services", "created_at": "2026-04-03T11:57:38.000000Z" }, { "transaction_id": "TXN-BOK-0F8B9BD6567F8D178035A1DD82", "status": "Pending", "amount": "10.00", "fee": "0.05", "currency": "SLE", "transfer_type": "bank", "provider": "ECOBANK", "recipient": "0427570182", "description": "Payment for services", "created_at": "2026-04-03T11:57:01.000000Z" }, { "transaction_id": "TXN-BOK-EFF769AB0CD6CDE842C5389119", "status": "Pending", "amount": "10.00", "fee": "0.05", "currency": "SLE", "transfer_type": "bank", "provider": "ECOBANK", "recipient": "0127500182", "description": "Payment for services", "created_at": "2026-04-03T11:56:36.000000Z" }, { "transaction_id": "TXN-BOK-4A17DE7F5529140FB8BB9FE5B0", "status": "Pending", "amount": "10.00", "fee": "0.05", "currency": "SLE", "transfer_type": "bank", "provider": "ECOBANK", "recipient": "0127500182", "description": "Payment for services", "created_at": "2026-04-03T11:55:40.000000Z" }, { "transaction_id": "TXN-BOK-7833E1D54A5041FE006763B445", "status": "Pending", "amount": "210.00", "fee": "1.05", "currency": "SLE", "transfer_type": "bank", "provider": "ECOBANK", "recipient": "0127500182", "description": "Payment for services", "created_at": "2026-04-03T11:54:55.000000Z" }, { "transaction_id": "TXN-BOK-C83B83F518C4AA9E7A073595B1", "status": "Pending", "amount": "210.00", "fee": "1.05", "currency": "SLE", "transfer_type": "bank", "provider": "ECOBANK", "recipient": "0127500182", "description": "Payment for services", "created_at": "2026-04-03T11:54:20.000000Z" }, { "transaction_id": "TXN-BOK-C422F95784E5A343B29C990953", "status": "Pending", "amount": "210.00", "fee": "1.05", "currency": "SLE", "transfer_type": "bank", "provider": "ECOBANK", "recipient": "0127500182", "description": "Payment for services", "created_at": "2026-04-03T11:50:54.000000Z" }, { "transaction_id": "TXN-BOK-522D2D6E08BF445E85995076AA", "status": "Pending", "amount": "10.00", "fee": "0.05", "currency": "SLE", "transfer_type": "bank", "provider": "ECOBANK", "recipient": "0127500182", "description": "Payment for services", "created_at": "2026-04-03T11:50:23.000000Z" }, { "transaction_id": "TXN-BOK-5B6AC676B67AA3475B8ECEAB82", "status": "Pending", "amount": "10.00", "fee": "0.05", "currency": "SLE", "transfer_type": "bank", "provider": "ECOBANK", "recipient": "0127500182", "description": "Payment for services", "created_at": "2026-04-03T11:49:50.000000Z" }, { "transaction_id": "TXN-BOK-C46ED1A54C853EC741FA9EA1F4", "status": "Pending", "amount": "10.00", "fee": "0.05", "currency": "SLE", "transfer_type": "bank", "provider": "ECOBANK", "recipient": "0127500182", "description": "Payment for services", "created_at": "2026-04-03T11:49:38.000000Z" }, { "transaction_id": "TXN-BOK-3A7FBD4C4389A5AFB67ABB3027", "status": "Pending", "amount": "10.00", "fee": "0.05", "currency": "SLE", "transfer_type": "bank", "provider": "ECOBANK", "recipient": "0127500182", "description": "Payment for services", "created_at": "2026-04-03T11:49:21.000000Z" }, { "transaction_id": "TXN-BOK-1122B8F69BFC32774CB6FF52A1", "status": "Pending", "amount": "10.00", "fee": "0.05", "currency": "SLE", "transfer_type": "bank", "provider": "ECOBANK", "recipient": "0127500182", "description": "Payment for services", "created_at": "2026-04-03T11:48:48.000000Z" }, { "transaction_id": "TXN-BOK-4AA8E6CA8AB4D92E9B60C246DD", "status": "Pending", "amount": "10.00", "fee": "0.05", "currency": "SLE", "transfer_type": "bank", "provider": "ECOBANK", "recipient": "0127500182", "description": "Payment for services", "created_at": "2026-04-03T11:47:14.000000Z" }, { "transaction_id": "TXN-BOK-FF750AE4EEE7505D903E27F3C5", "status": "Pending", "amount": "10.00", "fee": "0.05", "currency": "SLE", "transfer_type": "bank", "provider": "ECOBANK", "recipient": "0127500182", "description": "Payment for services", "created_at": "2026-04-03T11:46:42.000000Z" }, { "transaction_id": "TXN-BOK-A75C53620F69E2E2BF55A346F5", "status": "Pending", "amount": "10.00", "fee": "0.05", "currency": "SLE", "transfer_type": "bank", "provider": "ECOBANK", "recipient": "0127500182", "description": "Payment for services", "created_at": "2026-04-03T09:45:41.000000Z" } ], "meta": { "current_page": 1, "last_page": 3, "per_page": 15, "total": 36 } }, "timestamp": "2026-04-03T12:15:29.127981Z" }

Request

Responses