Get all transactions

Using the /topups/reports/transactions endpoint, developers can get information on every top-up transaction made on a Reloadly account

Transactions

GET https://topups.reloadly.com/topups/reports/transactions

Query Parameters

Name	Type	Description
page	integer	The page of the operator list being retrieved. Default is 1
size	integer	The number of transactions to be retrieved on a page. Default is 100
countryCode	string	Indicates the ISO code of the country where the operator is registered
customIdentifier	string	The unique reference assigned to the transaction
startDate	string	Indicates the beginning of the timeframe range for the transactions to be searched for. Format is YYYY-MM-DD HH:mm:ss
endDate	string	Indicates the end of the timeframe range for the transactions to be searched for Format is YYYY-MM-DD HH:mm:ss
operatorId	string	Indicates the ID of the operator whose transaction history is being searched for
operatorName	string	Indicates the name of the operator whose transaction history is being searched for

Headers

Name	Type	Description
Authorization*	string	Your access token is required as a bearer token in the request's header

200 This response is gotten when a successful request is made and a list containing transaction details is retrieved

JSON

{
  "content": [
    {
      "transactionId": 27623,
      "status": "SUCCESSFUL",
      "operatorTransactionId": null,
      "customIdentifier": null,
      "recipientPhone": "2348147658720",
      "recipientEmail": null,
      "senderPhone": "2341231231231",
      "countryCode": "NG",
      "operatorId": 341,
      "operatorName": "MTN Nigeria",
      "discount": 0,
      "discountCurrencyCode": "NGN",
      "requestedAmount": 100,
      "requestedAmountCurrencyCode": "NGN",
      "deliveredAmount": 100,
      "deliveredAmountCurrencyCode": "NGN",
      "transactionDate": "2022-02-21 04:19:26",
      "pinDetail": null,
      "balanceInfo": {
        "oldBalance": 969849.49,
        "newBalance": 969749.49,
        "cost": 100,
        "currencyCode": "NGN",
        "currencyName": "Nigerian Naira",
        "updatedAt": "2022-02-21 09:19:26"
      }
    },
    {...},
    {...}
  ]
}

401 This response is gotten when a request is made with an incorrect or expired access token

JSON

{
  "timeStamp":"2021-06-09 22:43:05",
  "message":"Full authentication is required to access this resource",
  "path":"/topups/reports/transactions",
  "errorCode":"INVALID_TOKEN",
  "infoLink":null,
  "details":[
    
  ]
}

404 This response is gotten when a request is made with an incorrect URL path

JSON

{
  "timestamp":"2021-06-09T22:45:07.750+0000",
  "status":404,
  "error":"Not Found",
  "message":"No message available",
  "path":"/topups/reports/transaction"
}

Request samples

cURL

curl --location --request GET 'https://topups.reloadly.com/topups/reports/transactions' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN_HERE' \
--header 'Accept: application/com.reloadly.topups-v1+json' 

C#

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.Post, "https://topups.reloadly.com/topups/reports/transactions");

      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);
    }

  }
}

Golang

package main

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

func main() {

  url := "https://topups.reloadly.com/topups/reports/transactions"
  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))
}

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://topups.reloadly.com/topups/reports/transactions")
  .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();

Node JS

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://topups.reloadly.com/topups/reports/transactions',
  '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

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://topups.reloadly.com/topups/reports/transactions',
  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;

Python

import requests
import json

url = "https://topups.reloadly.com/topups/reports/transactions"

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 transaction.
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
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
requestedAmount	integer	Indicates the top-up amount sent by the originating account
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 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.
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	Indicates 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