Marketplace
Initiate Merchant Payout
Request a payout from a sub-merchant’s wallet balance.
POST
Initiate Merchant Payout
Request a payout from a sub-merchant’s available balance. This endpoint must be called using the sub-merchant’s own Partner API key after KYC and payout setup are complete.This payout is created from the sub-merchant’s Khaime wallet balance. For Stripe direct-charge marketplace payments, funds may already be held in the sub-merchant’s Stripe connected account instead of their Khaime wallet.
Path Parameters
The ID of the sub-merchant whose wallet should be paid out.
Request Body
Amount to withdraw in the smallest currency unit. For example,
50000 means ₦500.00 for NGN or $500.00 for USD.Wallet currency to withdraw, such as
NGN, USD, or GBP.Optional internal description for the payout request.
Response
Response Fields
| Field | Type | Description |
|---|---|---|
merchant_id | number | Sub-merchant business ID |
payout_request_id | number | Staged marketplace payout request ID |
amount | number | Requested payout amount in the smallest currency unit |
currency | string | Currency being withdrawn |
status | string | Request status, pending at creation |
remaining_balance | number | Available balance after reserving this request |
payment_gateway | string | Gateway selected for settlement |
reference | string | Unique payout reference |
payout_method | string | transfer for wallet settlement or payout for Stripe direct-charge funds |
bank_details | object | Destination bank details when the gateway uses a bank transfer |
requested_at | string | ISO timestamp when the request was created |
Requirements
- Your API key must belong to the sub-merchant identified by
merchantId. - The sub-merchant must have an active marketplace relationship.
- The sub-merchant must have completed KYC and payout setup.
- The sub-merchant must have enough available wallet balance in the requested currency.
- Only one pending request is allowed per merchant, currency, and environment.
- The requested amount is reserved while marketplace approval is pending.
Error Codes
| Status | Error | Fix |
|---|---|---|
400 | Insufficient wallet balance | Request a lower amount or wait for more funds to settle |
409 | Sub-merchant already has a payout awaiting marketplace approval | Approve or reject the existing request first |
400 | Please store bank account details first before requesting payouts | Complete payout setup for the merchant |
403 | A sub-merchant can only request a payout for its own business | Use the sub-merchant’s own Partner API key |
404 | Active merchant relationship not found | Confirm the merchant is linked and active |
