Enquiry
Request
Create a Post endpoint on your application using the path /enquiry we will send an API request to the endpoint whenever an inquiry is to be done on the account. It can be a balance inquiry, name inquiry, etc
Make sure to read the following information since you'll probably encounter it in this section.
Request
| Attribute | Type | Description | Required |
|---|---|---|---|
| requestId | String | A unique ID for every request sent across. Very necessary for the mac | True |
| walletId | String | The wallet id of the wallet to enquire | True |
| transactionReference | String | The reference that can be used to retrieve any transaction | True |
| mac | String | The hash included in every request is used to make sure the request is from the actual source it should be and has not been tampered with | True |
| transactionDateTime | LocalDateTime | This is the date and time the transaction occurred | False |
| terminalId | String | This is an identifier for the terminal the transaction came from | True |
| terminalType | String | A 2-digit string that defines the type of terminal. | True |
| merchantId | String | The merchant that accepted the card | True |
| acquiringInstitutionId | String | An ID to identify the institution that acquired the transaction | False |
| currencyCode | String | A code that identifies the currency the transaction was done on | True |
| cardAcceptorNameLocation | String | The name and location of the card acceptor | True |
| rrn | String | This is the Retrieval Ref Number | True |
| stan | String | This is the System Trace Audit Number | True |
| transactionFee | Long | The transaction fee is minor | True |
| additionalFields | Map | Any other ISO field needed by a fintech | False |
Request Mac
The request mac is generated by concatenating the following attributes in the order in which they occur, generating an HMAC using the shared private key, and getting the hex string of the result.
transactionReference, requestId, rrn, stan, walletId
Response attributes
| Attribute | Type | Description | Required |
|---|---|---|---|
| requestId | String | The requestId that came with the request. | True |
| responseCode | String | The code that signifies the status of the operation. | True |
| amount | Long | The balance on the user’s account. | True |
| transactionReference | String | The reference that came with the request | True |
| mac | String | The hash included in every response is used to make sure the request is from the actual source it should be and has not been tampered with | True |
Response Mac
The response Mac is generated by concatenating the following attributes in the order in which they occur, generating an HMAC using the shared private key, and getting the hex string of the result.
transactionReference, requestId, amount, name, responseCode
Sample requests
The sample requests for the inquiry only cover 3 scenarios. It should be noted that the difference between one response and another is just the response code. The response code table can be used to know the response code that can be used for other scenarios that might not be covered in the sample requests.
Successful
Request
{
"requestId": "1",
"walletId": "1234567894",
"transactionReference": "11123456789",
"mac": "hexdigest",
"transactionDateTime": "2020-05-15T13:32:09",
"terminalId": "3IWPDVNA",
"terminalType": "21",
"merchantId": "WEBPAYDIRECTVNA",
"acquiringInstitutionId": "428051043",
"currencyCode": "566",
"cardAcceptorNameLocation": "MATRIX ENERGY LIMITE LA LANG",
"rrn" : "000111000111",
"stan" : "000018",
"additionalFields=
{
"processingCode":"000000",
"merchantType":"8850"
} }
Response
{
"amount": 99998600,
"name": "Tony Starck",
"responseCode": "00",
"transactionReference": "11123456789",
"requestId": "1",
"mac": "hexdigest"
}
Invalid mac
Request
{
"requestId": "11",
"walletId": "1234567894",
"transactionReference": "11123456789",
"mac": "hexdigest",
"transactionDateTime": "2020-05-15T13:32:09",
"terminalId": "3IWPDVNA",
"terminalType": "21",
"merchantId": "WEBPAYDIRECTVNA",
"acquiringInstitutionId": "428051043",
"currencyCode": "566",
"cardAcceptorNameLocation": "MATRIX ENERGY LIMITE LA
"rrn" : "000111000111",
"stan" : "000018",
"additionalFields=
{
"processingCode":"000000",
"merchantType":"8850"
} }
Response
{
"amount": 0,
"name": "",
"responseCode": "12",
"transactionReference": "11123456789",
"requestId": "11",
"mac": "hexdigest"
}
Wallet not found
Request
{
"requestId": "1",
"walletId": "1234567894",
"transactionReference": "11123456789",
"mac": "hexdigest",
"transactionDateTime": "2020-05-15T13:32:09",
"terminalId": "3IWPDVNA",
"terminalType": "21",
"merchantId": "WEBPAYDIRECTVNA",
"acquiringInstitutionId": "428051043",
"currencyCode": "566",
"cardAcceptorNameLocation": "MATRIX ENERGY LIMITE LA LANG",
"rrn" : "000111000111",
"stan" : "000018",
"additionalFields=
{
"processingCode":"000000",
"merchantType":"8850"
} }
Response
{
"amount": 0,
"name": "",
"responseCode": "25",
"transactionReference": "11123456789",
"requestId": "11",
"mac": "hexdigest"
}
Updated 7 months ago