Cancel Transactions

  • Updated on Mar 5, 2025
  • Published on Mar 5, 2025
  • 1 minute(s) read
Post
/api/pay/v1/transactions/{transaction_id}/cancels

Parameters

  • transaction_id (string, required): Transaction ID returned as resvalue in return url after the Payment request.

Response Body

  • success (boolean): Indicates whether the cancellation was successful.
  • message (string): Provides a message related to the cancellation status.
  • amount (string): Represents the amount associated with the cancelled transaction.
  • reference (string): Contains a note or reference related to the cancellation.
  • transaction_id (string): Identifies the cancelled transaction with a unique ID.
Security
HTTP
Type bearer
Header parameters
Authorization
string
ExampleBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudF9pZCI6NDM5OCwic2VjcmV0X2tleSI6IjYzMTBlNDhiZGQwZTQzODE0NTlhNjJiNDZkMmM0ZmQ2ZThhYjY1YTJhNGQ1MjA1YzZjM2RkZWJmYmJhZWJiZjgiLCJleHAiOjE3MjA3MDcyNjZ9.91qa4veQ9xGVM-Jc_3_i_vaykEdYarRwUzb-37aLD0c
Path parameters
transaction_id
stringRequired
Responses
200

Successful response