Skip to main content
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.
This endpoint creates a staged request with status pending; it does not create the final wallet withdrawal. The marketplace operator must call Approve Merchant Payout, after which Khaime admin performs the final settlement approval.

Path Parameters

string
required
The ID of the sub-merchant whose wallet should be paid out.

Request Body

number
required
Amount to withdraw in the smallest currency unit. For example, 50000 means ₦500.00 for NGN or $500.00 for USD.
string
required
Wallet currency to withdraw, such as NGN, USD, or GBP.
string
Optional internal description for the payout request.

Response

Response Fields

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