Cancel Transactions

Post
/api/pay/v1/transactions/BL-2MUXYN2QLP/cancels

This endpoint cancels an existing transaction which has been authorised but not yet settled (only applicable for card transactions).

Parameters

transaction_id (string, required): Transaction ID returned as res value 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
Responses
200

Successful response