Name Enquiry

Overview

Description: This is specification used by initiating bank to fetch Account name attached to beneficiary account. It is expected that beneficiary bank implements an interface that accepts the below request and response. Beneficiary bank will communicate the full restful endpoint url to eTranzact.

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

1. Create your plain request object

data: {
    "clientReference": "testClientReference12345678910",
    "transactionReference": "830UDI83HKHSD8U90U3830UD",
    "channel": 10,
    "initiatorInstitutionCode": "123456",
    "destinationIssuerCode": "345678",
    "accountNumber": "00987601234"
}

2. Using the AES 256 encryption, generate an encrypted requuest 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	Transaction reference from eTranzact instant transfer service. Maximum of 50 characters.	Yes
clientReference	String	Client/initiating bank’s unique reference number. Maximum of 50 characters.	No
channel	integer	Channel ID through which transaction originated. Refer to transaction response and Channel codes description table	No
initiatorInstitutionCode	String	Initiating institution code, when applicable.	No
accountNumber	String	Beneficiary Account Number. Maximum of 30 characters.	Yes

Response Parameters

Parameter	Type	Description	Mandatory
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
accountName	String	Customer’s Full Name	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.	Yes
transactionReference	String	Transaction Reference generated by the Instant Payment Service. This is to be used for transaction status query	Yes
accountNumber	String	Account Number supplied in the request	Yes
destinationIssuerCode	String	Institution CBN Issuer code	Yes

Plain Sample Request

POST / https://{defined_by_beneficiary_bank

curl `https://{defined_by_beneficiary_bank}`
-H "Content-type: application/json"
-d '{
    "clientReference": "testClientReference12345678910",
    "transactionReference": "830UDI83HKHSD8U90U3830UD",
    "channel": 10,
    "initiatorInstitutionCode": "123456",
    "destinationIssuerCode": "345678",
    "accountNumber": "00987601234"
}'
-X POST

Plain Sample Response

POST / https://{defined_by_beneficiary_bank

{
  "responseCode": "00",
  "responseMessage": "Successful",
  "execTime": 10003,
  "data": {
    "transactionReference": "830UDI83HKHSD8U90U3830UD",
    "receiverReference": "bankReference12345678910",
    "accountName": "Peter Alex",
    "accountNumber": "00987601234",
    "destinationIssuerCode": "003"
  }
}

Encrypted Sample Request

POST / https://{defined_by_beneficiary_bank

curl `https://{defined_by_beneficiary_bank}`
-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 / https://{defined_by_beneficiary_bank

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