Sign in

v1

latestOpenAPI 3.0.22026-07-242673105.9 KB
Transactions

Query list of transactions

This endpoint will return a list of transactions matching the search criteria. Please note that when this endpoint is called without any parameters and/or if neither date ranges (i.e. from_date, to_date) nor external_id are specified, transactions created within the last 24 hours will be returned by default.

get/transactions

Query parameters

external_idstring

Unique identifier for the transaction in your system.

product_type'FIXED_VALUE_RECHARGE' | 'RANGED_VALUE_RECHARGE' | 'FIXED_VALUE_PIN_PURCHASE' | 'RANGED_VALUE_PIN_PURCHASE' | 'RANGED_VALUE_PAYMENT'
service_idinteger

Service identifier. See Services for more details.

subservice_idinteger

Sub-service identifier. See Services for more details.

country_iso_codestring

Country code in ISO 3166 format. Note that the official list can be extended with additional country codes.

operator_idinteger

Operator identifier.

status_idinteger
credit_party_mobile_numberstring

Mobile number in E.164 format.

credit_party_account_numberstring

Account number.

from_datestring date-time

Starting date to filter transactions based on creation date, inclusive of the provided date. Please note that the window between from_date and to_date can not exceed 24 hours.

to_datestring date-time

Ending date to filter transactions based on creation date, inclusive of the provided date. Please note that the window between from_date and to_date can not exceed 24 hours.

pageinteger

Page number.

per_pageinteger

Number of records per page.

Response

successful operation

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
callback_urlstring uri

Transaction status updates will be sent to this endpoint. See Callbacks for more details.

Example response

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