Sign in

v1

latestOpenAPI 3.0.22026-07-242673105.9 KB
Transactions

Cancel a transaction

If a transaction is still in the CREATED state, it has not yet been submitted to the receiving operator for processing. You can thus request to cancel such transactions by calling this endpoint.

post/transactions/{transaction_id}/cancel

Path parameters

transaction_idinteger required

Unique transaction identifier.

Response

Transaction cancelled

idinteger

Unique transaction identifier.

external_idstring required

Unique identifier for the transaction in your system.

creation_datestring date-time
confirmation_expiration_datestring date-time
confirmation_datestring date-time
product_idinteger required

Product identifier.

calculation_mode'SOURCE_AMOUNT' | 'DESTINATION_AMOUNT' nullable

Required when product type is either RANGED_VALUE_RECHARGE, RANGED_VALUE_PIN_PURCHASE, or RANGED_VALUE_PAYMENT

auto_confirmboolean

Determines whether a transaction will be automatically confirmed upon creation or not. This is opted-out by default. Setting this field to true is recommended when transaction details, e.g. prices, are known as it removes the need to perform a separate API call to confirm transactions.

operator_referencestring nullable

Example response

{
  "metadata": {
    "balance": {
      "validity": {
        "quantity": 365
      },
      "extended_data_policy": {
        "interval": "24h",
        "fixed_time": "00:00",
        "throttle_speed": "128 KB/s"
      }
    }
  }
}