Skip to content

Cancel Payment

API for refunding a payment using a transaction ID

Cancel Payment API

💡 Note: Please be careful when using this API

Endpoint details

Method: POST
URL: BASE_URL/merchant/payment/cancel/
Header:

http
Authorization: Bearer <ACCESS_TOKEN>

Request body

FieldTypeRequiredDescription
transactionIdstringYesUnique identifier for the transaction

Request example

json
{
  "transactionId": "9b3bd7be-9327-4608-b886-4353e49df05f" // example this transactionId
}

Response

On Success, you'll receive:

json
{
  "error": null,
  "result": {
    "status": "cancelled", 
    "cancelTime": "2025-12-31 11:24:03", 
    "transactionId": "9b3bd7be-9327-4608-b886-4353e49df05f"
  }
}

Error Response

json
{
  "error": {
    "code": "transaction_not_available_for_cancel", 
    "message": "transaction_not_available_for_cancel"
  }, 
  "result": null
}

Error codes

  • permission_denied
  • transaction_not_found
  • transaction_not_available_for_cancel