Cancel transaction

User can cancel any existing transaction before being settled. It can only be performed on transactions, which have been authorised but not yet settled. Authenticate this request using HTTP Basic Auth by adding a bearer token to the header, e.g. Authentication: Bearer {{access_token}}. You can get the {{access_token}} from the create token request.

If the previous transaction is in Captured state, then that transaction can be cancelled.

Path Parameters

• transaction_id string required

  The transaction ID

application/json

Request Body

• reference string

  Cancellation note (if any).

Responses

• 200

---

Response Headers

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• success boolean
• message string
• amount string
• reference string
• transaction_id string

{
  "success": true,
  "message": "string",
  "amount": "string",
  "reference": "string",
  "transaction_id": "string"
}

{
  "success": true,
  "message": "Cancelled successfully",
  "amount": "1.01",
  "reference": "cancel note",
  "transaction_id": "BL-2349AGB"
}

Loading...