Lockloantransactionswrapper
Represents a wrapper over a list of loan transactions, to be used when locking and unlocking an account.
loanTransactions object[]
The list of loan transactions
accountBalances object
The balances changed within a transaction.
Captures the advance (prepaid) amount.
Captures the arrears position amount for the account in arrears.
The difference between principal balance and redraw balance after each transaction performed on the loan account.
The account redraw balance captured after the transaction update.
The account redraw balance captured after the transaction update.
The running balance still owed for the loan.
The key of the loan transaction where the adjustment for the transaction was made (if any adjustment was involved).
affectedAmounts object
The amounts affected after completing the loan transaction
How much credit balance was added/removed in account, within this transaction.
How much interest pre-paid was added/removed in account, within this transaction (including taxes).
How much fees was added/removed in account, within this transaction.
How much interest is given to the investors, within this transaction (only for p2p products)
How much interest was added/removed in account, within this transaction (including taxes). If there is any deferred interest amount set in this transaction, that amount should be included in this field.
How much interest from arrears was added/removed in account, within this transaction (including taxes).
How much interest is given to the organization, within this transaction (only for p2p products)
How much Payment Holidays interest was added/removed in account, within this transaction (including taxes).
How much penalties was added/removed in account, within this transaction.
How much principal was added/removed in account, within this transaction.
The amount that was added or removed on the loan account.
The date when the corresponding journal entry is booked.
2016-09-06T13:37:50+03:00The branch where the transaction was performed.
cardTransaction object
A card transaction entry which will have a corresponding a financial transaction performed.
Whether the given request should be accepted without balance validations.
The amount of money to be withdrawn in the financial transaction.
cardAcceptor object
The details of the card acceptor (merchant) in a transaction hold.
The city in which the card acceptor has the business.
The country in which the card acceptor has the business.
The Merchant Category Code of the card acceptor.
The name of the card acceptor.
The state in which the card acceptor has the business.
The street in which the card acceptor has the business.
The ZIP code of the location in which the card acceptor has the business.
The reference token of the card.
The ISO currency code in which the card reversal transaction is posted. The amounts are stored in the base currency, but the transaction can be created with a foreign currency.
The encoded key of the entity, generated, globally unique
The external authorization hold reference ID, which relates this card transaction to a previous authorization hold.
The external reference ID to be used to reference the card transaction in subsequent requests.
The formatted time at which the user made this card transaction.
The center where the transaction was performed.
The date when this loan transaction was created.
2016-09-06T13:37:50+03:00currency object
Represents a currency eg. USD, EUR.
Fiat(ISO-4217) currency code or NON_FIAT for non fiat currencies.
Possible values: [AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SLE, SOS, SRD, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UYW, UZS, VED, VEF, VES, VND, VUV, WST, XAG, XAU, XAF, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZIG, ZWG, ZMK, ZWL, ZMW, SSP, NON_FIAT]
Currency code for NON_FIAT currency.
customPaymentAmounts object[]
The list of custom amounts which the user has paid as part of this transaction.
The amount of the payment paid in the transaction for the given type.
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]
The encodedKey of the predefined fee to be paid.
The amount of the taxes paid in the transaction for the given type.
The encoded key of the loan transaction, which is auto generated, and must be unique.
The external ID of the loan transaction, it is customizable, and must be unique.
fees object[]
The amounts that have been applied or paid as part of this transaction and involved predefined fees.
The amount of the fee that was applied/paid in the transaction for the given predefined fee.
The name of the predefined fee
The encoded key of the predefined fee, auto generated, unique
The amount of the taxes on fee that was applied/paid in the transaction.
Shows the event that will trigger a fee
Possible values: [MANUAL, MANUAL_PLANNED, DISBURSEMENT, CAPITALIZED_DISBURSEMENT, UPFRONT_DISBURSEMENT, LATE_REPAYMENT, PAYMENT_DUE, PAYMENT_DUE_APPLIED_ON_DUE_DATES, ARBITRARY, IOF, EARLY_REPAYMENT_CHARGE, FEE_INCLUDED_IN_PMT]
The ID of the loan transaction, can be generated and customized, and must be unique.
The specific installment encoded key associated to the loan transaction.
lateFeePerInstallment object
The late fees associated per installment for the loan transaction.
The late fees associated per installment for the loan transaction.
The specific principal overpayment transaction key associated to the loan transaction.
The migration event encoded key associated with the loan account. If the account was imported, track which 'migration event' it came from.
The notes or description for the loan transaction.
The amount that was posted in a foreign currency. This amount was converted using the exchange rate available at entry date and set into the amount field.
The currency in which this transaction was posted. The amounts are stored in the base currency, but the user may enter it in a foreign currency.
The encoded key of the transaction that was adjusted as part of this one. Available only for adjustment transactions.
The key of the parent loan account.
The key of the parent loan transaction.
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]
taxes object
The taxes applied within a transaction.
How much taxes on the interest that was pre-paid were added/removed in account, within this transaction. If there is any deferred tax on interest amount set in this transaction, that amount should be included in this field.
How much taxes on the fees that were paid in this transaction were added/removed in account, within this transaction.
How much taxes on the interest that was paid in this transaction were added/removed in account, within this transaction.
The amount of taxes on the interest from arrears that were applied/paid in account, within this transaction.
The amount of taxes on the Payment Holidays interest that were added/removed in account, within this transaction.
How much taxes on the penalties that were paid in this transaction were added/removed in account, within this transaction.
The tax rate that was set or changed in this transaction.
terms object
The loan transaction terms
interestSettings object
The interest settings, holds all the properties regarding interests for the loan account.
The value of the index interest rate
The interest rate. Represents the interest rate for the loan account. The interest on loans is accrued on a daily basis, which allows charging the clients only for the days they actually used the loan amount.
The periodic payment value logged when changing it for a Balloon Payments account
The principal payment flat amount logged when changing it for a Revolving Credit account
The principal payment percentage value logged when changing it for a Revolving Credit account
The till key associated with the transaction.
transactionDetails object
Contains the details about transaction including fields like transaction channel key and channel id
The id of the transaction channel associated with the transaction details.
The encoded key of the transaction channel associated with the transaction details.
transferDetails object
Represents the transfer details, such as the linked transaction key
The key of the related deposit transaction
The key of the related loan transaction
The type of loan transaction.
Possible values: [IMPORT, DISBURSEMENT, DISBURSEMENT_ADJUSTMENT, WRITE_OFF, WRITE_OFF_ADJUSTMENT, REPAYMENT, ADVANCE_REPAYMENT, PAYMENT_MADE, WITHDRAWAL_REDRAW, WITHDRAWAL_REDRAW_ADJUSTMENT, FEE_APPLIED, FEE_CHARGED, FEE_CAPITALISED, SCHEDULE_FIX_APPLIED, FEES_DUE_REDUCED, FEE_REFUND, FEE_REFUND_ADJUSTMENT, FEE_ADJUSTMENT, PENALTY_APPLIED, PENALTY_ADJUSTMENT, PENALTIES_DUE_REDUCED, REPAYMENT_ADJUSTMENT, ADVANCE_REPAYMENT_ADJUSTMENT, FEE_CAPITALISED_ADJUSTMENT, PAYMENT_MADE_ADJUSTMENT, INTEREST_RATE_CHANGED, FEE_RATE_CHANGED, TAX_RATE_CHANGED, PENALTY_RATE_CHANGED, INTEREST_APPLIED, IBF_INTEREST_APPLIED, IBF_INTEREST_APPLIED_ADJUSTMENT, INTEREST_APPLIED_ADJUSTMENT, INTEREST_DUE_REDUCED, PENALTY_REDUCTION_ADJUSTMENT, FEE_REDUCTION_ADJUSTMENT, INTEREST_REDUCTION_ADJUSTMENT, DEFERRED_INTEREST_APPLIED, DEFERRED_INTEREST_APPLIED_ADJUSTMENT, DEFERRED_INTEREST_PAID, DEFERRED_INTEREST_PAID_ADJUSTMENT, INTEREST_LOCKED, FEE_LOCKED, PENALTY_LOCKED, INTEREST_UNLOCKED, FEE_UNLOCKED, PENALTY_UNLOCKED, REDRAW_TRANSFER, REDRAW_REPAYMENT, REDRAW_TRANSFER_ADJUSTMENT, REDRAW_REPAYMENT_ADJUSTMENT, TRANSFER, TRANSFER_ADJUSTMENT, BRANCH_CHANGED, TERMS_CHANGED, CARD_TRANSACTION_REVERSAL, CARD_TRANSACTION_REVERSAL_ADJUSTMENT, DUE_DATE_CHANGED, DUE_DATE_CHANGED_ADJUSTMENT, ACCOUNT_TERMINATED, ACCOUNT_TERMINATED_ADJUSTMENT, REFUND, REFUND_ADJUSTMENT, REDUCE_BALANCE, REDUCE_BALANCE_ADJUSTMENT, PRINCIPAL_OVERPAYMENT, PRINCIPAL_OVERPAYMENT_ADJUSTMENT, CREDIT_BALANCE_DEPOSIT, CREDIT_BALANCE_DEPOSIT_ADJUSTMENT, CREDIT_BALANCE_WITHDRAWAL, CREDIT_BALANCE_WITHDRAWAL_ADJUSTMENT, PAYMENT_HOLIDAYS_INTEREST_CAPITALISED, PAYMENT_HOLIDAYS_INTEREST_CAPITALISED_ADJUSTMENT]
The user that performed the transaction.
The date of the entry in the organization time format and timezone.
2016-09-06T13:37:50+03:00{
"loanTransactions": [
{
"accountBalances": {
"advancePosition": 0,
"arrearsPosition": 0,
"expectedPrincipalRedraw": 0,
"principalBalance": 0,
"redrawBalance": 0,
"totalBalance": 0
},
"adjustmentTransactionKey": "string",
"affectedAmounts": {
"creditBalanceChangeAmount": 0,
"deferredInterestAmount": 0,
"feesAmount": 0,
"fundersInterestAmount": 0,
"interestAmount": 0,
"interestFromArrearsAmount": 0,
"organizationCommissionAmount": 0,
"paymentHolidaysInterestAmount": 0,
"penaltyAmount": 0,
"principalAmount": 0
},
"amount": 0,
"bookingDate": "2016-09-06T13:37:50+03:00",
"branchKey": "string",
"cardTransaction": {
"advice": true,
"amount": 0,
"cardAcceptor": {
"city": "string",
"country": "string",
"mcc": 0,
"name": "string",
"state": "string",
"street": "string",
"zip": "string"
},
"cardToken": "string",
"currencyCode": "string",
"encodedKey": "string",
"externalAuthorizationReferenceId": "string",
"externalReferenceId": "string",
"userTransactionTime": "string"
},
"centreKey": "string",
"creationDate": "2016-09-06T13:37:50+03:00",
"currency": {
"code": "AED",
"currencyCode": "string"
},
"customPaymentAmounts": [
{
"amount": 0,
"customPaymentAmountType": "PRINCIPAL",
"predefinedFeeKey": "string",
"taxOnAmount": 0
}
],
"encodedKey": "string",
"externalId": "string",
"feeIncludedInPmt": true,
"fees": [
{
"amount": 0,
"name": "string",
"predefinedFeeKey": "string",
"taxAmount": 0,
"trigger": "MANUAL"
}
],
"id": "string",
"installmentEncodedKey": "string",
"lateFeeIncludedInPmt": true,
"lateFeePerInstallment": {},
"linkedPrincipalOverpaymentTransactionKey": "string",
"migrationEventKey": "string",
"notes": "string",
"originalAmount": 0,
"originalCurrencyCode": "string",
"originalTransactionKey": "string",
"parentAccountKey": "string",
"parentLoanTransactionKey": "string",
"prepaymentRecalculationMethod": "NO_RECALCULATION",
"taxes": {
"deferredTaxOnInterestAmount": 0,
"taxOnFeesAmount": 0,
"taxOnInterestAmount": 0,
"taxOnInterestFromArrearsAmount": 0,
"taxOnPaymentHolidaysInterest": 0,
"taxOnPenaltyAmount": 0,
"taxRate": 0
},
"terms": {
"interestSettings": {
"indexInterestRate": 0,
"interestRate": 0
},
"periodicPayment": 0,
"principalPaymentAmount": 0,
"principalPaymentPercentage": 0
},
"tillKey": "string",
"transactionDetails": {
"transactionChannelId": "string",
"transactionChannelKey": "string"
},
"transferDetails": {
"linkedDepositTransactionKey": "string",
"linkedLoanTransactionKey": "string"
},
"type": "IMPORT",
"userKey": "string",
"valueDate": "2016-09-06T13:37:50+03:00"
}
]
}