Get Salary Loan

This endpoint creates a salary loan offer in the offers table, sends an accept offer request to the provider and credits the customer on behalf of the lender.

Request Message description

These are the fields to be sent by the third party channel in the request

Field#	Field name	Data type	Max length	Required	Description
1	customerId	String	13	true	The phone number of the customer in 234 format
2	channelCode	String	50	true	The channel’s unique code
3	providerCode	String	50	true	The provider code of the salary lender
4	amount	double		true	The loan amount  in minor denomination (#1000===100000)
5	amountPayable	long		true	The amount to be repaid by the customer
6	accountNumber	String	50	true	The customer’s bank account
7	bankCode	String		true	The bank code of the associated customer’s bank
8	tenure	String		true	The loan tenure in days
9	offerid	String	50	true	The unique offer identifier for the customer’s loan
10	interest	double		true	The percentage interest on the loan
11	loanSchemeCode	String		true	The channel’s identifier for the salary offer/loan record
12	borrowerName	String	50	true	The customer’s name
13	accountName	String	50	true	The customer’s account name
14	companyName	String	100	true	The customer’s company name
15	phoneNumber	String	20	true	The phone number of the customer in 234 format
16	bvn	String	11	false	The customer’s BVN

Endpoint

POST https://sandbox.interswitchng.com/lending-service/api/v1/salary/loan

Headers

Bearer {{token}}

Sample Request

Sample request

{"customerId": "2348161286422","channelCode": "APT","providerCode": "MKT","bankName": "GTBank","bankCode": "011","accountNumber": "1234567899","amount": 100000,"interest": 11.5,"amountPayable": 110000,"tenure": 14,"loanSchemeCode": "SLY","offerId": "ISW8490716851","borrowerName": "John Ade","accountName": "John Ade Umaru","companyName": "ABC and Co","phoneNumber": "23480600","bvn": "1234567890"}

Response Message  field description

Field#	Field name	Description
1	responseCode	Code of the returned response
2	responseMessage	Message explaining describing the response
3	transactionRef	The unique transaction reference
4	transactionId	The unique transaction identifier
5	loanId	The unique loan identifier returned in the “get salary loan” response

Sample Response (success)

Successful Loan disbursement response

{"responseCode": "S00","responseMessage": "Salary loan successfully disbursed","transactionRef": "BOL|LOC|CA|FBN|AC|180121151014|9MUN9QE94J","transactionId": "0432529007994","loanId": "APPMRT12345"}

Sample Response (failure)

Failed Loan disbursement response

{"responseCode": "01","responseMessage": "Failed (Unrecognized terminal owner)","transactionId": "0432498810390"}