Search

/

Reference

Pages

Homeorganizationproductsdeposit accountsloan accountstransactionsservicesledgersuserssystem

Loan Accounts

This page includes documentation on managing loan accounts and resources associated with the account such as a card, funding sources, authorization holds and documents related to the account.

LOANS

Package loans defines services for loans.

CreateAccount

POST /v1/accounts/loans

Creates a new loan account..

Request Body (Account)
Name Description Type
account_id The ID of the account String
name The name of the account String
holder_id The ID of the holder of the account String
holder_type The type of the holder of the account Entity
state The state of the account AccountState
sub_state The sub-state of the account which may contain extra restrictions AccountSubState
accrued_interest The amount of interest accrued Amount
accrued_penalty The amount of penalty accrued Amount
activation_transaction_id The ID of the transaction that activated the account String
arrears_tolerance_period The period of tolerance for arrears Integer
assets A list of assets associated with the account Array[Asset]
guarantors A list of guarantors associated with the account Array[Guarantor]
assigned_branch_id The ID of the branch the account is assigned to String
assigned_centre_id The ID of the centre the account is assigned to String
assigned_user_id The ID of the user the account is assigned to String
balances The balance details for this loan account Balances
revolving_account_id The ID of the revolving account the account is registered to String
currency_code The currency code of the account String
days_in_arrears The number of days in arrears Integer
days_late The number of days payment is late Integer
disbursement_details The details of the disbursement DisbursementDetails
future_payments_acceptance The settings for acceptance of future payments AccountFuturePaymentsAcceptance
interest_commission The value of the interest booked by the organization from the accounts funded by investors Amount
interest_from_arrears_accrued The amount of interest accrued from arrears Amount
late_payments_recalculation_method The method used to calculate late payments AccountLatePaymentsRecalculationMethod
amount The amount of loan for the account Amount
locked_operations The list of operations that are locked Array[LockedOperations]
migration_event_id The ID of the migration event that created the account String
notes The notes of the account String
original_account_id The ID of the original account before rescheduling or refinancing String
payment_holidays_accrued_interest The amount of interest accrued on payment holidays Amount
payment_method The payment method of the account AccountPaymentMethod
product_id The ID of the product the account is registered to String
rescheduled_account_id The ID of the rescheduled account String
settings The settings applied to the loan product Settings
settlement_account_id The ID of the settlement account String
tax_rate The tax rate of the account Float(64)
tranches A list of disbursement tranches available for the account Array[Tranche]
approve_time The time the account was approved Timestamp
close_time The time the account was closed Timestamp
create_time The time the account was created Timestamp
appraise_time The time the account was last appraised Timestamp
interest_apply_time The time interest was last applied Timestamp
interest_review_time The time the interest was last reviewed Timestamp
lock_time The time the account was locked Timestamp
update_time The time the loan was last updated Timestamp
arrears_set_time The time the account was last set to standing Timestamp
tax_rate_review_time The time the tax rate was last reviewed Timestamp
terminate_time The time the account was terminated Timestamp
  • Name Description Type
    account_id The ID of the account String
    name The name of the account String
    holder_id The ID of the holder of the account String
    holder_type The type of the holder of the account Entity
    state The state of the account AccountState
    sub_state The sub-state of the account which may contain extra restrictions AccountSubState
    accrued_interest The amount of interest accrued Amount
    accrued_penalty The amount of penalty accrued Amount
    activation_transaction_id The ID of the transaction that activated the account String
    arrears_tolerance_period The period of tolerance for arrears Integer
    assets A list of assets associated with the account Array[Asset]
    guarantors A list of guarantors associated with the account Array[Guarantor]
    assigned_branch_id The ID of the branch the account is assigned to String
    assigned_centre_id The ID of the centre the account is assigned to String
    assigned_user_id The ID of the user the account is assigned to String
    balances The balance details for this loan account Balances
    revolving_account_id The ID of the revolving account the account is registered to String
    currency_code The currency code of the account String
    days_in_arrears The number of days in arrears Integer
    days_late The number of days payment is late Integer
    disbursement_details The details of the disbursement DisbursementDetails
    future_payments_acceptance The settings for acceptance of future payments AccountFuturePaymentsAcceptance
    interest_commission The value of the interest booked by the organization from the accounts funded by investors Amount
    interest_from_arrears_accrued The amount of interest accrued from arrears Amount
    late_payments_recalculation_method The method used to calculate late payments AccountLatePaymentsRecalculationMethod
    amount The amount of loan for the account Amount
    locked_operations The list of operations that are locked Array[LockedOperations]
    migration_event_id The ID of the migration event that created the account String
    notes The notes of the account String
    original_account_id The ID of the original account before rescheduling or refinancing String
    payment_holidays_accrued_interest The amount of interest accrued on payment holidays Amount
    payment_method The payment method of the account AccountPaymentMethod
    product_id The ID of the product the account is registered to String
    rescheduled_account_id The ID of the rescheduled account String
    settings The settings applied to the loan product Settings
    settlement_account_id The ID of the settlement account String
    tax_rate The tax rate of the account Float(64)
    tranches A list of disbursement tranches available for the account Array[Tranche]
    approve_time The time the account was approved Timestamp
    close_time The time the account was closed Timestamp
    create_time The time the account was created Timestamp
    appraise_time The time the account was last appraised Timestamp
    interest_apply_time The time interest was last applied Timestamp
    interest_review_time The time the interest was last reviewed Timestamp
    lock_time The time the account was locked Timestamp
    update_time The time the loan was last updated Timestamp
    arrears_set_time The time the account was last set to standing Timestamp
    tax_rate_review_time The time the tax rate was last reviewed Timestamp
    terminate_time The time the account was terminated Timestamp

ListAccounts

GET /v1/accounts/loans

Lists loan accounts..

Parameters
Name Description Type
Query Parameters
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 accounts matching the filter Integer
    remaining The number of accounts remaining in the list, including the accounts in the response Integer
    accounts The list of accounts Array[Account]
    next_page_token The page token for the next page String

GetAccount

GET /v1/accounts/loans/{AccountID}

Retrieves the specified loan account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to get String
  • Name Description Type
    account_id The ID of the account String
    name The name of the account String
    holder_id The ID of the holder of the account String
    holder_type The type of the holder of the account Entity
    state The state of the account AccountState
    sub_state The sub-state of the account which may contain extra restrictions AccountSubState
    accrued_interest The amount of interest accrued Amount
    accrued_penalty The amount of penalty accrued Amount
    activation_transaction_id The ID of the transaction that activated the account String
    arrears_tolerance_period The period of tolerance for arrears Integer
    assets A list of assets associated with the account Array[Asset]
    guarantors A list of guarantors associated with the account Array[Guarantor]
    assigned_branch_id The ID of the branch the account is assigned to String
    assigned_centre_id The ID of the centre the account is assigned to String
    assigned_user_id The ID of the user the account is assigned to String
    balances The balance details for this loan account Balances
    revolving_account_id The ID of the revolving account the account is registered to String
    currency_code The currency code of the account String
    days_in_arrears The number of days in arrears Integer
    days_late The number of days payment is late Integer
    disbursement_details The details of the disbursement DisbursementDetails
    future_payments_acceptance The settings for acceptance of future payments AccountFuturePaymentsAcceptance
    interest_commission The value of the interest booked by the organization from the accounts funded by investors Amount
    interest_from_arrears_accrued The amount of interest accrued from arrears Amount
    late_payments_recalculation_method The method used to calculate late payments AccountLatePaymentsRecalculationMethod
    amount The amount of loan for the account Amount
    locked_operations The list of operations that are locked Array[LockedOperations]
    migration_event_id The ID of the migration event that created the account String
    notes The notes of the account String
    original_account_id The ID of the original account before rescheduling or refinancing String
    payment_holidays_accrued_interest The amount of interest accrued on payment holidays Amount
    payment_method The payment method of the account AccountPaymentMethod
    product_id The ID of the product the account is registered to String
    rescheduled_account_id The ID of the rescheduled account String
    settings The settings applied to the loan product Settings
    settlement_account_id The ID of the settlement account String
    tax_rate The tax rate of the account Float(64)
    tranches A list of disbursement tranches available for the account Array[Tranche]
    approve_time The time the account was approved Timestamp
    close_time The time the account was closed Timestamp
    create_time The time the account was created Timestamp
    appraise_time The time the account was last appraised Timestamp
    interest_apply_time The time interest was last applied Timestamp
    interest_review_time The time the interest was last reviewed Timestamp
    lock_time The time the account was locked Timestamp
    update_time The time the loan was last updated Timestamp
    arrears_set_time The time the account was last set to standing Timestamp
    tax_rate_review_time The time the tax rate was last reviewed Timestamp
    terminate_time The time the account was terminated Timestamp

UpdateAccount

PUT /v1/accounts/loans/{AccountID}

Updates the specified loan account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to update String
Request Body (Account)
Name Description Type
account_id The ID of the account String
name The name of the account String
holder_id The ID of the holder of the account String
holder_type The type of the holder of the account Entity
state The state of the account AccountState
sub_state The sub-state of the account which may contain extra restrictions AccountSubState
accrued_interest The amount of interest accrued Amount
accrued_penalty The amount of penalty accrued Amount
activation_transaction_id The ID of the transaction that activated the account String
arrears_tolerance_period The period of tolerance for arrears Integer
assets A list of assets associated with the account Array[Asset]
guarantors A list of guarantors associated with the account Array[Guarantor]
assigned_branch_id The ID of the branch the account is assigned to String
assigned_centre_id The ID of the centre the account is assigned to String
assigned_user_id The ID of the user the account is assigned to String
balances The balance details for this loan account Balances
revolving_account_id The ID of the revolving account the account is registered to String
currency_code The currency code of the account String
days_in_arrears The number of days in arrears Integer
days_late The number of days payment is late Integer
disbursement_details The details of the disbursement DisbursementDetails
future_payments_acceptance The settings for acceptance of future payments AccountFuturePaymentsAcceptance
interest_commission The value of the interest booked by the organization from the accounts funded by investors Amount
interest_from_arrears_accrued The amount of interest accrued from arrears Amount
late_payments_recalculation_method The method used to calculate late payments AccountLatePaymentsRecalculationMethod
amount The amount of loan for the account Amount
locked_operations The list of operations that are locked Array[LockedOperations]
migration_event_id The ID of the migration event that created the account String
notes The notes of the account String
original_account_id The ID of the original account before rescheduling or refinancing String
payment_holidays_accrued_interest The amount of interest accrued on payment holidays Amount
payment_method The payment method of the account AccountPaymentMethod
product_id The ID of the product the account is registered to String
rescheduled_account_id The ID of the rescheduled account String
settings The settings applied to the loan product Settings
settlement_account_id The ID of the settlement account String
tax_rate The tax rate of the account Float(64)
tranches A list of disbursement tranches available for the account Array[Tranche]
approve_time The time the account was approved Timestamp
close_time The time the account was closed Timestamp
create_time The time the account was created Timestamp
appraise_time The time the account was last appraised Timestamp
interest_apply_time The time interest was last applied Timestamp
interest_review_time The time the interest was last reviewed Timestamp
lock_time The time the account was locked Timestamp
update_time The time the loan was last updated Timestamp
arrears_set_time The time the account was last set to standing Timestamp
tax_rate_review_time The time the tax rate was last reviewed Timestamp
terminate_time The time the account was terminated Timestamp
  • Name Description Type
    account_id The ID of the account String
    name The name of the account String
    holder_id The ID of the holder of the account String
    holder_type The type of the holder of the account Entity
    state The state of the account AccountState
    sub_state The sub-state of the account which may contain extra restrictions AccountSubState
    accrued_interest The amount of interest accrued Amount
    accrued_penalty The amount of penalty accrued Amount
    activation_transaction_id The ID of the transaction that activated the account String
    arrears_tolerance_period The period of tolerance for arrears Integer
    assets A list of assets associated with the account Array[Asset]
    guarantors A list of guarantors associated with the account Array[Guarantor]
    assigned_branch_id The ID of the branch the account is assigned to String
    assigned_centre_id The ID of the centre the account is assigned to String
    assigned_user_id The ID of the user the account is assigned to String
    balances The balance details for this loan account Balances
    revolving_account_id The ID of the revolving account the account is registered to String
    currency_code The currency code of the account String
    days_in_arrears The number of days in arrears Integer
    days_late The number of days payment is late Integer
    disbursement_details The details of the disbursement DisbursementDetails
    future_payments_acceptance The settings for acceptance of future payments AccountFuturePaymentsAcceptance
    interest_commission The value of the interest booked by the organization from the accounts funded by investors Amount
    interest_from_arrears_accrued The amount of interest accrued from arrears Amount
    late_payments_recalculation_method The method used to calculate late payments AccountLatePaymentsRecalculationMethod
    amount The amount of loan for the account Amount
    locked_operations The list of operations that are locked Array[LockedOperations]
    migration_event_id The ID of the migration event that created the account String
    notes The notes of the account String
    original_account_id The ID of the original account before rescheduling or refinancing String
    payment_holidays_accrued_interest The amount of interest accrued on payment holidays Amount
    payment_method The payment method of the account AccountPaymentMethod
    product_id The ID of the product the account is registered to String
    rescheduled_account_id The ID of the rescheduled account String
    settings The settings applied to the loan product Settings
    settlement_account_id The ID of the settlement account String
    tax_rate The tax rate of the account Float(64)
    tranches A list of disbursement tranches available for the account Array[Tranche]
    approve_time The time the account was approved Timestamp
    close_time The time the account was closed Timestamp
    create_time The time the account was created Timestamp
    appraise_time The time the account was last appraised Timestamp
    interest_apply_time The time interest was last applied Timestamp
    interest_review_time The time the interest was last reviewed Timestamp
    lock_time The time the account was locked Timestamp
    update_time The time the loan was last updated Timestamp
    arrears_set_time The time the account was last set to standing Timestamp
    tax_rate_review_time The time the tax rate was last reviewed Timestamp
    terminate_time The time the account was terminated Timestamp

DeleteAccount

DELETE /v1/accounts/loans/{AccountID}

Deletes the specified loan account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to delete String

ApplyAccountLock

POST /v1/loans/{AccountID}:lock

Applies a lock to a loan account's income sources..

Parameters
Name Description Type
Query Parameters
account_id The ID of the loan account String
Request Body (NewAccountLock)
Name Description Type
locked_operations The list of operations to lock Array[LockedOperations]
notes Extra user-readable details on the request String

ApplyAccountUnlock

POST /v1/loans/{AccountID}:unlock

Removes a lock from a loan account's income sources..

Parameters
Name Description Type
Query Parameters
account_id The ID of the loan account String
notes Extra user-readable details on the request String

CreateCard

POST /v1/accounts/loans/{AccountID}/cards

Creates a new card for an existing loan account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to create the card for String
Request Body (Card)
Name Description Type
card_id The ID of the card String
type The type of the card Type
account_id The ID of the account associated with the card String
  • Name Description Type
    card_id The ID of the card String
    type The type of the card Type
    account_id The ID of the account associated with the card String

ListCards

GET /v1/accounts/loans/{AccountID}/cards

Lists cards for a loan account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to list cards for String
page_token The page token to use for the next page String
page_size The number of cards 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 cards matching the filter Integer
    remaining The number of cards remaining in the list, including the cards in the response Integer
    cards The cards that were retrieved Array[Card]
    next_page_token The page token for the next page String

GetCard

GET /v1/accounts/loans/{AccountID}/cards/{CardID}

Retrieves the specified card from a loan account. To retrieve other information on the card, use the cards package under the Services section..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to get the card for String
card_id The ID of the card to get String
  • Name Description Type
    card_id The ID of the card String
    type The type of the card Type
    account_id The ID of the account associated with the card String

DeleteCard

DELETE /v1/accounts/loans/{AccountID}/cards/{CardID}

Deletes the specified card..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to delete the card for String
card_id The ID of the card to get String

CreateFunding

POST /v1/accounts/loans/{AccountID}/fundings

Creates a new funding source for an existing loan account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to create the funding source for String
Request Body (InvestorFund)
Name Description Type
fund_id The ID of the investor fund String
amount The amount of the investor fund Amount
interest_commission The minimum interest commission Float(64)
share_percentage The percentage shared by the investor fund Float(64)
  • Name Description Type
    fund_id The ID of the investor fund String
    amount The amount of the investor fund Amount
    interest_commission The minimum interest commission Float(64)
    share_percentage The percentage shared by the investor fund Float(64)

ListFundings

GET /v1/accounts/loans/{AccountID}/fundings

Lists funding sources for a loan account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to list funding sources for String
page_token The page token to use for the next page String
page_size The number of funding sources 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 funds matching the filter Integer
    remaining The number of funds remaining in the list, including the funds in the response Integer
    funds The funding sources that were retrieved Array[InvestorFund]
    next_page_token The page token for the next page String

GetFunding

GET /v1/accounts/loans/{AccountID}/fundings/{FundID}

Retrieves the specified funding source from a loan account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to retrieve the funding source for String
fund_id The ID of the funding source to retrieve String
  • Name Description Type
    fund_id The ID of the investor fund String
    amount The amount of the investor fund Amount
    interest_commission The minimum interest commission Float(64)
    share_percentage The percentage shared by the investor fund Float(64)

UpdateFunding

PUT /v1/accounts/loans/{AccountID}/fundings/{FundID}

Updates the specified funding source on a loan account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to update the funding sources for String
fund_id The ID of the funding source to update String
Request Body (InvestorFund)
Name Description Type
fund_id The ID of the investor fund String
amount The amount of the investor fund Amount
interest_commission The minimum interest commission Float(64)
share_percentage The percentage shared by the investor fund Float(64)
  • Name Description Type
    fund_id The ID of the investor fund String
    amount The amount of the investor fund Amount
    interest_commission The minimum interest commission Float(64)
    share_percentage The percentage shared by the investor fund Float(64)

DeleteFunding

DELETE /v1/accounts/loans/{AccountID}/fundings/{FundID}

Deletes the specified funding source..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to delete the funding sources for String
fund_id The ID of the funding sources to delete String

SellFunding

POST /v1/accounts/loans/{AccountID}/fundings/{FundID}:sell

Sells the specified funding source to other investors. This endpoint is used in P2P investor funding transactions for investors to trade funds for liquidity..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to delete the funding sources for String
fund_id The ID of the funding source String
Request Body (FundingSale)
Name Description Type
purchases A list of investors purchasing the funding source Array[Purchase]

GetInstallment

GET /v1/accounts/loans/{AccountID}/installments/{InstallmentID}

Retrieves the specified installment from a loan account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to retrieve the installment for String
installment_id The ID of the installment to retrieve String
  • Name Description Type
    installment_id The ID of the installment String
    fees The amount of fees applied to the installment Array[InstallmentFee]
    interest The amount of interest applied to the installment InstallmentAllocation
    is_payment_holiday A flag for offering payment holiday in the installment Boolean
    pay_time The time the installment was last paid Timestamp
    order The index of the installment generated for a loan starting from 1, sorted chronologically String
    parent_account_id The ID of the parent account String
    penalty The amount of penalty that can be charged to the loan account InstallmentAllocation
    principal The original amount of loan that is disbursed InstallmentAllocation
    due_time The time the installment must be repaid Timestamp
    repay_time The time the installment was paid Timestamp
    state The state of the installment InstallmentState

ListInstallments

GET /v1/accounts/loans/{AccountID}/installments

Lists installments for the specified loan account. The account ID may be set to "-" to indicate all accounts, allowing a search across all loan accounts..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to list installments for String
page_token The page token to use for the next page String
page_size The number of installments 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 installments matching the filter Integer
    remaining The number of installments remaining in the list, including the installments in the response Integer
    installments The list of installments that were retrieved Array[Installment]
    next_page_token The page token for the next page String

ApplyInterest

POST /v1/accounts/loans/{AccountID}:applyInterest

Applies interest to an existing loan account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to create the interest for String
Request Body (NewInterest)
Name Description Type
is_payment_holidays The flag to indicate if the interest is paid on holidays Boolean
holiday_amount The amount of Payment Holidays interest to apply Amount
value_time The time the interest should be applied Timestamp
notes The notes for applying the interest String

GetDocument

GET /v1/accounts/loans/{AccountID}/doc/{TemplateID}

Generates a document for a loan account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to retrieve the document for String
template_id The ID of the template to generate the document based on String
start_time The start time of transactions to generate transaction history for Timestamp
end_time The end time of transactions to generate transaction history for Timestamp
  • Name Description Type
    content The raw content of the file encoded in base64 Bytes

GetSchedule

GET /v1/accounts/loans/{AccountID}/schedule

Retrieves a loan account schedule..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to retrieve the schedule for String
  • Name Description Type
    currency_code The code of the currency all transactions use String
    transactions The list of transactions for the loan account Array[Installment]

PreviewSchedule

POST /v1/accounts/loans:preview

Retrieves a preview of an account schedule based on the provided account. This endpoint does not affect the state of the Core Banking system..

Request Body (Account)
Name Description Type
account_id The ID of the account String
name The name of the account String
holder_id The ID of the holder of the account String
holder_type The type of the holder of the account Entity
state The state of the account AccountState
sub_state The sub-state of the account which may contain extra restrictions AccountSubState
accrued_interest The amount of interest accrued Amount
accrued_penalty The amount of penalty accrued Amount
activation_transaction_id The ID of the transaction that activated the account String
arrears_tolerance_period The period of tolerance for arrears Integer
assets A list of assets associated with the account Array[Asset]
guarantors A list of guarantors associated with the account Array[Guarantor]
assigned_branch_id The ID of the branch the account is assigned to String
assigned_centre_id The ID of the centre the account is assigned to String
assigned_user_id The ID of the user the account is assigned to String
balances The balance details for this loan account Balances
revolving_account_id The ID of the revolving account the account is registered to String
currency_code The currency code of the account String
days_in_arrears The number of days in arrears Integer
days_late The number of days payment is late Integer
disbursement_details The details of the disbursement DisbursementDetails
future_payments_acceptance The settings for acceptance of future payments AccountFuturePaymentsAcceptance
interest_commission The value of the interest booked by the organization from the accounts funded by investors Amount
interest_from_arrears_accrued The amount of interest accrued from arrears Amount
late_payments_recalculation_method The method used to calculate late payments AccountLatePaymentsRecalculationMethod
amount The amount of loan for the account Amount
locked_operations The list of operations that are locked Array[LockedOperations]
migration_event_id The ID of the migration event that created the account String
notes The notes of the account String
original_account_id The ID of the original account before rescheduling or refinancing String
payment_holidays_accrued_interest The amount of interest accrued on payment holidays Amount
payment_method The payment method of the account AccountPaymentMethod
product_id The ID of the product the account is registered to String
rescheduled_account_id The ID of the rescheduled account String
settings The settings applied to the loan product Settings
settlement_account_id The ID of the settlement account String
tax_rate The tax rate of the account Float(64)
tranches A list of disbursement tranches available for the account Array[Tranche]
approve_time The time the account was approved Timestamp
close_time The time the account was closed Timestamp
create_time The time the account was created Timestamp
appraise_time The time the account was last appraised Timestamp
interest_apply_time The time interest was last applied Timestamp
interest_review_time The time the interest was last reviewed Timestamp
lock_time The time the account was locked Timestamp
update_time The time the loan was last updated Timestamp
arrears_set_time The time the account was last set to standing Timestamp
tax_rate_review_time The time the tax rate was last reviewed Timestamp
terminate_time The time the account was terminated Timestamp
  • Name Description Type
    currency_code The code of the currency all transactions use String
    transactions The list of transactions for the loan account Array[Installment]

PreviewRepayment

POST /v1/accounts/loans/{AccountID}:previewRepayment

Previews a repayment at a future date..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to preview the repayment for String
Request Body (NewRepayment)
Name Description Type
payment_id The ID of the repayment String
amount The amount repaid PaymentAmounts
transaction The transaction for the repayment Transaction
entry_time The time the repayment was made Timestamp
notes The notes for the repayment String
  • Name Description Type
    fee_balance The fee balance after the repayment Amount
    interest_balance The interest balance after the repayment Amount
    penalty_balance The penalty balance after the repayment Amount
    principal_balance The principal balance after the repayment Amount
    total_balance The total balance after the repayment Amount

Refinance

POST /v1/accounts/loans/{AccountID}:refinance

Refinances a loan account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to refinance String
Request Body (RefinanceAccountAction)
Name Description Type
keep_same_account_id The flag to keep the same account ID Boolean
account The settings for the refinanced account RefinanceAccount
top_up_amount The amount to top up Amount
write_off_amounts The amount to write off RefinanceWriteOffAmounts

Reschedule

POST /v1/accounts/loans/{AccountID}:reschedule

Reschedules a loan account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to reschedule String
Request Body (RescheduleAccountAction)
Name Description Type
keep_same_account_id The flag to keep the same account ID Boolean
account The details of rescheduled account RescheduleAccount
write_off_amounts The amounts written off in the rescheduled loan account RescheduleWriteOffAmounts

WriteOff

POST /v1/accounts/loans/{AccountID}:writeOff

Writes off a loan account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to write off String
Request Body (ActionDetails)
Name Description Type
notes The notes associated with the action String

UndoRefinance

POST /v1/accounts/loans/{AccountID}:undoRefinance

Undoes a refinance action..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to undo the refinance action for String
Request Body (ActionDetails)
Name Description Type
notes The notes associated with the action String

UndoReschedule

POST /v1/accounts/loans/{AccountID}:undoReschedule

Undoes a reschedule action..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to undo the reschedule action for String
Request Body (ActionDetails)
Name Description Type
notes The notes associated with the action String

UndoWriteOff

POST /v1/accounts/loans/{AccountID}:undoWriteOff

Undoes a write off action..

Parameters
Name Description Type
Query Parameters
account_id The ID of the account to undo the write off action for String
Request Body (ActionDetails)
Name Description Type
notes The notes associated with the action String

REVOLVING

Package revolving allows retrieving, creating, updating and deleting revolving accounts.

CreateAccount

POST /v1/revolving

Creates a revolving account..

Request Body (Account)
Name Description Type
account_id The ID of the revolving account String
client_id The ID of the client of the account String
holder_type The type of of the client Entity
notes The description of the account String
status The status of the account Status
sub_status The sub-status of the account Status
max_credit The maximum credit the client can be exposed to Amount
available_credit The remaining amount of credit Amount
consumed_credit The amount of credit consumed Amount
exposure_limit_type Limit type of the account ExposureLimit
approve_time The time the account was approved Timestamp
start_time The time the account was started Timestamp
close_time The time the account was closed Timestamp
expire_time The time the account expires Timestamp
create_time The time the account was created Timestamp
update_time The time the account was last updated Timestamp
  • Name Description Type
    account_id The ID of the revolving account String
    client_id The ID of the client of the account String
    holder_type The type of of the client Entity
    notes The description of the account String
    status The status of the account Status
    sub_status The sub-status of the account Status
    max_credit The maximum credit the client can be exposed to Amount
    available_credit The remaining amount of credit Amount
    consumed_credit The amount of credit consumed Amount
    exposure_limit_type Limit type of the account ExposureLimit
    approve_time The time the account was approved Timestamp
    start_time The time the account was started Timestamp
    close_time The time the account was closed Timestamp
    expire_time The time the account expires Timestamp
    create_time The time the account was created Timestamp
    update_time The time the account was last updated Timestamp

ListAccounts

GET /v1/revolving

Lists revolving accounts..

Parameters
Name Description Type
Query Parameters
page_token The token of the page to retrieve String
page_size The size of the page to retrieve Integer
order_by The field to order by String
filter The filter to apply String
  • Name Description Type
    total The total number of accounts matching the filter Integer
    remaining The number of accounts remaining in the list, including the accounts in the response Integer
    accounts The list of revolving account Array[Account]
    next_page_token The token of the next page String

GetAccount

GET /v1/revolving/{AccountID}

Retrieves the specified revolving account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the revolving account to retrieve String
  • Name Description Type
    account_id The ID of the revolving account String
    client_id The ID of the client of the account String
    holder_type The type of of the client Entity
    notes The description of the account String
    status The status of the account Status
    sub_status The sub-status of the account Status
    max_credit The maximum credit the client can be exposed to Amount
    available_credit The remaining amount of credit Amount
    consumed_credit The amount of credit consumed Amount
    exposure_limit_type Limit type of the account ExposureLimit
    approve_time The time the account was approved Timestamp
    start_time The time the account was started Timestamp
    close_time The time the account was closed Timestamp
    expire_time The time the account expires Timestamp
    create_time The time the account was created Timestamp
    update_time The time the account was last updated Timestamp

UpdateAccount

PUT /v1/revolving/{AccountID}

Updates a revolving account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the revolving account to update String
Request Body (Account)
Name Description Type
account_id The ID of the revolving account String
client_id The ID of the client of the account String
holder_type The type of of the client Entity
notes The description of the account String
status The status of the account Status
sub_status The sub-status of the account Status
max_credit The maximum credit the client can be exposed to Amount
available_credit The remaining amount of credit Amount
consumed_credit The amount of credit consumed Amount
exposure_limit_type Limit type of the account ExposureLimit
approve_time The time the account was approved Timestamp
start_time The time the account was started Timestamp
close_time The time the account was closed Timestamp
expire_time The time the account expires Timestamp
create_time The time the account was created Timestamp
update_time The time the account was last updated Timestamp
  • Name Description Type
    account_id The ID of the revolving account String
    client_id The ID of the client of the account String
    holder_type The type of of the client Entity
    notes The description of the account String
    status The status of the account Status
    sub_status The sub-status of the account Status
    max_credit The maximum credit the client can be exposed to Amount
    available_credit The remaining amount of credit Amount
    consumed_credit The amount of credit consumed Amount
    exposure_limit_type Limit type of the account ExposureLimit
    approve_time The time the account was approved Timestamp
    start_time The time the account was started Timestamp
    close_time The time the account was closed Timestamp
    expire_time The time the account expires Timestamp
    create_time The time the account was created Timestamp
    update_time The time the account was last updated Timestamp

DeleteAccount

DELETE /v1/revolving/{AccountID}

Deletes a revolving account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the revolving account to delete String

Account

A loan account where the bank lends to a customer..

Name Description Type
account_id The ID of the account String
name The name of the account String
holder_id The ID of the holder of the account String
holder_type The type of the holder of the account Entity
state The state of the account AccountState
sub_state The sub-state of the account which may contain extra restrictions AccountSubState
accrued_interest The amount of interest accrued Amount
accrued_penalty The amount of penalty accrued Amount
activation_transaction_id The ID of the transaction that activated the account String
arrears_tolerance_period The period of tolerance for arrears Integer
assets A list of assets associated with the account Array[Asset]
guarantors A list of guarantors associated with the account Array[Guarantor]
assigned_branch_id The ID of the branch the account is assigned to String
assigned_centre_id The ID of the centre the account is assigned to String
assigned_user_id The ID of the user the account is assigned to String
balances The balance details for this loan account Balances
revolving_account_id The ID of the revolving account the account is registered to String
currency_code The currency code of the account String
days_in_arrears The number of days in arrears Integer
days_late The number of days payment is late Integer
disbursement_details The details of the disbursement DisbursementDetails
future_payments_acceptance The settings for acceptance of future payments AccountFuturePaymentsAcceptance
interest_commission The value of the interest booked by the organization from the accounts funded by investors Amount
interest_from_arrears_accrued The amount of interest accrued from arrears Amount
late_payments_recalculation_method The method used to calculate late payments AccountLatePaymentsRecalculationMethod
amount The amount of loan for the account Amount
locked_operations The list of operations that are locked Array[LockedOperations]
migration_event_id The ID of the migration event that created the account String
notes The notes of the account String
original_account_id The ID of the original account before rescheduling or refinancing String
payment_holidays_accrued_interest The amount of interest accrued on payment holidays Amount
payment_method The payment method of the account AccountPaymentMethod
product_id The ID of the product the account is registered to String
rescheduled_account_id The ID of the rescheduled account String
settings The settings applied to the loan product Settings
settlement_account_id The ID of the settlement account String
tax_rate The tax rate of the account Float(64)
tranches A list of disbursement tranches available for the account Array[Tranche]
approve_time The time the account was approved Timestamp
close_time The time the account was closed Timestamp
create_time The time the account was created Timestamp
appraise_time The time the account was last appraised Timestamp
interest_apply_time The time interest was last applied Timestamp
interest_review_time The time the interest was last reviewed Timestamp
lock_time The time the account was locked Timestamp
update_time The time the loan was last updated Timestamp
arrears_set_time The time the account was last set to standing Timestamp
tax_rate_review_time The time the tax rate was last reviewed Timestamp
terminate_time The time the account was terminated Timestamp

AccountFuturePaymentsAcceptance

The acceptance of future payments..

Name Description
NoFuturePayments
AcceptFuturePayments
AcceptOverpayments

AccountLatePaymentsRecalculationMethod

The method used to calculate late payments..

Name Description
MethodOverdueInstallmentsIncrease
MethodLastInstallmentIncrease

AccountPaymentMethod

The method used to pay the account..

Name Description
MethodHorizontal
MethodVertical

AccountState

The state of an account..

Name Description
StatePartialApplication
StatePendingApproval
StateApproved
StateActive
StateActiveInArrears
StateClosed

AccountSubState

The sub-state of an account..

Name Description
StatePartiallyDisbursed
StateLocked
StateLockedCapping
StateRefinanced
StateRescheduled
StateWithdrawn
StateRepaid
StateRejected
StateWrittenOff
StateTerminated

ActionDetails

A structure that holds details about an action..

Name Description Type
notes The notes associated with the action String

Asset

An asset that is being used to guarantee a loan account..

Name Description Type
amount The amount of the asset used by the client for the guarantee Amount
asset_name The name of the asset if the type is an asset String

Balances

The balances of a loan account..

Name Description Type
fees The total fee expected to be paid by the client for the loan Amount
fees_due The total fee due for the account Amount
fees_paid The total fee paid by the client for the loan Amount
hold The sum of all authorization hold on the account Amount
interest The total interest expected to be paid by the client from now on Amount
interest_due The total interest due for the account Amount
interest_from_arrears The interest from arrears owned Amount
interest_from_arrears_due The interest from arrears due Amount
interest_from_arrears_paid The interest from arrears paid Amount
interest_paid The total interest paid into the account Amount
penalty The total penalty expected to be paid Amount
penalty_due The total penalty due for the account Amount
penalty_paid The total penalty paid by the client for the loan Amount
principal The total principal owned by the client Amount
principal_due The total principal due for the account Amount
principal_paid The total principal paid by the client for the loan Amount
redraw The total redraw amount owned Amount

CustomPredefinedFee

A custom fee defined that was applied on the disbursement..

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

DisbursementDetails

The details of a disbursement..

Name Description Type
disburse_time The time the disbursement was made Timestamp
expected_disburse_time The expected time for disbursement Timestamp
first_repay_time The time of the first repayment Timestamp
fees The list of fees applied to the disbursement Array[CustomPredefinedFee]
transfer The transfer details of the disbursement Transfer

FundingSale

The sale of a funding source in P2P products by an investor to another investor. The funding source ID being sold should be passed as a URL parameter and is therefore omitted in the body..

Name Description Type
purchases A list of investors purchasing the funding source Array[Purchase]

Guarantor

A client that guarantees a loan account..

Name Description Type
guarantor_id The ID of the guarantor String
guarantor_type The type of the guarantor Entity
deposit_account_id The ID of the deposit account used as a guarantee String
amount The amount of the asset used by the client for the guarantee Amount

Installment

A single installment used in loan repayment..

Name Description Type
installment_id The ID of the installment String
fees The amount of fees applied to the installment Array[InstallmentFee]
interest The amount of interest applied to the installment InstallmentAllocation
is_payment_holiday A flag for offering payment holiday in the installment Boolean
pay_time The time the installment was last paid Timestamp
order The index of the installment generated for a loan starting from 1, sorted chronologically String
parent_account_id The ID of the parent account String
penalty The amount of penalty that can be charged to the loan account InstallmentAllocation
principal The original amount of loan that is disbursed InstallmentAllocation
due_time The time the installment must be repaid Timestamp
repay_time The time the installment was paid Timestamp
state The state of the installment InstallmentState

InstallmentAllocation

An installment allocation element..

Name Description Type
amount The status of repayment on the element InstallmentAmount
tax The status of repayment on the tax applied to the amount InstallmentAmount

InstallmentAmount

The amounts that an installment expects..

Name Description Type
expected The total expected amount, including the amount due and paid Amount
due The amount remaining to be paid Amount
paid The amount that has been paid Amount
reduced The amount of the installment that has been reduced Amount

InstallmentFee

The fee applied to an installment..

Name Description Type
fee_id The ID of the fee applied String
name The name of the fee applied String
amount The status of repayment on the fee InstallmentAmount
tax The status of repayment on the tax applied to the amount InstallmentAmount

InstallmentState

The state of repayment for the installment..

Name Description
InstallmentPending
InstallmentLate
InstallmentPaid
InstallmentPartiallyPaid
InstallmentGrace

InvestorFund

The investor fund associated with a loan account..

Name Description Type
fund_id The ID of the investor fund String
amount The amount of the investor fund Amount
interest_commission The minimum interest commission Float(64)
share_percentage The percentage shared by the investor fund Float(64)

LockedOperations

The list of operations that can be locked..

Name Description
OperationApplyInterest
OperationApplyFees
OperationApplyPenalties

NewAccountLock

The request body to apply a lock on a loan account..

Name Description Type
locked_operations The list of operations to lock Array[LockedOperations]
notes Extra user-readable details on the request String

NewInterest

The details of a new interest..

Name Description Type
is_payment_holidays The flag to indicate if the interest is paid on holidays Boolean
holiday_amount The amount of Payment Holidays interest to apply Amount
value_time The time the interest should be applied Timestamp
notes The notes for applying the interest String

NewRepayment

The details of a new repayment..

Name Description Type
payment_id The ID of the repayment String
amount The amount repaid PaymentAmounts
transaction The transaction for the repayment Transaction
entry_time The time the repayment was made Timestamp
notes The notes for the repayment String

PaymentAmounts

A list of amounts paid..

Name Description Type
fees The amount of fees paid Amount
interest The amount of interest paid Amount
penalty The amount of penalty paid Amount

Purchase

A purchase of a loan funding source..

Name Description Type
account_id The ID for the funding account of the buyer String
amount The amount of funding source being purchased, as a fraction of the whole fraction being sold String
price The price paid for the amount Amount

RefinanceAccount

The settings for the refinanced account..

Name Description Type
account_id The ID of the refinanced account String
name The name of the refinanced account String
product_id The ID of the product of the refinanced account String
account_arrears_settings The settings for the account arrears RestructureAccountArrearsSettings
disbursement_details The details of the disbursement RefinanceDisbursementDetails
guarantors The list of guarantors for the refinanced account Array[Guarantor]
interest_settings The settings for interest RestructureInterestSettings
penalty_settings The settings for the penalty RestructurePenaltySettings
principal_payment_settings The settings for the principal payment RestructurePrincipalPaymentSettings
schedule_settings The settings for the schedule RestructureScheduleSettings
notes The notes of the refinanced account String

RefinanceAccountAction

The refinance action to perform on a loan account..

Name Description Type
keep_same_account_id The flag to keep the same account ID Boolean
account The settings for the refinanced account RefinanceAccount
top_up_amount The amount to top up Amount
write_off_amounts The amount to write off RefinanceWriteOffAmounts

RefinanceDisbursementDetails

The details of the disbursement of a refinanced account..

Name Description Type
expected_disburse_time The expected disbursement time of the refinanced account Timestamp
first_repay_time The first repayment time of the refinanced account Timestamp
fees The list of fees for the refinanced account Array[CustomPredefinedFee]

RefinanceWriteOffAmounts

The amount to write off for the refinanced account..

Name Description Type
fee The write-off amount for fee Amount
interest The write-off amount for interest Amount
penalty The write-off amount for penalty Amount

RescheduleAccount

The settings for the rescheduled account..

Name Description Type
account_id The ID of the rescheduled account String
name The name of the rescheduled account String
product_id The ID of the product of the rescheduled account String
account_arrears_settings The account arrears settings for the rescheduled account RestructureAccountArrearsSettings
disbursement_details The details of the disbursement RescheduleDisbursementDetails
guarantors The list of guarantors for the rescheduled account Array[Guarantor]
interest_commission The interest commission for the rescheduled account Amount
interest_settings The interest settings for the rescheduled account RestructureInterestSettings
penalty_settings The penalty settings for the rescheduled account RestructurePenaltySettings
principal_payment_settings The principal payment settings for the rescheduled account RestructurePrincipalPaymentSettings
schedule_settings The schedule settings for the rescheduled account RestructureScheduleSettings
notes The human-readable notes for the rescheduled loan account String

RescheduleAccountAction

The action to reschedule a loan account..

Name Description Type
keep_same_account_id The flag to keep the same account ID Boolean
account The details of rescheduled account RescheduleAccount
write_off_amounts The amounts written off in the rescheduled loan account RescheduleWriteOffAmounts

RescheduleDisbursementDetails

The details of the disbursement of a rescheduled account..

Name Description Type
first_repay_time The first repayment time of the rescheduled account Timestamp

RescheduleWriteOffAmounts

The write-off amounts on the rescheduled loan account..

Name Description Type
fee The write-off amount for fee Amount
interest The write-off amount for interest Amount
penalty The write-off amount for penalty Amount
principal The write-off amount for principal Amount

RestructureAccountArrearsSettings

The arrears settings on the restructured account..

Name Description Type
tolerance_percentage_of_outstanding_principal The tolerance percentage of outstanding principal Float(64)
tolerance_period The arrears tolerance period Integer

RestructureInterestSettings

The interest settings on the restructured account..

Name Description Type
rate The interest rate for the restructured account Float(64)
spread The interest spread for the restructured account Float(64)

RestructurePenaltySettings

The penalty settings on the restructured account..

Name Description Type
penalty_rate The penalty rate for the restructured loan account Float(64)

RestructurePrincipalPaymentSettings

The principal payment settings on the restructured account..

Name Description Type
amount The fixed principal payment amount Amount
percentage The principal payment percentage Float(64)

RestructureScheduleSettings

The settings for a restructure schedule..

Name Description Type
fixed_days_of_month The list of days of the month to repay Array[Integer]
grace_period The grace period of the restructure schedule Integer
periodic_payment The amount to periodically pay Amount
number_of_previewed_installments The number of previewed installments Integer
repayment_installments The number of installments to repay Integer
repayment_period The duration between repayments Duration

Settings

The settings of an account..

Name Description Type
arrears The account's arrears settings ArrearsSettings
interest The account's interest settings LoanInterestSettings
penalty The account's penalty settings PenaltySettings
prepayment The account's prepayment settings PrepaymentSettings
principal_payment The account's principal payment settings PrincipalPaymentSettings
redraw The account's redraw settings RedrawSettings
schedule The account's schedule settings LoanScheduleSettings

Tranche

A structure that holds details about a tranche, allowing partial approval of loans and the loan to be extended..

Name Description Type
amount The amount of the tranche available for disbursement Amount
disbursement_details The details of the disbursement TrancheDisbursementDetails
fees The list of fees for the tranche Array[CustomPredefinedFee]
tranche_number The index of the tranche Integer

TrancheDisbursementDetails

The disbursement details regarding a loan tranche..

Name Description Type
transaction_id The ID of the disbursement transaction String
expected_disburse_time The expected time of disbursement Timestamp

Transaction

The details for a loan transaction..

Name Description Type
channel_id The ID of the channel that the transaction was performed on String

Transfer

A structure that holds details about a transfer..

Name Description Type
internal_transfer The flag that indicates if the transfer is internal, between loans and deposit accounts Boolean
target_deposit_account_id The ID of the target deposit account String
transaction The details of the transaction Transaction

Account

The pre-approved loan limit of a client (individual, group, or company)..

Name Description Type
account_id The ID of the revolving account String
client_id The ID of the client of the account String
holder_type The type of of the client Entity
notes The description of the account String
status The status of the account Status
sub_status The sub-status of the account Status
max_credit The maximum credit the client can be exposed to Amount
available_credit The remaining amount of credit Amount
consumed_credit The amount of credit consumed Amount
exposure_limit_type Limit type of the account ExposureLimit
approve_time The time the account was approved Timestamp
start_time The time the account was started Timestamp
close_time The time the account was closed Timestamp
expire_time The time the account expires Timestamp
create_time The time the account was created Timestamp
update_time The time the account was last updated Timestamp

ExposureLimit

The type of restriction applied to a revolving account..

Name Description
ApprovedAmount
OutstandingAmount