This endpoint is provisioned for providers who need to refund a customer that has been debited in excess during loan repayment \/ direct debit.
NOTE: Only CLOSED loans are eligible for refunds (i.e. the customer\u2019s loan has been fully repaid). <\/p>\n\n\n\n

<\/p>\n\n\n\n

Request Message Description<\/h4>\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>	50<\/td>	true<\/td>	The Email or Mobile Number of the customer to be refunded<\/td><\/tr>
2<\/td>	amount<\/td>	Long<\/td>	<\/td>	true<\/td>	The Amount to be refunded to the customer’s account (in kobo).<\/td><\/tr>
3<\/td>	transactionId<\/td>	String<\/td>	50<\/td>	true<\/td>	The unique transaction identifier. This is the reference that will be used to re-query for the transaction status in case of an unresolved state.<\/td><\/tr>
4<\/td>	loanId<\/td>	String<\/td>	20<\/td>	true<\/td>	The loanId of the customer\u2019s loan<\/td><\/tr>
5<\/td>	providerCode<\/td>	String<\/td>	50<\/td>	true<\/td>	The Code of the provider from which this request is coming from.<\/td><\/tr><\/tbody><\/table>\n\n\n\n <\/p>\n\n\n\n Endpoint<\/h4>\n\n\n\n POST \/payments\/refund <\/code><\/p>\n\n\n\n <\/p>\n\n\n\n Sample Request<\/h4>\n\n\n\n { \"customerId\": \"2348123456789\", \"amount\": 1250000, \/\/ Twelve thousand naira only \"transactionId\": \"09389877487857\", \"loanId\u201d: \u201cLOAN123\", \"ProviderId\": \"FER\" }<\/code><\/p>\n\n\n\n <\/p>\n\n\n\n Response Message\u00a0 Field Description<\/h4>\n\n\n\n Field#<\/th> Field name<\/th> Data Type<\/th> Max Length<\/th> Required<\/th> Description<\/th><\/tr><\/thead> 1<\/td> responseCode<\/td> Numeric String<\/td> 5<\/td> true<\/td> The code representing the status of the processing of this request<\/td><\/tr> 2<\/td> responseMessage<\/td> String<\/td> 255<\/td> true<\/td> The description of the responseCode.<\/td><\/tr> 3<\/td> transactionRef<\/td> String<\/td> 50<\/td> true<\/td> The Quickteller Transaction Reference for the transfer request.<\/td><\/tr><\/tbody><\/table>\n\n\n\n <\/p>\n\n\n\n Sample Response (success)<\/h4>\n\n\n\n { \"responseCode\" : \"00\", \"responseMessage\" : \"Transaction Successful\", \"transactionRef\" : \"UBN|WEB|ILS|20170501091282|01238797\" }<\/code><\/p>\n\n\n\n <\/p>\n\n\n\n Sample Response (failure)\u00a0<\/h4>\n\n\n\n { \"responseCode\" : \"417\", \"responseMessage\" : \"Loan must be Closed before a refund can be sent to the customer.\" } <\/code><\/p>\n\n\n\n <\/p>\n\n\n\n Response Code<\/h4>\n\n\n\n Response Code<\/strong><\/td> Response Message<\/strong><\/td> Applicable Requests<\/strong><\/td><\/tr><\/thead> 00<\/td> success<\/td> All<\/td><\/tr> 51<\/td> Insufficient Funds<\/td> Credit Customer, Do Funds Transfer, Debit Customer, Do Payment<\/td><\/tr> 91<\/td> Issuer or switch Inoperative<\/td> Credit Customer, Do Funds Transfer, Debit Customer, Do Payment<\/td><\/tr> 3001<\/td> No Offer<\/td> <\/td><\/tr> 4001<\/td> Declined offer<\/td> <\/td><\/tr> 4002<\/td> Offer Expired<\/td> <\/td><\/tr> 4004<\/td> Unknown Offer<\/td> Credit Customer, Debit Customer, Requery Payment\/Transaction Status, Update Loan Status<\/td><\/tr> 4009<\/td> Payment Already Received\/Made<\/td> Credit Customer, Do Funds Transfer, Debit Customer, Do Payment<\/td><\/tr> 5000<\/td> System Error<\/td> All<\/td><\/tr> E38<\/td> A search parameter must be provided<\/code><\/td> Get Customer Information<\/td><\/tr><\/tbody><\/table>\n","protected":false},"author":169,"featured_media":0,"parent":2270,"menu_order":9,"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\/3785"}],"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=3785"}],"version-history":[{"count":3,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/3785\/revisions"}],"predecessor-version":[{"id":3789,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/3785\/revisions\/3789"}],"up":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/2270"}],"next":[{"title":"Get Customer Information","link":"https:\/\/sandbox.interswitchng.com\/docbase\/docs\/ils\/providers\/get-customer-information\/","href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/2291"}],"prev":[{"title":"Send SMS","link":"https:\/\/sandbox.interswitchng.com\/docbase\/docs\/ils\/providers\/send-sms\/","href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/2289"}],"wp:attachment":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/media?parent=3785"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/doc_tag?post=3785"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}