Transmit a repayment
Transmit a repayment for a loan
POST https://sandbox-api.nanol.com/v1/users/{user_id}/loans/{loan_id}/payments
Returns a repayment_uuid for the payment along with the balance of the loan. Returns an error if parameters are invalid (e.g. specifying an amount greater than the balance).
Path Parameters
user_id*
string
The uuid of the user
loan_id*
string
The uuid of the loan
Request Body
payment_type*
enum
The type of the repayment transaction. Possible values:
SINGLE_PAYMENT: one-off payment
PAYOFF: if a user pays off entire balance, the posted payment
RETURNED: if a payment has been returned, for example in the case of non-sufficient funds, closed bank account, invalid account/routing numbers or if a payment has been reported as unauthorized
REFUNDED: if a user requests for a loan payment to be refunded, for example due to a duplicated or accidental payment
DISPUTED: if the card transaction has been disputed
amount*
float
The repayment amount, in USD. The maximum amount is the remaining balance of the loan.
payment_date
string
The date to initiate the payment, formatted as YYYY-MM-DD. ForSINGLE_PAYMENT, AND PAYOFF transactions, this can be set to the date when the transaction posts (not when the payment is initiated)
Format: YYYY-MM-DD
repayment_bank_info
object
An object containing the user's bank details for processing loan repayments, structured as follows:
{
"bank_account_number": "456455535",
"bank_name": "ECOBANK",
"bank_account_name": "ECOBANK checking",
"account_type" : "checking"
}
original_payment_date
string
For DISPUTED, RETURNED and REFUNDED transactions, the original_payment_date must be set to the date of the corresponding original payment
{
"uuid": "0fbb5ce0-8f20-4bc6-b806-14ebff8fb78e"
}{
// Response
}Last updated