Transaction Status Query

Overview

Description: This endpoint can be implemented as highlighted below:

Beneficiary Banks to Call EITS TSQ Endpoint: At the expiration of 5s waiting period, the beneficiary institutions are to call EITS TSQ endpoint to fetch the final transaction status from EITS and take action based on the status gotten.

For sending Encrypted Requests, the following steps should be adhered to

1. Create your plain request object

data: {
  "clientReference": "testClientReference12345678910",
  "transactionReference": "12345620230218165909406XOBSVLVNT3390ENVEC2FI5VK7T"
}

2. Using the AES 256 encryption, generate an encrypted request from the plain Request Body (Hint: Use the same AES 256 method used when generating the token) EncryptedRequestBody = AES 256(PlainRequestBody)

3. The final encrypted payload to be sent should look like this

{
  "data": "EncryptedRequestBody"
}

4. When you receive the request at your end, you decrypt it using the AES decryption method (Hint: Use the same AES 256 method used when decrypting the token)

Request Parameters

Parameter	Type	Description	Required
transactionReference	String	eTranzact’s Transaction Reference sent in initial FT credit request by instant transfer Service, and returned by the beneficiary institution.	No
clientReference	String	Client/initiating bank’s unique reference number. Maximum of 50 characters.	Yes

Response Parameters

Parameter	Type	Description	Required
responseCode	Integer	Transaction Response Code	Yes
responseMessage	String	Description of the response code	Yes
execTime	Integer	Time taken to process request(for metrics and performance tracking)	No
data	Object	Data object holding the response information	Yes
transactionReference	String	Transaction Reference generated by the Instant Transfer Service. This is to be used for transaction status query, Clients should design to allow a maximum of 50 characters.	Yes
clientReference	String	Client/initiating bank’s unique reference number. Clients should design to allow for a maximum of 50 characters.	Yes
amount	Integer	Transaction Amount, in kobo	Yes
fee	Integer	Transaction fee, in kobo, when applicable	No
currency	String	ISO4217 currency code. E.g. NGN, GBP	Yes
transactionDate	String	Transaction date in format: “yyyy-MM-dd HH:mm:ss”. During status validation, this is date within instant transfer service.	Yes
beneficiaryAccountNumber	String	Beneficiary Account Number	Yes
receiverReference	String	Reference received from beneficiary bank, a confirmation that transaction will be completed by beneficiary, after a follow up transaction status query. Maximum of 50 characters.	No

Plain Sample Request

POST / http://eits-staging.etranzactng.com/tsq/

curl `http://eits-staging.etranzactng.com/tsq/`
-H "Content-type: application/json"
-d
{
  "clientReference": "testClientReference12345678910",
  "transactionReference": "12345620230218165909406XOBSVLVNT3390ENVEC2FI5VK7T"
}
-X POST

Plain Sample Response

POST / http://eits-staging.etranzactng.com/tsq/

{
  "responseCode": "00",
  "responsemessage": "Transaction Successfully Processed",
  "execTime": 4,
  "data": {
    "transactionReference": "12345620230218165909406XOBSVLVNT3390ENVEC2FI5VK7T",
    "clientReference": "testClientReference12345678910",
    "amount": "100",
    "fee": null,
    "currency": "NGN",
    "transactionDate": "2023-02-18 16:59:08",
    "beneficiaryAccountNumber": "2222222222",
    "receiverReference": "12345678765"
  }
}

Encrypted Sample Request

POST / http://eits-staging.etranzactng.com/tsq/

curl `http://eits-staging.etranzactng.com/tsq/`
-H "Content-type: application/json"
-d '{ 
  "data": "aI6/RgSvQN5m3dZlALIwyKBWiYOUvgaHPsEi6jw+m4KzpDNHaSP4UOdPSN8W5Zzkwy0ymy7bSVqteyDppLWUog4T7bhW2IA6fSG1JSRbxc/W/OjEZHezSus4UtQk0pNONsVpGN3fma/GEn897TU0MO1gDSkVFTYCa01KUmbUdWBOHj5Cc2NIWK9R0NZLjkEStRaAZ8DQ1VzsE1vAd5gVPOkXD4QNhiRYjUKOYQ/2l7c0TKEitnbk8t/T2nyIeRr96ySV/4jXknR+ozc2si2RpfIh/ldl+nBS8U1haUdyadAYsnI/cVzJtzsXL22SgfAM"
}'
-X POST

Encrypted Sample Response

POST / http://eits-staging.etranzactng.com/tsq/

{
  "data": "aI6/RgSvQN5m3dZlALIwyKBWiYOUvgaHPsEi6jw+m4KzpDNHaSP4UOdPSN8W5Zzkwy0ymy7bSVqteyDppLWUog4T7bhW2IA6fSG1JSRbxc/W/OjEZHezSus4UtQk0pNONsVpGN3fma/GEn897TU0MO1gDSkVFTYCa01KUmbUdWBOHj5Cc2NIWK9R0NZLjkEStRaAZ8DQ1VzsE1vAd5gVPOkXD4QNhiRYjUKOYQ/2l7c0TKEitnbk8t/T2nyIeRr96ySV/4jXknR+ozc2si2RpfIh/ldl+nBS8U1haUdyadAYsnI/cVzJtzsXL22SgfAM"
}