Sign in

v1

latestOpenAPI 3.0.22026-07-242673105.9 KB
Transactions

Create a transaction synchronously

Two transaction modes (asynchronous and synchronous) are available. This endpoint lets you create a transaction in the synchronous mode. Note that the auto_confirm flag can be set to simultaneously create and confirm a transaction in one step (i.e. HTTP request).

post/sync/transactions

Request body

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 request

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

Response

Transaction created

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"
      }
    }
  }
}