Search

/

Reference

Pages

Homeorganizationproductsdeposit accountsloan accountstransactionsservicesledgersuserssystem

Transactions

This page includes documentation related to creating and undo-ing both deposit and loan transactions.

TRANSACTIONS

Package transactions defines the API for managing transactions.

CreateBulkDeposit

POST /v1/deposits:bulk

Creates multiple deposit transactions. TODO: Add Response type..

Request Body (BulkDepositTransactions)
Name Description Type
transactions A list of bulk deposit transactions Array[BulkDepositTransaction]

CreateDeposit

POST /v1/deposits/{AccountID}:deposit

Creates a new deposit transaction for the account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to create the transaction for String
Request Body (NewDepositTransaction)
Name Description Type
transaction_id The ID of the transaction String
amount The amount deposited Amount
notes The extra human-readable notes for the transaction String
payment The information of the account debited and credited Payment
order_id The ID of the payment order String
skip_validation A flag that disables maximum balance checks Boolean
channel_id The ID of the transaction channel String
book_time The time when the transaction is logged into accounting Timestamp
value_time The time when the transaction is executed Timestamp
  • Name Description Type
    transaction_id The ID of the deposit transaction String
    user_id The ID of the user performing the transaction String
    total_change The total amount of balance changed in the transaction Amount
    affected_amounts The amount of money affected by the transaction AffectedAmounts
    adjustment_transaction_id The ID of the associated adjustment transaction (if any adjustment was involved) String
    block_id The ID of the block fund associated with the transaction String
    branch_id The ID of the branch the transaction occurred at String
    centre_id The ID of the centre the transaction occurred at String
    card_transaction The details of card transaction associated with the transaction, if applicable Transaction
    parent_account_id The ID of the parent deposit account String
    fees All the fees that have been applied or paid within this transaction Array[TransactionFee]
    interest_accrued_amounts The amount of interest accrued for Interest Applied transactions InterestAccruedAmounts
    migration_event_id The ID of the migration event associated with the deposit account if it's imported String
    notes The extra human-readable notes for the transaction String
    original_transaction_id The ID of the transaction adjusted if this is an adjustment transaction String
    payment The information of the account debited and credited Payment
    order_id The ID of the payment order String
    tax_rate The rate of tax applied to the transaction Float(64)
    terms The terms of the transaction DepositTerm
    till_id The ID of the till associated with this transaction String
    channel_id The ID of the associated transaction channel String
    transfer_details The details of the transfer TransferDetails
    type The type of deposit transaction DepositType
    create_time The time of creation of the transaction Timestamp
    book_time The time when the transaction is logged into accounting Timestamp
    value_time The time when the transaction is executed Timestamp

CreateFee

POST /v1/deposits/{AccountID}:applyFee

Creates a new fee transaction for the account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to create the transaction for String
Request Body (NewDepositFee)
Name Description Type
transaction_id The ID of the transaction String
fee_id The ID of the fee that was predefined that this transaction is based on String
amount The value of the transaction Amount
notes Extra user-readable details about the current transaction String
book_time The time when the transaction is logged into accounting Timestamp
  • Name Description Type
    transaction_id The ID of the deposit transaction String
    user_id The ID of the user performing the transaction String
    total_change The total amount of balance changed in the transaction Amount
    affected_amounts The amount of money affected by the transaction AffectedAmounts
    adjustment_transaction_id The ID of the associated adjustment transaction (if any adjustment was involved) String
    block_id The ID of the block fund associated with the transaction String
    branch_id The ID of the branch the transaction occurred at String
    centre_id The ID of the centre the transaction occurred at String
    card_transaction The details of card transaction associated with the transaction, if applicable Transaction
    parent_account_id The ID of the parent deposit account String
    fees All the fees that have been applied or paid within this transaction Array[TransactionFee]
    interest_accrued_amounts The amount of interest accrued for Interest Applied transactions InterestAccruedAmounts
    migration_event_id The ID of the migration event associated with the deposit account if it's imported String
    notes The extra human-readable notes for the transaction String
    original_transaction_id The ID of the transaction adjusted if this is an adjustment transaction String
    payment The information of the account debited and credited Payment
    order_id The ID of the payment order String
    tax_rate The rate of tax applied to the transaction Float(64)
    terms The terms of the transaction DepositTerm
    till_id The ID of the till associated with this transaction String
    channel_id The ID of the associated transaction channel String
    transfer_details The details of the transfer TransferDetails
    type The type of deposit transaction DepositType
    create_time The time of creation of the transaction Timestamp
    book_time The time when the transaction is logged into accounting Timestamp
    value_time The time when the transaction is executed Timestamp

CreateSeizure

POST /v1/deposits/{AccountID}:seize

Creates a new seizure block for the account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to create the seizure block for String
Request Body (NewSeizeBlock)
Name Description Type
seize_id The ID of the seize block String
block_id The ID of the block fund to seize String
channel_id The ID of the transaction channel String
amount The amount to seize Amount
notes The extra human-readable notes for the seize String
  • Name Description Type
    transaction_id The ID of the deposit transaction String
    user_id The ID of the user performing the transaction String
    total_change The total amount of balance changed in the transaction Amount
    affected_amounts The amount of money affected by the transaction AffectedAmounts
    adjustment_transaction_id The ID of the associated adjustment transaction (if any adjustment was involved) String
    block_id The ID of the block fund associated with the transaction String
    branch_id The ID of the branch the transaction occurred at String
    centre_id The ID of the centre the transaction occurred at String
    card_transaction The details of card transaction associated with the transaction, if applicable Transaction
    parent_account_id The ID of the parent deposit account String
    fees All the fees that have been applied or paid within this transaction Array[TransactionFee]
    interest_accrued_amounts The amount of interest accrued for Interest Applied transactions InterestAccruedAmounts
    migration_event_id The ID of the migration event associated with the deposit account if it's imported String
    notes The extra human-readable notes for the transaction String
    original_transaction_id The ID of the transaction adjusted if this is an adjustment transaction String
    payment The information of the account debited and credited Payment
    order_id The ID of the payment order String
    tax_rate The rate of tax applied to the transaction Float(64)
    terms The terms of the transaction DepositTerm
    till_id The ID of the till associated with this transaction String
    channel_id The ID of the associated transaction channel String
    transfer_details The details of the transfer TransferDetails
    type The type of deposit transaction DepositType
    create_time The time of creation of the transaction Timestamp
    book_time The time when the transaction is logged into accounting Timestamp
    value_time The time when the transaction is executed Timestamp

CreateTransfer

POST /v1/deposits/{AccountID}:transfer

Creates a new transfer transaction for the account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to create the transaction for String
Request Body (NewTransferTransaction)
Name Description Type
transaction_id The ID of the transaction String
amount The amount to transfer Amount
notes The extra human-readable notes for the transaction String
payment The information of the account debited and credited Payment
order_id The ID of the payment order String
book_time The time when the transaction is logged into accounting Timestamp
value_time The time when the transaction is executed Timestamp
  • Name Description Type
    transaction_id The ID of the deposit transaction String
    user_id The ID of the user performing the transaction String
    total_change The total amount of balance changed in the transaction Amount
    affected_amounts The amount of money affected by the transaction AffectedAmounts
    adjustment_transaction_id The ID of the associated adjustment transaction (if any adjustment was involved) String
    block_id The ID of the block fund associated with the transaction String
    branch_id The ID of the branch the transaction occurred at String
    centre_id The ID of the centre the transaction occurred at String
    card_transaction The details of card transaction associated with the transaction, if applicable Transaction
    parent_account_id The ID of the parent deposit account String
    fees All the fees that have been applied or paid within this transaction Array[TransactionFee]
    interest_accrued_amounts The amount of interest accrued for Interest Applied transactions InterestAccruedAmounts
    migration_event_id The ID of the migration event associated with the deposit account if it's imported String
    notes The extra human-readable notes for the transaction String
    original_transaction_id The ID of the transaction adjusted if this is an adjustment transaction String
    payment The information of the account debited and credited Payment
    order_id The ID of the payment order String
    tax_rate The rate of tax applied to the transaction Float(64)
    terms The terms of the transaction DepositTerm
    till_id The ID of the till associated with this transaction String
    channel_id The ID of the associated transaction channel String
    transfer_details The details of the transfer TransferDetails
    type The type of deposit transaction DepositType
    create_time The time of creation of the transaction Timestamp
    book_time The time when the transaction is logged into accounting Timestamp
    value_time The time when the transaction is executed Timestamp

CreateWithdrawal

POST /v1/deposits/{AccountID}:withdraw

Creates a new withdrawal transaction for the account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the loan account String
Request Body (NewWithdrawal)
Name Description Type
amount The value of the transaction Amount
external_id The user-provided ID of the transaction, must be globally unique String
notes Extra user-readable details about the current transaction String
payment The details of a payment Payment
order_id The ID of the payment order of the withdrawal transaction String
channel_id The ID of the payment channel String
book_time The time when the transaction is logged into accounting Timestamp
value_time The time where the transaction should be applied Timestamp
  • Name Description Type
    transaction_id The ID of the deposit transaction String
    user_id The ID of the user performing the transaction String
    total_change The total amount of balance changed in the transaction Amount
    affected_amounts The amount of money affected by the transaction AffectedAmounts
    adjustment_transaction_id The ID of the associated adjustment transaction (if any adjustment was involved) String
    block_id The ID of the block fund associated with the transaction String
    branch_id The ID of the branch the transaction occurred at String
    centre_id The ID of the centre the transaction occurred at String
    card_transaction The details of card transaction associated with the transaction, if applicable Transaction
    parent_account_id The ID of the parent deposit account String
    fees All the fees that have been applied or paid within this transaction Array[TransactionFee]
    interest_accrued_amounts The amount of interest accrued for Interest Applied transactions InterestAccruedAmounts
    migration_event_id The ID of the migration event associated with the deposit account if it's imported String
    notes The extra human-readable notes for the transaction String
    original_transaction_id The ID of the transaction adjusted if this is an adjustment transaction String
    payment The information of the account debited and credited Payment
    order_id The ID of the payment order String
    tax_rate The rate of tax applied to the transaction Float(64)
    terms The terms of the transaction DepositTerm
    till_id The ID of the till associated with this transaction String
    channel_id The ID of the associated transaction channel String
    transfer_details The details of the transfer TransferDetails
    type The type of deposit transaction DepositType
    create_time The time of creation of the transaction Timestamp
    book_time The time when the transaction is logged into accounting Timestamp
    value_time The time when the transaction is executed Timestamp

ListDepositTransactions

GET /v1/deposits/{AccountID}/transactions

Lists deposit transactions..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to retrieve the transactions for String
page_token The page token to use for the next page String
page_size The number of accounts to return Integer
filter The filter to apply to the list String
order_by The field to order the list by String
  • Name Description Type
    total The total number of deposit transactions matching the filter Integer
    remaining The number of deposit transactions remaining in the list, including the deposit transactions in the response Integer
    transactions The list of deposit transactions retrieved Array[DepositTransaction]
    next_page_token The page token for the next page String

GetDepositTransaction

GET /v1/deposits/{AccountID}/transactions/{TransactionID}

Retrieves a deposit transaction..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to retrieve the transaction for String
transaction_id The id of deposit transaction to retrieve String
  • Name Description Type
    transaction_id The ID of the deposit transaction String
    user_id The ID of the user performing the transaction String
    total_change The total amount of balance changed in the transaction Amount
    affected_amounts The amount of money affected by the transaction AffectedAmounts
    adjustment_transaction_id The ID of the associated adjustment transaction (if any adjustment was involved) String
    block_id The ID of the block fund associated with the transaction String
    branch_id The ID of the branch the transaction occurred at String
    centre_id The ID of the centre the transaction occurred at String
    card_transaction The details of card transaction associated with the transaction, if applicable Transaction
    parent_account_id The ID of the parent deposit account String
    fees All the fees that have been applied or paid within this transaction Array[TransactionFee]
    interest_accrued_amounts The amount of interest accrued for Interest Applied transactions InterestAccruedAmounts
    migration_event_id The ID of the migration event associated with the deposit account if it's imported String
    notes The extra human-readable notes for the transaction String
    original_transaction_id The ID of the transaction adjusted if this is an adjustment transaction String
    payment The information of the account debited and credited Payment
    order_id The ID of the payment order String
    tax_rate The rate of tax applied to the transaction Float(64)
    terms The terms of the transaction DepositTerm
    till_id The ID of the till associated with this transaction String
    channel_id The ID of the associated transaction channel String
    transfer_details The details of the transfer TransferDetails
    type The type of deposit transaction DepositType
    create_time The time of creation of the transaction Timestamp
    book_time The time when the transaction is logged into accounting Timestamp
    value_time The time when the transaction is executed Timestamp

Adjust

POST /v1/deposits/{AccountID}/transactions/{TransactionID}:adjust

Adjusts a deposit transaction..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to adjust the transaction for String
transaction_id The ID of the transaction to adjust String
Request Body (NewDepositAdjustment)
Name Description Type
book_time The time when the transaction is logged into accounting Timestamp
notes The extra human-readable notes for the adjustment String
  • Name Description Type
    transaction_id The ID of the deposit transaction String
    user_id The ID of the user performing the transaction String
    total_change The total amount of balance changed in the transaction Amount
    affected_amounts The amount of money affected by the transaction AffectedAmounts
    adjustment_transaction_id The ID of the associated adjustment transaction (if any adjustment was involved) String
    block_id The ID of the block fund associated with the transaction String
    branch_id The ID of the branch the transaction occurred at String
    centre_id The ID of the centre the transaction occurred at String
    card_transaction The details of card transaction associated with the transaction, if applicable Transaction
    parent_account_id The ID of the parent deposit account String
    fees All the fees that have been applied or paid within this transaction Array[TransactionFee]
    interest_accrued_amounts The amount of interest accrued for Interest Applied transactions InterestAccruedAmounts
    migration_event_id The ID of the migration event associated with the deposit account if it's imported String
    notes The extra human-readable notes for the transaction String
    original_transaction_id The ID of the transaction adjusted if this is an adjustment transaction String
    payment The information of the account debited and credited Payment
    order_id The ID of the payment order String
    tax_rate The rate of tax applied to the transaction Float(64)
    terms The terms of the transaction DepositTerm
    till_id The ID of the till associated with this transaction String
    channel_id The ID of the associated transaction channel String
    transfer_details The details of the transfer TransferDetails
    type The type of deposit transaction DepositType
    create_time The time of creation of the transaction Timestamp
    book_time The time when the transaction is logged into accounting Timestamp
    value_time The time when the transaction is executed Timestamp

GetDocument

GET /v1/deposits/{AccountID}/transactions/{TransactionID}/documents/{TemplateID}

Retrieves a document for the transaction..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to retrieve the document for String
transaction_id The ID of the transaction String
template_id The ID of the template to use to generate the document String
  • Name Description Type
    content The raw content of the file encoded in base64 Bytes

CreateDisbursement

POST /v1/loans/{AccountID}:disburse

Creates a disbursement on a loan account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the loan account String
Request Body (NewDisbursement)
Name Description Type
amount The value of the transaction Amount
external_id The user-provided ID of the transaction, must be globally unique String
fees The list of fees associated with the transaction Array[DisbursementFee]
notes Extra user-readable details about the current transaction String
original_currency_code The code of the currency the payment is made in String
channel_id The ID of the transaction channel String
linked_account_id The ID of the account linked to the transactions String
book_time The time when the transaction is logged into accounting Timestamp
value_time The time where the transaction should be applied Timestamp
first_repay_time The time of the first repayment for the loan account Timestamp
  • Name Description Type
    transaction_id The ID of the transaction String
    user_id The ID of the user performing the transaction String
    type The type of loan transaction LoanType
    account_balances The balances changed by the transaction TransactionBalances
    adjustment_transaction_id The ID of the transaction adjusted String
    affected_amounts The amount of money affected by the transaction LoanAffectedAmounts
    amount The amount of money affected by the transaction Amount
    card_transaction The card transaction that is associated with the transaction Transaction
    branch_id The ID of the branch the transaction occurred at String
    centre_id The ID of the centre the transaction occurred at String
    custom_payment_amounts The list of custom payments made by the user Array[CustomPaymentAmount]
    fees All the fees that have been applied or paid within this transaction Array[TransactionFee]
    installment_id The ID of the installment the transaction is for String
    migration_event_id The ID of the migration event associated with the deposit account if it's imported String
    notes The extra human-readable notes for the transaction String
    original_amount The original amount of money when it was posted in a foreign currency Amount
    original_transaction_id The ID of the transaction adjusted if this is an adjustment transaciton String
    parent_account_id The ID of the parent loan account String
    parent_loan_transaction_id The ID of the parent loan transaction String
    recalculation_method The method prepayment recalculation is done CalculationMethod
    taxes The amount of taxes applied to the transaction Taxes
    terms The terms of the loan LoanTerm
    till_id The ID of the till associated with this transaction String
    channel_id The ID of the associated transaction channel String
    transfer_details The details of the transfer TransferDetails
    create_time The time of creation of the transaction Timestamp
    book_time The time when the transaction is logged into accounting Timestamp
    value_time The time when the transaction is executed Timestamp

CreateFee

POST /v1/loans/{AccountID}:applyFee

Creates a transaction that applies a fee on a loan account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the loan account String
Request Body (NewLoanFee)
Name Description Type
transaction_id The ID of the transaction String
fee_id The ID of the fee that was predefined that this transaction is based on String
amount The value of the transaction Amount
installment_number The number of the installment where the fee will be applied Integer
notes Extra user-readable details about the current transaction String
book_time The time when the transaction is logged into accounting Timestamp
value_time The time when the transaction should be applied Timestamp
  • Name Description Type
    transaction_id The ID of the transaction String
    user_id The ID of the user performing the transaction String
    type The type of loan transaction LoanType
    account_balances The balances changed by the transaction TransactionBalances
    adjustment_transaction_id The ID of the transaction adjusted String
    affected_amounts The amount of money affected by the transaction LoanAffectedAmounts
    amount The amount of money affected by the transaction Amount
    card_transaction The card transaction that is associated with the transaction Transaction
    branch_id The ID of the branch the transaction occurred at String
    centre_id The ID of the centre the transaction occurred at String
    custom_payment_amounts The list of custom payments made by the user Array[CustomPaymentAmount]
    fees All the fees that have been applied or paid within this transaction Array[TransactionFee]
    installment_id The ID of the installment the transaction is for String
    migration_event_id The ID of the migration event associated with the deposit account if it's imported String
    notes The extra human-readable notes for the transaction String
    original_amount The original amount of money when it was posted in a foreign currency Amount
    original_transaction_id The ID of the transaction adjusted if this is an adjustment transaciton String
    parent_account_id The ID of the parent loan account String
    parent_loan_transaction_id The ID of the parent loan transaction String
    recalculation_method The method prepayment recalculation is done CalculationMethod
    taxes The amount of taxes applied to the transaction Taxes
    terms The terms of the loan LoanTerm
    till_id The ID of the till associated with this transaction String
    channel_id The ID of the associated transaction channel String
    transfer_details The details of the transfer TransferDetails
    create_time The time of creation of the transaction Timestamp
    book_time The time when the transaction is logged into accounting Timestamp
    value_time The time when the transaction is executed Timestamp

CreatePayment

POST /v1/loans/{AccountID}:payment

Creates a transaction where the user has made a payment..

Parameters
Name Description Type
Query Parameters
account_id The ID of the loan account String
Request Body (NewPayment)
Name Description Type
amount The value of the transaction Amount
external_id The user-provided ID of the transaction, must be globally unique String
notes Extra user-readable details about the current transaction String
original_currency_code The code of the currency the payment is made in String
fee_id The ID of the fee that was predefined that this transaction is based on String
book_time The time when the transaction is logged into accounting Timestamp
value_time The time where the transaction should be applied Timestamp
  • Name Description Type
    transaction_id The ID of the transaction String
    user_id The ID of the user performing the transaction String
    type The type of loan transaction LoanType
    account_balances The balances changed by the transaction TransactionBalances
    adjustment_transaction_id The ID of the transaction adjusted String
    affected_amounts The amount of money affected by the transaction LoanAffectedAmounts
    amount The amount of money affected by the transaction Amount
    card_transaction The card transaction that is associated with the transaction Transaction
    branch_id The ID of the branch the transaction occurred at String
    centre_id The ID of the centre the transaction occurred at String
    custom_payment_amounts The list of custom payments made by the user Array[CustomPaymentAmount]
    fees All the fees that have been applied or paid within this transaction Array[TransactionFee]
    installment_id The ID of the installment the transaction is for String
    migration_event_id The ID of the migration event associated with the deposit account if it's imported String
    notes The extra human-readable notes for the transaction String
    original_amount The original amount of money when it was posted in a foreign currency Amount
    original_transaction_id The ID of the transaction adjusted if this is an adjustment transaciton String
    parent_account_id The ID of the parent loan account String
    parent_loan_transaction_id The ID of the parent loan transaction String
    recalculation_method The method prepayment recalculation is done CalculationMethod
    taxes The amount of taxes applied to the transaction Taxes
    terms The terms of the loan LoanTerm
    till_id The ID of the till associated with this transaction String
    channel_id The ID of the associated transaction channel String
    transfer_details The details of the transfer TransferDetails
    create_time The time of creation of the transaction Timestamp
    book_time The time when the transaction is logged into accounting Timestamp
    value_time The time when the transaction is executed Timestamp

CreateRedrawPayment

POST /v1/loans/{AccountID}:redrawPayment

Creates a transaction where the user redraws a payment..

Parameters
Name Description Type
Query Parameters
account_id The ID of the loan account String
Request Body (NewRedrawRepayment)
Name Description Type
amount The value of the transaction Amount
notes Extra user-readable details about the current transaction String
book_time The time when the transaction is logged into accounting Timestamp
value_time The time where the transaction should be applied Timestamp
  • Name Description Type
    transaction_id The ID of the transaction String
    user_id The ID of the user performing the transaction String
    type The type of loan transaction LoanType
    account_balances The balances changed by the transaction TransactionBalances
    adjustment_transaction_id The ID of the transaction adjusted String
    affected_amounts The amount of money affected by the transaction LoanAffectedAmounts
    amount The amount of money affected by the transaction Amount
    card_transaction The card transaction that is associated with the transaction Transaction
    branch_id The ID of the branch the transaction occurred at String
    centre_id The ID of the centre the transaction occurred at String
    custom_payment_amounts The list of custom payments made by the user Array[CustomPaymentAmount]
    fees All the fees that have been applied or paid within this transaction Array[TransactionFee]
    installment_id The ID of the installment the transaction is for String
    migration_event_id The ID of the migration event associated with the deposit account if it's imported String
    notes The extra human-readable notes for the transaction String
    original_amount The original amount of money when it was posted in a foreign currency Amount
    original_transaction_id The ID of the transaction adjusted if this is an adjustment transaciton String
    parent_account_id The ID of the parent loan account String
    parent_loan_transaction_id The ID of the parent loan transaction String
    recalculation_method The method prepayment recalculation is done CalculationMethod
    taxes The amount of taxes applied to the transaction Taxes
    terms The terms of the loan LoanTerm
    till_id The ID of the till associated with this transaction String
    channel_id The ID of the associated transaction channel String
    transfer_details The details of the transfer TransferDetails
    create_time The time of creation of the transaction Timestamp
    book_time The time when the transaction is logged into accounting Timestamp
    value_time The time when the transaction is executed Timestamp

CreateRepayment

POST /v1/loans/{AccountID}:repayment

Creates a transaction where the user repays an installment..

Parameters
Name Description Type
Query Parameters
account_id The ID of the loan account String
Request Body (NewRepayment)
Name Description Type
amount The value of the transaction Amount
notes Extra user-readable details about the current transaction String
custom_payment_amounts A list of payments the user has made Array[CustomPaymentAmount]
external_id The user-provided ID of the transaction, must be globally unique String
installment_id The ID of the installment associated with this transaction String
original_currency_code The code of the currency the payment is made in String
calculation_method The method of prepayment recalculation CalculationMethod
channel_id The ID of the transaction channel String
book_time The time when the transaction is logged into accounting Timestamp
value_time The time where the transaction should be applied Timestamp
  • Name Description Type
    transaction_id The ID of the transaction String
    user_id The ID of the user performing the transaction String
    type The type of loan transaction LoanType
    account_balances The balances changed by the transaction TransactionBalances
    adjustment_transaction_id The ID of the transaction adjusted String
    affected_amounts The amount of money affected by the transaction LoanAffectedAmounts
    amount The amount of money affected by the transaction Amount
    card_transaction The card transaction that is associated with the transaction Transaction
    branch_id The ID of the branch the transaction occurred at String
    centre_id The ID of the centre the transaction occurred at String
    custom_payment_amounts The list of custom payments made by the user Array[CustomPaymentAmount]
    fees All the fees that have been applied or paid within this transaction Array[TransactionFee]
    installment_id The ID of the installment the transaction is for String
    migration_event_id The ID of the migration event associated with the deposit account if it's imported String
    notes The extra human-readable notes for the transaction String
    original_amount The original amount of money when it was posted in a foreign currency Amount
    original_transaction_id The ID of the transaction adjusted if this is an adjustment transaciton String
    parent_account_id The ID of the parent loan account String
    parent_loan_transaction_id The ID of the parent loan transaction String
    recalculation_method The method prepayment recalculation is done CalculationMethod
    taxes The amount of taxes applied to the transaction Taxes
    terms The terms of the loan LoanTerm
    till_id The ID of the till associated with this transaction String
    channel_id The ID of the associated transaction channel String
    transfer_details The details of the transfer TransferDetails
    create_time The time of creation of the transaction Timestamp
    book_time The time when the transaction is logged into accounting Timestamp
    value_time The time when the transaction is executed Timestamp

CreateWithdrawal

POST /v1/loans/{AccountID}:withdraw

Creates a transaction where the user withdraws their balance..

Parameters
Name Description Type
Query Parameters
account_id The ID of the loan account String
Request Body (NewWithdrawal)
Name Description Type
amount The value of the transaction Amount
external_id The user-provided ID of the transaction, must be globally unique String
notes Extra user-readable details about the current transaction String
payment The details of a payment Payment
order_id The ID of the payment order of the withdrawal transaction String
channel_id The ID of the payment channel String
book_time The time when the transaction is logged into accounting Timestamp
value_time The time where the transaction should be applied Timestamp
  • Name Description Type
    transaction_id The ID of the transaction String
    user_id The ID of the user performing the transaction String
    type The type of loan transaction LoanType
    account_balances The balances changed by the transaction TransactionBalances
    adjustment_transaction_id The ID of the transaction adjusted String
    affected_amounts The amount of money affected by the transaction LoanAffectedAmounts
    amount The amount of money affected by the transaction Amount
    card_transaction The card transaction that is associated with the transaction Transaction
    branch_id The ID of the branch the transaction occurred at String
    centre_id The ID of the centre the transaction occurred at String
    custom_payment_amounts The list of custom payments made by the user Array[CustomPaymentAmount]
    fees All the fees that have been applied or paid within this transaction Array[TransactionFee]
    installment_id The ID of the installment the transaction is for String
    migration_event_id The ID of the migration event associated with the deposit account if it's imported String
    notes The extra human-readable notes for the transaction String
    original_amount The original amount of money when it was posted in a foreign currency Amount
    original_transaction_id The ID of the transaction adjusted if this is an adjustment transaciton String
    parent_account_id The ID of the parent loan account String
    parent_loan_transaction_id The ID of the parent loan transaction String
    recalculation_method The method prepayment recalculation is done CalculationMethod
    taxes The amount of taxes applied to the transaction Taxes
    terms The terms of the loan LoanTerm
    till_id The ID of the till associated with this transaction String
    channel_id The ID of the associated transaction channel String
    transfer_details The details of the transfer TransferDetails
    create_time The time of creation of the transaction Timestamp
    book_time The time when the transaction is logged into accounting Timestamp
    value_time The time when the transaction is executed Timestamp

CreateWithdrawalRedraw

POST /v1/loans/{AccountID}:redrawWithdrawal

Creates a transaction where the user withdraws from their redraw balance..

Parameters
Name Description Type
Query Parameters
account_id The ID of the loan account String
Request Body (NewWithdrawalRedraw)
Name Description Type
amount The value of the transaction Amount
external_id The user-provided ID of the transaction, must be globally unique String
notes Extra user-readable details about the current transaction String
original_currency_code The code of the currency the payment is made in String
channel_id The ID of the transaction channel String
book_time The time when the transaction is logged into accounting Timestamp
value_time The time where the transaction should be applied Timestamp
  • Name Description Type
    transaction_id The ID of the transaction String
    user_id The ID of the user performing the transaction String
    type The type of loan transaction LoanType
    account_balances The balances changed by the transaction TransactionBalances
    adjustment_transaction_id The ID of the transaction adjusted String
    affected_amounts The amount of money affected by the transaction LoanAffectedAmounts
    amount The amount of money affected by the transaction Amount
    card_transaction The card transaction that is associated with the transaction Transaction
    branch_id The ID of the branch the transaction occurred at String
    centre_id The ID of the centre the transaction occurred at String
    custom_payment_amounts The list of custom payments made by the user Array[CustomPaymentAmount]
    fees All the fees that have been applied or paid within this transaction Array[TransactionFee]
    installment_id The ID of the installment the transaction is for String
    migration_event_id The ID of the migration event associated with the deposit account if it's imported String
    notes The extra human-readable notes for the transaction String
    original_amount The original amount of money when it was posted in a foreign currency Amount
    original_transaction_id The ID of the transaction adjusted if this is an adjustment transaciton String
    parent_account_id The ID of the parent loan account String
    parent_loan_transaction_id The ID of the parent loan transaction String
    recalculation_method The method prepayment recalculation is done CalculationMethod
    taxes The amount of taxes applied to the transaction Taxes
    terms The terms of the loan LoanTerm
    till_id The ID of the till associated with this transaction String
    channel_id The ID of the associated transaction channel String
    transfer_details The details of the transfer TransferDetails
    create_time The time of creation of the transaction Timestamp
    book_time The time when the transaction is logged into accounting Timestamp
    value_time The time when the transaction is executed Timestamp

ListLoanTransactions

GET /v1/loans/{AccountID}/transactions

Lists loan transactions..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to retrieve the transactions for String
page_token The page token to use for the next page String
page_size The number of accounts to return Integer
filter The filter to apply to the list String
order_by The field to order the list by String
  • Name Description Type
    total The total number of loan transactions matching the filter Integer
    remaining The number of loan transactions remaining in the list, including the loan transactions in the response Integer
    transactions The list of loan transactions retrieved Array[LoanTransaction]
    next_page_token The page token for the next page String

GetLoanTransaction

GET /v1/loans/{AccountID}/transactions/{TransactionID}

Retrieves a loan transaction..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to retrieve the transaction for String
transaction_id The id of loan transaction to retrieve String
  • Name Description Type
    transaction_id The ID of the transaction String
    user_id The ID of the user performing the transaction String
    type The type of loan transaction LoanType
    account_balances The balances changed by the transaction TransactionBalances
    adjustment_transaction_id The ID of the transaction adjusted String
    affected_amounts The amount of money affected by the transaction LoanAffectedAmounts
    amount The amount of money affected by the transaction Amount
    card_transaction The card transaction that is associated with the transaction Transaction
    branch_id The ID of the branch the transaction occurred at String
    centre_id The ID of the centre the transaction occurred at String
    custom_payment_amounts The list of custom payments made by the user Array[CustomPaymentAmount]
    fees All the fees that have been applied or paid within this transaction Array[TransactionFee]
    installment_id The ID of the installment the transaction is for String
    migration_event_id The ID of the migration event associated with the deposit account if it's imported String
    notes The extra human-readable notes for the transaction String
    original_amount The original amount of money when it was posted in a foreign currency Amount
    original_transaction_id The ID of the transaction adjusted if this is an adjustment transaciton String
    parent_account_id The ID of the parent loan account String
    parent_loan_transaction_id The ID of the parent loan transaction String
    recalculation_method The method prepayment recalculation is done CalculationMethod
    taxes The amount of taxes applied to the transaction Taxes
    terms The terms of the loan LoanTerm
    till_id The ID of the till associated with this transaction String
    channel_id The ID of the associated transaction channel String
    transfer_details The details of the transfer TransferDetails
    create_time The time of creation of the transaction Timestamp
    book_time The time when the transaction is logged into accounting Timestamp
    value_time The time when the transaction is executed Timestamp

Adjust

POST /v1/loans/{AccountID}/transactions/{TransactionID}:adjust

Adjusts a loan transaction..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to adjust the transaction for String
transaction_id The ID of the transaction to adjust String
Request Body (NewLoanAdjustment)
Name Description Type
book_time The time when the adjustment transaction is logged into accounting Timestamp
installments The new list of installments to be added Array[NewInstallment]
reason A user-provided string that explains why a loan was adjusted String
  • Name Description Type
    transaction_id The ID of the transaction String
    user_id The ID of the user performing the transaction String
    type The type of loan transaction LoanType
    account_balances The balances changed by the transaction TransactionBalances
    adjustment_transaction_id The ID of the transaction adjusted String
    affected_amounts The amount of money affected by the transaction LoanAffectedAmounts
    amount The amount of money affected by the transaction Amount
    card_transaction The card transaction that is associated with the transaction Transaction
    branch_id The ID of the branch the transaction occurred at String
    centre_id The ID of the centre the transaction occurred at String
    custom_payment_amounts The list of custom payments made by the user Array[CustomPaymentAmount]
    fees All the fees that have been applied or paid within this transaction Array[TransactionFee]
    installment_id The ID of the installment the transaction is for String
    migration_event_id The ID of the migration event associated with the deposit account if it's imported String
    notes The extra human-readable notes for the transaction String
    original_amount The original amount of money when it was posted in a foreign currency Amount
    original_transaction_id The ID of the transaction adjusted if this is an adjustment transaciton String
    parent_account_id The ID of the parent loan account String
    parent_loan_transaction_id The ID of the parent loan transaction String
    recalculation_method The method prepayment recalculation is done CalculationMethod
    taxes The amount of taxes applied to the transaction Taxes
    terms The terms of the loan LoanTerm
    till_id The ID of the till associated with this transaction String
    channel_id The ID of the associated transaction channel String
    transfer_details The details of the transfer TransferDetails
    create_time The time of creation of the transaction Timestamp
    book_time The time when the transaction is logged into accounting Timestamp
    value_time The time when the transaction is executed Timestamp

BULKS

Package bulks provides functionality to query bulk transactions.

GetBulks

GET /v1/bulks/{BulksID}

Gets the status for a bulk process..

Parameters
Name Description Type
Query Parameters
bulks_id The identifier of the bulk process String
  • Name Description Type
    processed A list of successfully processed items Array[ProcessSuccess]
    errors A list of errors that occurred during processing Array[ProcessError]
    state The state of the bulk processes Status

AffectedAmounts

The amounts affected by the transaction broken down..

Name Description Type
fees The amount of fees in the transaction Amount
fraction The fraction amount bought from another investor in the case of LOAN_FRACTION_BOUGHT Float(64)
funds The amount of balance change involved in a transaction that affects an account with positive balance Amount
interest The amount of interest involved in a transaction that affects an account with positive balance Amount
overdraft The amount of money that was added/subtracted from the account by this transaction as overdraft Amount
overdraft_fees The amount of fees in the transaction due to an overdraft Amount
overdraft_interest The amount of interest in the transaction due to an overdraft Amount
technical_overdraft The amount of money that was added/subtracted as technical overdraft Amount
technical_overdraft_interest The amount of money that was added/subtracted as technical overdraft interest Amount

BulkDepositTransaction

A transaction in a bulk operation..

Name Description Type
transaction_id The ID of the transaction String
account_id The ID of the account String
amount The amount to deposit Amount
notes The extra human-readable notes for the transaction String
payment The information of the account debited and credited Payment
order_id The ID of the payment order String
skip_validation A flag that disables maximum balance checks Boolean
channel_id The ID of the transaction channel String

BulkDepositTransactions

A list of bulk deposit transactions..

Name Description Type
transactions A list of bulk deposit transactions Array[BulkDepositTransaction]

CalculationMethod

The type of calculation to be done..

Name Description
NoRecalculation
RescheduleRemainingRepayments
RecalculateScheduleKeepSameNumberOfTerms
RecalculateScheduleKeepSamePrincipalAmount
RecalculateScheduleKeepSameTotalRepaymentAmount
ReduceAmountPerInstallment
ReduceNumberOfInstallments
ReduceNumberOfInstallmentsNew

CustomPaymentAmount

One instance of custom payment..

Name Description Type
type The type of the payment PaymentType
fee_id The ID of the predefined fee String
amount The amount of payment paid in the transaction Amount
tax_on_amount The amount of taxes paid in the transaction Amount

DepositTerm

The terms of the deposit transaction..

Name Description Type
interest_rate The interest rate that was set or changed in this transaction Float(64)
index_interest_rate The index interest rate that was set or changed in this transaction Float(64)
overdraft_limit The deposit overdraft limit Amount

DepositTransaction

A transaction performed on a deposit account..

Name Description Type
transaction_id The ID of the deposit transaction String
user_id The ID of the user performing the transaction String
total_change The total amount of balance changed in the transaction Amount
affected_amounts The amount of money affected by the transaction AffectedAmounts
adjustment_transaction_id The ID of the associated adjustment transaction (if any adjustment was involved) String
block_id The ID of the block fund associated with the transaction String
branch_id The ID of the branch the transaction occurred at String
centre_id The ID of the centre the transaction occurred at String
card_transaction The details of card transaction associated with the transaction, if applicable Transaction
parent_account_id The ID of the parent deposit account String
fees All the fees that have been applied or paid within this transaction Array[TransactionFee]
interest_accrued_amounts The amount of interest accrued for Interest Applied transactions InterestAccruedAmounts
migration_event_id The ID of the migration event associated with the deposit account if it's imported String
notes The extra human-readable notes for the transaction String
original_transaction_id The ID of the transaction adjusted if this is an adjustment transaction String
payment The information of the account debited and credited Payment
order_id The ID of the payment order String
tax_rate The rate of tax applied to the transaction Float(64)
terms The terms of the transaction DepositTerm
till_id The ID of the till associated with this transaction String
channel_id The ID of the associated transaction channel String
transfer_details The details of the transfer TransferDetails
type The type of deposit transaction DepositType
create_time The time of creation of the transaction Timestamp
book_time The time when the transaction is logged into accounting Timestamp
value_time The time when the transaction is executed Timestamp

DepositType

The type of the deposit transaction..

Name Description
DepositImport
DepositWriteOff
DepositWriteOffAdjustment
DepositDeposit
DepositAdjustment
DepositWithdrawal
DepositWithdrawalAdjustment
DepositCardTransactionReversal
DepositCardTransactionReversalAdjustment
DepositTransfer
DepositTransferAdjustment
DepositFeeApplied
DepositFeeAdjusted
DepositFeesDueReduced
DepositInterestApplied
DepositInterestAppliedAdjustment
DepositFeeReductionAdjustment
DepositWithholdingTax
DepositWithholdingTaxAdjustment
DepositInterestRateChanged
DepositOverdraftInterestRateChanged
DepositOverdraftLimitChanged
DepositBranchChanged
DepositLoanFunded
DepositLoanFundedAdjustment
DepositLoanRepaid
DepositLoanRepaidAdjustment
DepositLoanFractionBought
DepositLoanFractionBoughtAdjustment
DepositLoanFractionSold
DepositLoanFractionSoldAdjustment
DepositSeizedAmount

DisbursementFee

The amount of fees applied from a disbursement..

Name Description Type
fee_id The ID of the predefined fee String
amount The amount of fees to apply Amount

InterestAccruedAmounts

The amount of accrued interest for an Interest Applied deposit transaction..

Name Description Type
accrued The amount of positive interest accrued since last interest application/activation date and applied Amount
negative_accrued The amount of negative interest accrued since last interest application/activation date and applied Amount
overdraft_accrued The amount of overdraft interest accrued since last interest application/activation date and applied Amount
technical_overdraft_accrued The amount of technical overdraft interest accrued since last interest application/activation date and applied Amount

LoanAffectedAmounts

A collection of amounts affected by the loan transaction..

Name Description Type
deferred_interest The amount of pre-paid interest added/removed Amount
fees The amount of fees added/removed Amount
funders_interest The amount of interest given to investors, in P2P products Amount
organization_commission The amount of interest paid to the organization, in P2P products Amount
interest The amount of interest added/removed Amount
interest_from_arrears The amount of interest from arrears Amount
payment_holidays_interest The amount of Payment Holidays interest was added/removed in account Amount
penalty The amount of penalties added/removed from the account Amount
principal The amount of principal added/removed Amount

LoanTerm

The terms of the loan..

Name Description Type
interest_settings The settings for the interests and holds all the properties regarding interests TransactionInterestSettings
periodic_payment The last known periodic payment value Amount
principal_payment_amount The last known principal payment flat amount Amount
principal_payment_percentage The last known principal payment percentage Float(64)

LoanTransaction

A transaction on a loan account..

Name Description Type
transaction_id The ID of the transaction String
user_id The ID of the user performing the transaction String
type The type of loan transaction LoanType
account_balances The balances changed by the transaction TransactionBalances
adjustment_transaction_id The ID of the transaction adjusted String
affected_amounts The amount of money affected by the transaction LoanAffectedAmounts
amount The amount of money affected by the transaction Amount
card_transaction The card transaction that is associated with the transaction Transaction
branch_id The ID of the branch the transaction occurred at String
centre_id The ID of the centre the transaction occurred at String
custom_payment_amounts The list of custom payments made by the user Array[CustomPaymentAmount]
fees All the fees that have been applied or paid within this transaction Array[TransactionFee]
installment_id The ID of the installment the transaction is for String
migration_event_id The ID of the migration event associated with the deposit account if it's imported String
notes The extra human-readable notes for the transaction String
original_amount The original amount of money when it was posted in a foreign currency Amount
original_transaction_id The ID of the transaction adjusted if this is an adjustment transaciton String
parent_account_id The ID of the parent loan account String
parent_loan_transaction_id The ID of the parent loan transaction String
recalculation_method The method prepayment recalculation is done CalculationMethod
taxes The amount of taxes applied to the transaction Taxes
terms The terms of the loan LoanTerm
till_id The ID of the till associated with this transaction String
channel_id The ID of the associated transaction channel String
transfer_details The details of the transfer TransferDetails
create_time The time of creation of the transaction Timestamp
book_time The time when the transaction is logged into accounting Timestamp
value_time The time when the transaction is executed Timestamp

LoanType

The type of loan..

Name Description
LoanImport
LoanDisbursement
LoanDisbursementAdjustment
LoanWriteOff
LoanWriteOffAdjustment
LoanRepayment
LoanPaymentMade
LoanWithdrawalRedraw
LoanWithdrawalRedrawAdjustment
LoanFeeApplied
LoanFeeCharged
LoanFeesDueReduced
LoanFeeAdjustment
LoanPenaltyApplied
LoanPenaltyAdjustment
LoanPenaltiesDueReduced
LoanRepaymentAdjustment
LoanPaymentMadeAdjustment
LoanInterestRateChanged
LoanTaxRateChanged
LoanPenaltyRateChanged
LoanInterestApplied
LoanInterestAppliedAdjustment
LoanInterestDueReduced
LoanPenaltyReductionAdjustment
LoanFeeReductionAdjustment
LoanInterestReductionAdjustment
LoanDeferredInterestApplied
LoanDeferredInterestAppliedAdjustment
LoanDeferredInterestPaid
LoanDeferredInterestPaidAdjustment
LoanRedrawTransfer
LoanRedrawRepayment
LoanRedrawTransferAdjustment
LoanRedrawRepaymentAdjustment
LoanTransfer
LoanTransferAdjustment
LoanBranchChanged
LoanTermsChanged
LoanCardTransactionReversal
LoanCardTransactionReversalAdjustment
LoanDueDateChanged
LoanDueDateChangedAdjustment
LoanAccountTerminated
LoanAccountTerminatedAdjustment

NewDepositAdjustment

The details of the deposit adjustment to make..

Name Description Type
book_time The time when the transaction is logged into accounting Timestamp
notes The extra human-readable notes for the adjustment String

NewDepositFee

The data of a new fee transaction..

Name Description Type
transaction_id The ID of the transaction String
fee_id The ID of the fee that was predefined that this transaction is based on String
amount The value of the transaction Amount
notes Extra user-readable details about the current transaction String
book_time The time when the transaction is logged into accounting Timestamp

NewDepositTransaction

The data of a new deposit transaction..

Name Description Type
transaction_id The ID of the transaction String
amount The amount deposited Amount
notes The extra human-readable notes for the transaction String
payment The information of the account debited and credited Payment
order_id The ID of the payment order String
skip_validation A flag that disables maximum balance checks Boolean
channel_id The ID of the transaction channel String
book_time The time when the transaction is logged into accounting Timestamp
value_time The time when the transaction is executed Timestamp

NewDisbursement

The request body to create a transaction of type DISBURSEMENT..

Name Description Type
amount The value of the transaction Amount
external_id The user-provided ID of the transaction, must be globally unique String
fees The list of fees associated with the transaction Array[DisbursementFee]
notes Extra user-readable details about the current transaction String
original_currency_code The code of the currency the payment is made in String
channel_id The ID of the transaction channel String
linked_account_id The ID of the account linked to the transactions String
book_time The time when the transaction is logged into accounting Timestamp
value_time The time where the transaction should be applied Timestamp
first_repay_time The time of the first repayment for the loan account Timestamp

NewInstallment

The details of a new loan installment..

Name Description Type
installment_id The ID of the installment String
amount_to_add The amount to add to the due amount Amount

NewLoanAdjustment

The request body to adjust a loan..

Name Description Type
book_time The time when the adjustment transaction is logged into accounting Timestamp
installments The new list of installments to be added Array[NewInstallment]
reason A user-provided string that explains why a loan was adjusted String

NewLoanFee

The request body to create a loan transaction of type FEE_APPLIED..

Name Description Type
transaction_id The ID of the transaction String
fee_id The ID of the fee that was predefined that this transaction is based on String
amount The value of the transaction Amount
installment_number The number of the installment where the fee will be applied Integer
notes Extra user-readable details about the current transaction String
book_time The time when the transaction is logged into accounting Timestamp
value_time The time when the transaction should be applied Timestamp

NewPayment

The request body to create a transaction of type PAYMENT_MADE..

Name Description Type
amount The value of the transaction Amount
external_id The user-provided ID of the transaction, must be globally unique String
notes Extra user-readable details about the current transaction String
original_currency_code The code of the currency the payment is made in String
fee_id The ID of the fee that was predefined that this transaction is based on String
book_time The time when the transaction is logged into accounting Timestamp
value_time The time where the transaction should be applied Timestamp

NewRedrawRepayment

The request body to create a transaction of type REDRAW_PAYMENT..

Name Description Type
amount The value of the transaction Amount
notes Extra user-readable details about the current transaction String
book_time The time when the transaction is logged into accounting Timestamp
value_time The time where the transaction should be applied Timestamp

NewRepayment

The request body to create a transaction of type REPAYMENT..

Name Description Type
amount The value of the transaction Amount
notes Extra user-readable details about the current transaction String
custom_payment_amounts A list of payments the user has made Array[CustomPaymentAmount]
external_id The user-provided ID of the transaction, must be globally unique String
installment_id The ID of the installment associated with this transaction String
original_currency_code The code of the currency the payment is made in String
calculation_method The method of prepayment recalculation CalculationMethod
channel_id The ID of the transaction channel String
book_time The time when the transaction is logged into accounting Timestamp
value_time The time where the transaction should be applied Timestamp

NewSeizeBlock

The data of a new seize block..

Name Description Type
seize_id The ID of the seize block String
block_id The ID of the block fund to seize String
channel_id The ID of the transaction channel String
amount The amount to seize Amount
notes The extra human-readable notes for the seize String

NewTransferTransaction

The data of a new transfer transaction..

Name Description Type
transaction_id The ID of the transaction String
amount The amount to transfer Amount
notes The extra human-readable notes for the transaction String
payment The information of the account debited and credited Payment
order_id The ID of the payment order String
book_time The time when the transaction is logged into accounting Timestamp
value_time The time when the transaction is executed Timestamp

NewWithdrawal

The request body to create a transaction of type WITHDRAWAL..

Name Description Type
amount The value of the transaction Amount
external_id The user-provided ID of the transaction, must be globally unique String
notes Extra user-readable details about the current transaction String
payment The details of a payment Payment
order_id The ID of the payment order of the withdrawal transaction String
channel_id The ID of the payment channel String
book_time The time when the transaction is logged into accounting Timestamp
value_time The time where the transaction should be applied Timestamp

NewWithdrawalRedraw

The request body to create a transaction of type WITHDRAWAL_REDRAW..

Name Description Type
amount The value of the transaction Amount
external_id The user-provided ID of the transaction, must be globally unique String
notes Extra user-readable details about the current transaction String
original_currency_code The code of the currency the payment is made in String
channel_id The ID of the transaction channel String
book_time The time when the transaction is logged into accounting Timestamp
value_time The time where the transaction should be applied Timestamp

PaymentType

The type of loan payment..

Name Description
PaymentPrincipal
PaymentInterest
PaymentManualFee
PaymentUpfrontDisbursementFee
PaymentLateRepaymentFee
PaymentPaymentDueFee
PaymentPenalty

Taxes

The taxes applied within a transaction..

Name Description Type
deferred_tax_on_interest_amount The amount of taxes on the interest that was pre-paid were added/removed in account Amount
tax_on_fees_amount The amount of taxes on the fees that were paid in this transaction Amount
tax_on_interest_amount The amount of taxes on the interest that was paid in this transaction Amount
tax_on_interest_from_arrears_amount The amount of taxes on the interest from arrears Amount
tax_on_payment_holidays_interest The amount of taxes on the Payment Holidays interest Amount
tax_on_penalty_amount The amount of taxes on the penalties Amount
tax_rate The new tax rate on the transaction if it has been changed Float(64)

TransactionBalances

The balances changed in the loan transaction..

Name Description Type
advance_position The advance (prepaid) amount Amount
arrears_position The arrears position amount for the account in arrears Amount
expected_principal_redraw The difference between principal balance and redraw balance after each transaction performed on the loan account Amount
principal The account redraw balance after the transaction Amount
redraw The account redraw balance after the transaction update Amount
total The running balance still owed for the loan Amount

TransactionFee

An amount applied or paid on an account..

Name Description Type
fee_id The ID of the fee String
name The name of the fee String
amount The amount of the fee Amount
tax_amount The tax amount of the fee Amount
trigger The cause of the creation of the fee FeeTrigger

TransactionInterestSettings

The settings for the interests and holds all the properties regarding interests..

Name Description Type
index_interest_rate The rate of index interest Float(64)
interest_rate The rate of interest Float(64)

TransferDetails

The details of a transfer..

Name Description Type
deposit_id The ID of the associated deposit transaction String
loan_id The ID of the associated loan transaction String

ProcessError

An error that occurred during bulk processing..

Name Description Type
process_id The ID of the process that triggered the error String
code A numeric value associated to the type of error that Integer
reason The human-readable description of the error String
source The cause of the error String
index_in_request The index of the process in the request payload Integer

ProcessSuccess

A process that has completed successfully..

Name Description Type
process_id The ID of the process String
resource_id The ID of the newly created resource String
index_in_request The index of the process in the request payload Integer