Debit Customer

This endpoint will be used by the providers for loan collection when the loan repayment is due.

post/lending-service/api/v1/loans/{loanId}/debit

Request

  • Base URL
    https://sandbox.interswitchng.com
  • URL
    https://sandbox.interswitchng.com/lending-service/api/v1/loans/{loanId}/debit
  • Auth
    none required

Path parameters

loanIdstring required

The loan id of the loan for which this debit is for. Max length: 50

Headers

Authorizationstring

Request body

customerIdstring required

The Email or Mobile Number of the User. Max length: 50

loanIdstring required

The loan id of the loan for which this debit is for. Max length: 50

amountinteger required

The Amount to be debited from the user’s payment card. (This is in lower denomination KOBO)

providerCodestring required

The provider code. Max length: 50

transactionIdstring required

The Identifier for this transaction. This will be used to requery this transaction if needs be. Max length: 15

Response

200

responseCodestring
responseMessagestring
transactionRefstring
transactionIdstring

Example response

{
  "responseCode": "00",
  "responseMessage": "Transaction Successful",
  "transactionRef": "UBN|WEB|ILS|20170501091282|01238797",
  "transactionId": "198988747587875"
}

Changes

No recorded changes to this operation across all 1 revision of this API.