Skip to main content
POST

Approve Merchant Payout

Approve a staged request created by a sub-merchant with Initiate Merchant Payout. Approval creates the final wallet withdrawal for Khaime admin review. This dashboard endpoint uses x-id-key authentication, not a Partner API key.
This endpoint does not accept a request body. The marketplace operator cannot change the amount, currency, payout method, or payment gateway during approval. It does not contact the payment gateway.
Approval changes the request from pending to approved and creates a payout_pending wallet transaction. Khaime admin must approve that withdrawal before gateway processing begins.

Path Parameters

merchantId
number
required
The business ID of the sub-merchant whose payout should be approved.
reference
string
required
The payout reference returned by the initiate payout endpoint.

Response

Use the returned reference with Khaime’s existing admin withdrawal settlement flow. Until then, the wallet transaction remains payout_pending.

Response Fields

Requirements

  • The API key must belong to the marketplace operator associated with the requesting merchant.
  • The merchantId must have an active relationship with the marketplace.
  • The payout must have been created through the marketplace Partner API.
  • The API key environment must match the payout environment.
  • The staged request must currently have status pending.

Error Codes