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’s loan has been fully repaid).
Request Message Description
Field# | Field name | Data type | Max length | Required | Description |
---|---|---|---|---|---|
1 | customerId | String | 50 | true | The Email or Mobile Number of the customer to be refunded |
2 | amount | Long | true | The Amount to be refunded to the customer’s account (in kobo). | |
3 | transactionId | String | 50 | true | 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. |
4 | loanId | String | 20 | true | The loanId of the customer’s loan |
5 | providerCode | String | 50 | true | The Code of the provider from which this request is coming from. |
Endpoint
POST /payments/refund
Sample Request
{
"customerId": "2348123456789",
"amount": 1250000, // Twelve thousand naira only
"transactionId": "09389877487857",
"loanId”: “LOAN123",
"ProviderId": "FER"
}
Response Message Field Description
Field# | Field name | Data Type | Max Length | Required | Description |
---|---|---|---|---|---|
1 | responseCode | Numeric String | 5 | true | The code representing the status of the processing of this request |
2 | responseMessage | String | 255 | true | The description of the responseCode. |
3 | transactionRef | String | 50 | true | The Quickteller Transaction Reference for the transfer request. |
Sample Response (success)
{
"responseCode" : "00",
"responseMessage" : "Transaction Successful",
"transactionRef" : "UBN|WEB|ILS|20170501091282|01238797"
}
Sample Response (failure)
{
"responseCode" : "417",
"responseMessage" : "Loan must be Closed before a refund can be sent to the customer."
}
Response Code
Response Code | Response Message | Applicable Requests |
00 | success | All |
51 | Insufficient Funds | Credit Customer, Do Funds Transfer, Debit Customer, Do Payment |
91 | Issuer or switch Inoperative | Credit Customer, Do Funds Transfer, Debit Customer, Do Payment |
3001 | No Offer | |
4001 | Declined offer | |
4002 | Offer Expired | |
4004 | Unknown Offer | Credit Customer, Debit Customer, Requery Payment/Transaction Status, Update Loan Status |
4009 | Payment Already Received/Made | Credit Customer, Do Funds Transfer, Debit Customer, Do Payment |
5000 | System Error | All |
E38 | A search parameter must be provided | Get Customer Information |