Fetch transaction

1 min

GET

/client/v1/transaction/:client_reference

The document explains how to retrieve a single transaction. The unique transaction reference is required. The response from the API call includes a message indicating that the transaction have been retrieved, along with the details of the transaction, such as the id, status, and amount.

Path Parameters

client_referencestringrequired
Description
Your transaction reference that was passed when creating transfer

Header Parameters

X-CLIENT-IDstringrequired
Description
Your client ID
X-SIGNATUREstringrequired
Description
The base64 encoded signature
X-TIMESTAMPstringrequired
Description
The timestamp
X-NONCEstringrequired
Description
The Nonce

Responses

200transaction retrieved

clientApi.GetTransactionRequestSuccessful
Description
transaction retrieved
- dataclientApi.Transaction
  - idstring
    Description
    Unique identifier for the transaction.
  - business_idstring
    Description
    Unique business identifier that owns the transaction.
  - amountnumber
    Description
    A positive integer in currency representing how much was deducted (This includes any associated fees).
  - exchange_amountnumber
    Description
    A positive integer in the exchange currency representing how much was sent to the recipient.
  - exchange_ratestring
    Description
    A positive integer in kobo representing how much was exchanged.
  - currencystring
    Description
    A Three-letter ISO currency code for the amount
  - exchange_currencystring
    Description
    A Three-letter ISO currency code for the exchange amount
  - fee_amountnumber
    Description
    A fee deducted from the amount
  - account_numberstring
    Description
    Recipient account number
  - bank_codestring
    Description
    Recipient bank code. This is usually a Zide bank code and starts with `ZIDE`
  - bank_namestring
    Description
    Recipient bank name
  - recipient_namestring
    Description
    Recipient name
  - recipient_phonestring
    Description
    Recipient phone
  - recipient_countrystring
    Description
    Recipient country
  - typestring<DEBIT | CREDIT>
    Description
    Transaction type
  - statusstring<INPROGRESS | SUCCESSFUL | FAILED>
    Description
    Transaction status
  - service_namestring<BANK-TRANSFER>
    Description
    Service name. Describes what the transaction is
  - narrationstring
    Description
    An arbitrary string that is attached to the transaction by the sender
  - created_bystring
    Description
    Unique reference identifier of the client that created the transaction
  - created_atstring
    Description
    Date time string of when transaction was created
  - completed_atstring
    Description
    Date time string of when transaction was completed
  - updated_atstring
    Description
    Date time string of when transaction was last updated
- messagestring
  Default
  transaction retrieved

curl

curl --request GET \
     --url /client/v1/transaction/:client_reference \
     --header 'accept: application/json' \
     --header 'x-client-id: string' \
     --header 'x-signature: string' \
     --header 'x-timestamp: string' \
     --header 'x-nonce: string'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-client-id", "string");
myHeaders.append("x-signature", "string");
myHeaders.append("x-timestamp", "string");
myHeaders.append("x-nonce", "string");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("/client/v1/transaction/:client_reference", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("/client/v1/transaction/:client_reference")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-client-id"] = "string"
request["x-signature"] = "string"
request["x-timestamp"] = "string"
request["x-nonce"] = "string"

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "/client/v1/transaction/:client_reference"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'x-client-id': 'string',
   'x-signature': 'string',
   'x-timestamp': 'string',
   'x-nonce': 'string'
}

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

print(response.text)

200

// transaction retrieved
{
  "data": {
    "id": "",
    "business_id": "",
    "amount": 0,
    "exchange_amount": 0,
    "exchange_rate": "",
    "currency": "",
    "exchange_currency": "",
    "fee_amount": 0,
    "account_number": "",
    "bank_code": "",
    "bank_name": "",
    "recipient_name": "",
    "recipient_phone": "",
    "recipient_country": "",
    "type": "",
    "status": "",
    "service_name": "",
    "narration": "",
    "created_by": "",
    "created_at": "",
    "completed_at": "",
    "updated_at": ""
  },
  "message": ""
}