Buvei
API ReferencePayouts

Cancel Payout

Cancel an unclaimed payout after the 24-hour window.

POST/open-api/v1/payouts/{merOrderNo}/cancel

Cancels a payout that is still unclaimed by the payee. On success the order moves to CANCELED and the full debit is refunded to your wallet.

Eligibility

A payout is cancellable only when both are true:

  • Status is non-terminal (not yet SUCCESS / FAILED / CANCELED).
  • The order was created at least 24 hours ago (upstream constraint — calls earlier are rejected).

The canCancel field on Get Payout Details reflects this.

Path parameters

merOrderNostringpathrequired

Response

Success / failure only. code = 0 means the cancel landed; data is not returned. Query Get Payout Details if you need the final order state.

Response
{
  "code": 0,
  "message": "SUCCESS"
}
{
  "code": 403,
  "message": "Orders can be cancelled 24 hours after creation"
}

If the payee has already claimed the funds upstream, the cancel call is rejected. In that case the order will eventually reach SUCCESS.