Credit Inquiry Request

post https://isw-transfer-service-core-microservice.k8.isw.la/transfers/inquiries/credit

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

Body Params

sourceAccountNumber

string

required

Source Account number

sourceAccountName

string

required

Source Account Name

sourceBankVerificationNumber

string

Source Customer Bank Verification Number

destinationAccountNumber

string

required

Destination Account Number

destinationInstitutionCode

string

required

Destination Institution code

transactionAmount

int64

required

Amount in minor denomination

currencyCode

string

required

ISO currency code ( ISO Numeric Code)

clientRef

string

required

Unique reference per transaction

mobileNumber

string

Internationally formatted mobile number

emailAddress

string

Customer Email Address

paymentLocation

string

The name and location of the card acceptor (such as a merchant or an ATM).

channelCode

int32

required

Channel ID

destinationInstitutionAlias

string

Institutions Alias. Can be used instead of destinationInstitutionCode

mcc

int64

The classification of the merchant’s type of business product or service.

rrn

int64

A reference number supplied by the system retaining the original source information and used to assist in locating that information or a copy thereof.

Headers

Authorization

string

Defaults to Bearer {Passport Access Token}

Content-Type

string

Defaults to application/json

Responses

Language

Request


xxxxxxxxxx
17
1
curl https://isw-transfer-service-core-microservice.k8.isw.la/inquiries/credit \
2
-H "Authorization: Bearer {Passport Access Token}" \
3
-H "Content-Type: application/json" \
4
-d '{
5
  "destinationAccountNumber " : "0123456789",
6
    "sourceAccountNumber": "8096080",
7
    "sourceAccountName": "Tolani Moshood",
8
    "destinationInstitutionCode":"ABP",
9
    "transactionAmount": 300000,
10
    "currencyCode": "566",
11
    "clientRef" : "abc1222223knkj",
12
    "mobileNumber":"2348089546016",
13
    "emailAddress" : "siryaya@gmail.com",
14
    "channelCode":2,
15
    "paymentLocation": "PBL,T,10360057075012,Adubiaro, DeborLaNG"
16
}' 
17
-X POST

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400

409409