Get the status of a top-up

With the /{{transactionId}}/status endpoint, the status of a top-up can be determined in real-time

Top-up status

GET https://topups.reloadly.com/topups/{{transactionId}}/status

Path Parameters

Name

Type

Description

transactionId*

integer

Indicates the transaction ID retrieved from an asynchronous top-up request

Headers

Name

Type

Description

Authorization*

string

Your access token is required as a bearer token in the request's header

{
    "transactionId": 26523,
    "status": "SUCCESSFUL",
    "operatorTransactionId": null,
    "customIdentifier": "This is example identifier",
    "recipientPhone": "447951631337",
    "recipientEmail": null,
    "senderPhone": "11231231231",
    "countryCode": "GB",
    "operatorId": 535,
    "operatorName": "EE PIN England",
    "discount": 63.37,
    "discountCurrencyCode": "NGN",
    "requestedAmount": 3168.4,
    "requestedAmountCurrencyCode": "NGN",
    "deliveredAmount": 5,
    "deliveredAmountCurrencyCode": "GBP",
    "transactionDate": "2022-01-26 03:19:16",
    "pinDetail": {
        "serial": "558111",
        "info1": "DIAL *611",
        "info2": "DIAL *611",
        "info3": "Dial *233* and PIN #",
        "value": null,
        "code": "773709733097662",
        "ivr": "1-888-888-8888",
        "validity": "30 days"
    },
    "balanceInfo": {
        "oldBalance": 60387.41,
        "newBalance": 57282.38,
        "cost": 3105.03,
        "currencyCode": "NGN",
        "currencyName": "Nigerian Naira",
        "updatedAt": "2022-01-26 08:19:16"
    }
}

{
  "code": "SERVICE_TO_OPERATOR_TEMPORARILY_UNAVAILABLE",
  "message": "The transaction failed due to an outage and / or connection issue with the operator",
  "status": "REFUNDED",
  "transaction": null
}

{
  "timeStamp":"2021-06-08 12:00:54",
  "message":"Full authentication is required to access this resource",
  "path":"/topups/2/status",
  "errorCode":"INVALID_TOKEN",
  "infoLink":null,
  "details":[
    
  ]
}

{
  "timeStamp":"2021-06-08 16:03:24",
  "message":"Transaction not found for given id",
  "path":"/topups/238746/status",
  "errorCode":"TRANSACTION_NOT_FOUND",
  "in4foLink":null,
  "details":[
    
  ]
}

Request samples

curl --location -g --request GET 'https://topups.reloadly.com/topups/{{transactionId}}/status' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN_HERE' \
--header 'Accept: application/com.reloadly.topups-v1+json'

using System;
using System.Threading.Tasks;
using System.Net.Http;
using System.Text;
using Newtonsoft.Json;

namespace WebAPIClient {
  class Program {

    static async Task Main(string[] args) {
      await ApiCall();
    }

    private static async Task ApiCall() {

      var message = new HttpRequestMessage(HttpMethod.Get, "https://topups.reloadly.com/topups/{{transactionId}}/status");

      message.Headers.TryAddWithoutValidation("Authorization", "Bearer YOUR_ACCESS_TOKEN_HERE");
      message.Headers.TryAddWithoutValidation("Accept", "application/com.reloadly.topups-v1+json");

      using
      var httpClient = new HttpClient();
      var response = await httpClient.SendAsync(message);
      var responseBody = await response.Content.ReadAsStringAsync();
      var result = JsonConvert.DeserializeObject < dynamic > (responseBody);

      Console.WriteLine(result);
    }

  }
}

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://topups.reloadly.com/topups/{{transactionId}}/status"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN_HERE")
  req.Header.Add("Accept", "application/com.reloadly.topups-v1+json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://topups.reloadly.com/topups/{{transactionId}}/status")
  .method("GET", null)
  .addHeader("Authorization", "Bearer YOUR_ACCESS_TOKEN_HERE")
  .addHeader("Accept", "application/com.reloadly.topups-v1+json")
  .build();
Response response = client.newCall(request).execute();

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://topups.reloadly.com/topups/{{transactionId}}/status',
  'headers': {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN_HERE',
    'Accept': 'application/com.reloadly.topups-v1+json'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://topups.reloadly.com/topups/%7B%7BtransactionId%7D%7D/status',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer YOUR_ACCESS_TOKEN_HERE',
    'Accept: application/com.reloadly.topups-v1+json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import requests
import json

url = "https://topups.reloadly.com/topups/{{transactionId}}/status"

payload={}
headers = {
  'Authorization': 'Bearer YOUR_ACCESS_TOKEN_HERE',
  'Accept': 'application/com.reloadly.topups-v1+json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Response parameters

Parameter

Type

Description

transactionId

integer

Indicates the unique ID of a top-up

status

string

Indicates the status of a top-up.

Note:

SUCCESSFUL: This applies when the top up is successfully made.

PROCESSING: This applies while the top up is still being verified from the operator's end.

REFUNDED: This applies once the top up is not processed successfully from the airtime operator's end. In this instance, any funds debited from a user's wallet while attempting to make the top-up are automatically refunded. FAILED: This applies when the top-up attempt fails due to an internal error from the operator's end. In this instance, you should wait 30 minutes before reinitiating the top-up. Funds are not debited for a failed top-up attempt.

operator

TransactionId

string

Indicates the transaction ID assigned by the operator of the receiving mobile number

customIdentifier

string

This is the top-up's reference that is to be assigned by the sender

recipientPhone

string

This indicates the top-up receiver's mobile number

recipientEmail

string

This indicates the top-up receiver's email (only applicable to Nauta Cuba top-ups)

senderPhone

string

This indicates the sender's mobile number

countryCode

string

Indicates the ISO code of the country where the operator is registered.

operatorId

integer

The ID of the receiving mobile number's operator

operatorName

string

The name of the receiving mobile number's operator

discount

integer

Indicates if there was a discount on the top-up made and at what rate

discountCurrency

Code

string

Indicates the currency code of the receiving mobile number

requestedAmount

integer

Indicates the top-up amount sent by the originating account

requestedAmount

CurrencyCode

string

Indicates the currency code of the originating account

deliveredAmount

integer

Indicates the top-up amount received by the receiving mobile number

deliveredAmount

CurrencyCode

string

Indicates the currency in which the top-up was delivered

transactionDate

string

Indicates the date and time the top-up was made

pinDetail

object

This contains information on how to process the PIN on the physical SIM. Note that this is only for operators that support PIN Top-up

serial

string

Indicates the serial code of the PIN top-up

info

string

Indicates information on how to utilize the top-up

value

string

Indicates additional information on the PIN

code

string

Indicates the code that is to be used to activate the top-up

ivr

string

Indicates the number to call for an interactive voice response

validity

string

Indicates the validity of the PIN

balanceInfo

object

Contains information of the top-up sender's account balance

oldBalance

integer

Indicates the balance of the sender's account before the top-up was made

newBalance

integer

Indicates the balance of the sender's account after the top-up was made

cost

integer

Indicates the amount deducted from your account for the top-up.

currencyCode

string

Indicates the currency code of the sender's account

currencyName

string

Indcates the currency denomination of the sender's account

updatedAt

string

Indicates the time the account's balance was updated to reflect the last top-up made

PreviousMake an asynchronous top-up NextGet all transactions

Last updated 3 years ago

hashtagTop-up status

hashtagPath Parameters

hashtagHeaders

hashtag

hashtagRequest samples

hashtagResponse parameters

Top-up status

Path Parameters

Headers

Request samples

Response parameters