Credit Inquiry Request

This endpoint receives a request to confirm if an account specified in destinationAccountNumber can be credited with a specified amount .

On the successful completion of a credit inquiry, the transaction is logged in Transfer service and awaits a completion update with the same client reference sent in the inquiry or the transaction reference returned in the inquiry response.

*Response Message Description

Field

Field Name

Data type

Description

1

responseCode

String

Response Code

2

responseMessage

String

Response Message

3

accountName

String

Account Name

4

accountNumber

String

Account Number

5

clientRef

String

Initial reference sent by client if sent, or one auto generated by system

6

transactionReference

String

Unique transaction reference

7

bankVerificationNumber

String

Bank Verification Number

8

kycLevel

String

KYC Level

9

accountType

String

Current, Savings or Credit

10

accountCurrency

String

ISO currency

11

address

String

Receiver’s address. At present this attribute will not be used for any further processing.

12

countryCode

String

Country code of the transaction. This is the ISO country code.

13

canCredit

Boolean

f the account validation is successful for credit this will be true. Note: If true allow customer to proceed to complete the credit otherwise, fail the transaction. This is usually because the account is dormant, or the account cannot receive the amount specified.

14

systemResponseCode

String

System Response code that is sometimes included in response in case of exceptions in the system. This helps with issue resolution

15

action

String

Action on transaction as received from the middleware

16

settlementStatus

Status

Settlement status of inquiry transaction. Default settlement status for Inquiry is NEW

Language
Click Try It! to start a request and see the response here!