Skip to main content

Repaymentloantransactioninput

Represents the request payload for creating a transaction of type REPAYMENT

advanceRepaymentboolean

Sets if the repayment is an advance repayment

amountnumberrequired

The amount of the repayment

bookingDatestring<date-time>

The booking date of the repayment (as Organization Time)

Example: 2016-09-06T13:37:50+03:00
customPaymentAmounts object[]

The list of custom amounts of the repayment

  • Array [
  • amountnumberrequired

    The amount of the payment paid in the transaction for the given type.

    customPaymentAmountTypestringrequired

    The type of the custom payment

    Possible values: [PRINCIPAL, INTEREST, MANUAL_FEE, UPFRONT_DISBURSEMENT_FEE, LATE_REPAYMENT_FEE, PAYMENT_DUE_FEE, PENALTY, INTEREST_FROM_ARREARS, NON_SCHEDULED_FEE, INTEREST_BEARING_FEE, INTEREST_BEARING_FEE_INTEREST, CF_PRINCIPAL_IN_ARREARS, CF_INTEREST, CF_INTEREST_FROM_ARREARS, FEE_INCLUDED_IN_PMT]

    predefinedFeeKeystring

    The encodedKey of the predefined fee to be paid.

    taxOnAmountnumber

    The amount of the taxes paid in the transaction for the given type.

  • ]
  • externalIdstring

    The external id of the repayment transaction, customizable, unique

    installmentEncodedKeystring

    The encoded key of the schedule installment to which this repayment is associated

    notesstring

    Extra notes about the repayment transaction. Notes can have at most 255 characters in length.

    originalCurrencyCodestring

    The currency code for the repayment transaction

    prepaymentRecalculationMethodstring

    The prepayment recalculation method types.

    Possible values: [NO_RECALCULATION, RESCHEDULE_REMAINING_REPAYMENTS, RECALCULATE_SCHEDULE_KEEP_SAME_NUMBER_OF_TERMS, RECALCULATE_SCHEDULE_KEEP_SAME_PRINCIPAL_AMOUNT, RECALCULATE_SCHEDULE_KEEP_SAME_TOTAL_REPAYMENT_AMOUNT, REDUCE_AMOUNT_PER_INSTALLMENT, REDUCE_NUMBER_OF_INSTALLMENTS, REDUCE_NUMBER_OF_INSTALLMENTS_NEW]

    principalOverpaymentAmountnumber

    The amount of the principal overpayment

    transactionDetails object

    Contains the details about transaction including fields like transaction channel key and channel ID

    transactionChannelIdstring

    The id of the transaction channel associated with the transaction details input.

    transactionChannelKeystring

    The encoded key of the transaction channel associated with the transaction details input.

    valueDatestring<date-time>

    The entry date of the repayment (as Organization Time)

    Example: 2016-09-06T13:37:50+03:00
    Repaymentloantransactioninput
    {
    "advanceRepayment": true,
    "amount": 0,
    "bookingDate": "2016-09-06T13:37:50+03:00",
    "customPaymentAmounts": [
    {
    "amount": 0,
    "customPaymentAmountType": "PRINCIPAL",
    "predefinedFeeKey": "string",
    "taxOnAmount": 0
    }
    ],
    "externalId": "string",
    "installmentEncodedKey": "string",
    "notes": "string",
    "originalCurrencyCode": "string",
    "prepaymentRecalculationMethod": "NO_RECALCULATION",
    "principalOverpaymentAmount": 0,
    "transactionDetails": {
    "transactionChannelId": "string",
    "transactionChannelKey": "string"
    },
    "valueDate": "2016-09-06T13:37:50+03:00"
    }