AirtimeTransaction

Get airtime transaction by ID

Gets an airtime transaction by ID

get/v1/projects/{project_id}/airtime_transactions/{id}

Request

Base URL: https://api.telerivet.com
URL: https://api.telerivet.com/v1/projects/{project_id}/airtime_transactions/{id}
Auth: one of:
- HTTP basic
- OAuth 2 (authorization code, authorization URL https://telerivet.com/oauth/authorize, token URL https://api.telerivet.com/oauth/token)

Path parameters

project_idstring required

ID of the Project

idstring required

ID of the airtime transaction

Response

Successful response

idstring

ID of the airtime transaction

to_numberstring

Destination phone number in international format (no leading +)

operator_namestring

Operator name

countrystring

Country code

time_createdinteger

The time that the airtime transaction was created on Telerivet's servers

transaction_timeinteger

The time that the airtime transaction was sent, or null if it has not been sent

Current status of airtime transaction (successful, failed, cancelled, queued, processing, submitted, pending_approval, or pending_payment)

status_textstring

Error or success message returned by airtime provider, if available

valuestring

Value of airtime sent to destination phone number, in units of value_currency

value_currencystring

Currency code of price

pricestring

Price charged for airtime transaction, in units of price_currency

price_currencystring

Currency code of price

contact_idstring

ID of the contact the airtime was sent to

service_idstring

ID of the service that sent the airtime

project_idstring

ID of the project that the airtime transaction belongs to

external_idstring

The ID of this transaction from an external airtime gateway provider, if available.

user_idstring

ID of the Telerivet user who sent the airtime transaction (if applicable)

varsobject

Custom variables stored for this transaction. Variable names may be up to 32 characters in length and can contain the characters a-z, A-Z, 0-9, and _. Values may be strings, numbers, or boolean (true/false). String values may be up to 4096 bytes in length when encoded as UTF-8. Up to 100 variables are supported per object. Setting a variable to null will delete the variable.

Example response

{
  "id": "ATb11111211217d11f",
  "to_number": "639123123123",
  "operator_name": "Globe Philippines",
  "country": "PH",
  "time_created": 1390347812,
  "transaction_time": 1390347813,
  "status": "successful",
  "status_text": "Transaction successful",
  "value_currency": "PHP",
  "price_currency": "USD",
  "contact_id": "CTa01111211217d24e",
  "service_id": "SVb12345211217d35f",
  "project_id": "PJ012345211217c11a",
  "external_id": "GLYV2R8GHY8LS17Y0S0G",
  "user_id": "URba3e403e98f49735"
}

Changes

No recorded changes to this operation across all 1 revision of this API.