Get Salary Loan<\/h3>\n\n\n\n

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.<\/p>\n\n\n\n

Request Message description<\/h4>\n\n\n\n

These are the fields to be sent by the third party channel in the request<\/p>\n\n\n\n

Field#<\/th>	Field name<\/th>	Data type<\/th>	Max length<\/th>	Required<\/th>	Description<\/th><\/tr><\/thead>
1<\/td>	customerId<\/td>	String<\/td>	13<\/td>	true<\/td>	The phone number of the customer in 234 format<\/td><\/tr>
2<\/td>	channelCode<\/td>	String<\/td>	50<\/td>	true<\/td>	The channel’s unique code<\/td><\/tr>
3<\/td>	providerCode<\/td>	String<\/td>	50<\/td>	true<\/td>	The provider code of the salary lender<\/td><\/tr>
4<\/td>	amount<\/td>	double<\/td>	<\/td>	true<\/td>	The loan amount\u00a0 in minor denomination (#1000===100000)<\/td><\/tr>
5<\/td>	amountPayable<\/td>	long<\/td>	<\/td>	true<\/td>	The amount to be repaid by the customer<\/td><\/tr>
6<\/td>	accountNumber<\/td>	String<\/td>	50<\/td>	true<\/td>	The customer’s bank account<\/td><\/tr>
7<\/td>	bankCode<\/td>	String<\/td>	<\/td>	true<\/td>	The bank code of the associated customer’s bank <\/td><\/tr>
8<\/td>	tenure<\/td>	String<\/td>	<\/td>	true<\/td>	The loan tenure in days<\/td><\/tr>
9<\/td>	offerid<\/td>	String<\/td>	50<\/td>	true<\/td>	The unique offer identifier for the customer’s loan<\/td><\/tr>
10<\/td>	interest<\/td>	double<\/td>	<\/td>	true<\/td>	The percentage interest on the loan<\/td><\/tr>
11<\/td>	loanSchemeCode<\/td>	String<\/td>	<\/td>	true<\/td>	The channel’s identifier for the salary offer\/loan record<\/td><\/tr>
12<\/td>	borrowerName<\/td>	String<\/td>	50<\/td>	true<\/td>	The customer’s name<\/td><\/tr>
13<\/td>	accountName<\/td>	String<\/td>	50<\/td>	true<\/td>	The customer’s account name<\/td><\/tr>
14<\/td>	companyName<\/td>	String<\/td>	100<\/td>	true<\/td>	The customer’s company name<\/td><\/tr>
15<\/td>	phoneNumber<\/td>	String<\/td>	20<\/td>	true<\/td>	The phone number of the customer in 234 format<\/td><\/tr>
16<\/td>	bvn<\/td>	String<\/td>	11<\/td>	false<\/td>	The customer’s BVN<\/td><\/tr><\/tbody><\/table>\n\n\n\n Endpoint<\/strong><\/p>\n\n\n\n POST <\/code> https:\/\/sandbox.interswitchng.com\/lending-service\/api\/v1\/salary\/loan <\/td><\/tr><\/tbody><\/table>\n\n\n\n Headers<\/strong><\/p>\n\n\n\n Bearer {{token}}<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n Sample Request<\/h5>\n\n\n\n Sample request<\/strong><\/p>\n\n\n\n {<\/code>\"customerId\"<\/code>: <\/code>\"2348161286422\"<\/code>,<\/code>\"channelCode\"<\/code>: <\/code>\"APT\"<\/code>,<\/code>\"providerCode\"<\/code>: <\/code>\"MKT\"<\/code>,<\/code>\"bankName\"<\/code>: <\/code>\"GTBank\"<\/code>,<\/code>\"bankCode\"<\/code>: <\/code>\"011\"<\/code>,<\/code>\"accountNumber\"<\/code>: <\/code>\"1234567899\"<\/code>,<\/code>\"amount\"<\/code>: 100000,<\/code>\"interest\"<\/code>: 11.5,<\/code>\"amountPayable\"<\/code>: 110000,<\/code>\"tenure\"<\/code>: 14,<\/code>\"loanSchemeCode\"<\/code>: <\/code>\"SLY\"<\/code>,<\/code>\"offerId\"<\/code>: <\/code>\"ISW8490716851\"<\/code>,<\/code>\"borrowerName\"<\/code>: <\/code>\"John Ade\"<\/code>,<\/code>\"accountName\"<\/code>: <\/code>\"John Ade Umaru\"<\/code>,<\/code>\"companyName\"<\/code>: <\/code>\"ABC and Co\"<\/code>,<\/code>\"phoneNumber\"<\/code>: <\/code>\"23480600\"<\/code>,<\/code>\"bvn\"<\/code>: <\/code>\"1234567890\"<\/code>}<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n Response Message  field description<\/h4>\n\n\n\n Field#<\/th> Field name<\/th> Description<\/th><\/tr><\/thead> 1<\/td> responseCode<\/td> Code of the returned response<\/td><\/tr> 2<\/td> responseMessage<\/td> Message explaining describing the response<\/td><\/tr> 3<\/td> transactionRef<\/td> The unique transaction reference <\/td><\/tr> 4<\/td> transactionId<\/td> The unique transaction identifier<\/td><\/tr> 5<\/td> loanId<\/td> The unique loan identifier returned in the “get salary loan” response<\/td><\/tr><\/tbody><\/table>\n\n\n\n Sample Response (success)<\/h5>\n\n\n\n Successful Loan disbursement response<\/p>\n\n\n\n {<\/code>\"responseCode\"<\/code>: <\/code>\"S00\"<\/code>,<\/code>\"responseMessage\"<\/code>: <\/code>\"Salary loan successfully disbursed\"<\/code>,<\/code>\"transactionRef\"<\/code>: <\/code>\"BOL|LOC|CA|FBN|AC|180121151014|9MUN9QE94J\"<\/code>,<\/code>\"transactionId\"<\/code>: <\/code>\"0432529007994\"<\/code>,<\/code>\"loanId\"<\/code>: <\/code>\"APPMRT12345\"<\/code>}<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n Sample Response (failure)<\/h5>\n\n\n\n Failed Loan disbursement response<\/p>\n\n\n\n {<\/code>\"responseCode\"<\/code>: <\/code>\"01\"<\/code>,<\/code>\"responseMessage\"<\/code>: <\/code>\"Failed (Unrecognized terminal owner)\"<\/code>,<\/code>\"transactionId\"<\/code>: <\/code>\"0432498810390\"<\/code>}<\/code><\/td><\/tr><\/tbody><\/table>\n","protected":false},"author":169,"featured_media":0,"parent":3290,"menu_order":1,"comment_status":"open","ping_status":"closed","template":"","meta":{"spay_email":""},"doc_tag":[],"_links":{"self":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/3681"}],"collection":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/users\/169"}],"replies":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/comments?post=3681"}],"version-history":[{"count":8,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/3681\/revisions"}],"predecessor-version":[{"id":4374,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/3681\/revisions\/4374"}],"up":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/3290"}],"next":[{"title":"Salary Loan Repayment Notification","link":"https:\/\/sandbox.interswitchng.com\/docbase\/docs\/ils\/salary-lending\/salary-loan-repayment-notification\/","href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/3682"}],"prev":[{"title":"","link":"https:\/\/sandbox.interswitchng.com\/docbase\/docs\/ils\/salary-lending\/get-info\/","href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/3291"}],"wp:attachment":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/media?parent=3681"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/doc_tag?post=3681"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}