Skip to main content

Fetch loan details

POST 
/api/Accounts/GetLoanDetails

Description​

Retrieve details about loans (loan instalments) associated with accounts.

Request​

Body Parameters

    ActionLog object
    Action string
    Controller string
    Date date-time
    DeviceId string
    Id integer
    IpAddress string
    LanguageCode string
    LoginKey string
    Username string
    ForceLoad boolean
    LogInfo object
    AppVersion string
    IpAddress string
    LanguageCode string
    Validation objectrequiredThe validation parameter, mandatory to all Banking Suite API calls.
    AccessToken string

    The access token for authentication.

    AppKey string

    The key assigned to the application.

    CustomerCode string

    The unique code assigned to the customer.

    DeviceId string

    The unique identifier of the device.

    LoginKey string

    The key used for login.

    RefreshToken string

    The token used to refresh the session.

    Username string

    The username for authentication.

    Loan stringrequired

    The loan number.

    LoanType stringrequired

    The type of loan.
    Available options: 1 = "Savings", 2 = "TimeDeposit",3 = "Checking", 4 = "Current",5 = "JointCredit",6 = "Amortizing",7 = "FullyAmortizing", 8 = "Unexpected".

Responses​

Success
Schema
    accountType int32

    Possible values: [1, 2, 3, 4, 5, 6, 7, 8]


    Description: 1 = "Savings", 2 = "TimeDeposit", 3 = "Checking", 4 = "Current", 5 = "JointCredit", 6 = "Amortizing", 7 = "FullyAmortizing", 8 = "Unexpected"

    amortizedLoanDetails object
    activity string
    amortizedInstallments object[]
  • Array [
    • expirationDate date-time
    hasInterestToAccount boolean
    installmentRemainingAmount double
    interestsAccounting boolean
    interestsAccountingAmount double
    interestsUnaccountedAmount double
    priority int32
  • ]
    • beneficiaries string[]
    contract string
    form string
    installmentPlan object[]
  • Array [
    • DueDate date-time
    InstallmentAmount double
    InstallmentNumber int32
    InsuranceFeesAmount double
    InterestAmount double
    InterestRate double
    LoanFeesAmount double
    PaymentDate date-time
    PrincipalAmount double
    PrincipalPaymentAmount double
    RemainingCapital double
  • ]
    • interest string
    kad string
    linkedAccounts object[]
  • Array [
    • aA_Account int32
    accountNumber string
    isActive boolean
    isService boolean
  • ]
    • mainBeneficiary string
    overdraftLimit double
    status string
    fullyAmortizedLoanDetails object
    activity string
    beneficiaries string[]
    contract string
    form string
    fullyAmortizedInstallments object[]
  • Array [
    • expirationDate date-time
    hasInterestsToAccount boolean
    hasUnpaidInterests boolean
    installmentRemainingAmount double
    interestAccounting boolean
    interestsAccountingAmount double
    interestsUnaccountedAmount double
    priority int32
  • ]
    • installmentPlan object[]
  • Array [
    • DueDate date-time
    InstallmentAmount double
    InstallmentNumber int32
    InsuranceFeesAmount double
    InterestAmount double
    InterestRate double
    LoanFeesAmount double
    PaymentDate date-time
    PrincipalAmount double
    PrincipalPaymentAmount double
    RemainingCapital double
  • ]
    • interest string
    kad string
    linkedAccounts object[]
  • Array [
    • aA_Account int32
    accountNumber string
    isActive boolean
    isService boolean
  • ]
    • mainBeneficiary string
    overdraftLimit double
    status string
    httpStatusCode int32

    Possible values: [100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 306, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, 511]


    Description: 100 = "Continue", 101 = "SwitchingProtocols", 102 = "Processing", 103 = "EarlyHints", 200 = "OK", 201 = "Created", 202 = "Accepted", 203 = "NonAuthoritativeInformation", 204 = "NoContent", 205 = "ResetContent", 206 = "PartialContent", 207 = "MultiStatus", 208 = "AlreadyReported", 226 = "IMUsed", 300 = "Ambiguous", 300 = "Ambiguous", 301 = "Moved", 301 = "Moved", 302 = "Redirect", 302 = "Redirect", 303 = "RedirectMethod", 303 = "RedirectMethod", 304 = "NotModified", 305 = "UseProxy", 306 = "Unused", 307 = "TemporaryRedirect", 307 = "TemporaryRedirect", 308 = "PermanentRedirect", 400 = "BadRequest", 401 = "Unauthorized", 402 = "PaymentRequired", 403 = "Forbidden", 404 = "NotFound", 405 = "MethodNotAllowed", 406 = "NotAcceptable", 407 = "ProxyAuthenticationRequired", 408 = "RequestTimeout", 409 = "Conflict", 410 = "Gone", 411 = "LengthRequired", 412 = "PreconditionFailed", 413 = "RequestEntityTooLarge", 414 = "RequestUriTooLong", 415 = "UnsupportedMediaType", 416 = "RequestedRangeNotSatisfiable", 417 = "ExpectationFailed", 421 = "MisdirectedRequest", 422 = "UnprocessableEntity", 423 = "Locked", 424 = "FailedDependency", 426 = "UpgradeRequired", 428 = "PreconditionRequired", 429 = "TooManyRequests", 431 = "RequestHeaderFieldsTooLarge", 451 = "UnavailableForLegalReasons", 500 = "InternalServerError", 501 = "NotImplemented", 502 = "BadGateway", 503 = "ServiceUnavailable", 504 = "GatewayTimeout", 505 = "HttpVersionNotSupported", 506 = "VariantAlsoNegotiates", 507 = "InsufficientStorage", 508 = "LoopDetected", 510 = "NotExtended", 511 = "NetworkAuthenticationRequired"

    jointLoanDetails object
    activity string
    beneficiaries string[]
    contract string
    form string
    installmentPlan object[]
  • Array [
    • DueDate date-time
    InstallmentAmount double
    InstallmentNumber int32
    InsuranceFeesAmount double
    InterestAmount double
    InterestRate double
    LoanFeesAmount double
    PaymentDate date-time
    PrincipalAmount double
    PrincipalPaymentAmount double
    RemainingCapital double
  • ]
    • interest string
    interestRateScales object[]
  • Array [
    • basicInterestRate double
    fromAmount double
    scaleInterestRate double
    toAmount double
    totalInterestRate double
  • ]
    • jointAccountInstallments object[]
  • Array [
    • accountedInstallment int32
    expirationDate date-time
    installmentAmount double
    installmentID string
    priority int32
    transactionDate date-time
  • ]
    • kad string
    linkedAccounts object[]
  • Array [
    • aA_Account int32
    accountNumber string
    isActive boolean
    isService boolean
  • ]
    • mainBeneficiary string
    overdraftLimit double
    status string
    message string
    requiredVersion int32
    status int32

    Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14]


    Description: 0 = "UNKNOWN", 1 = "OK", 2 = "FAIL", 3 = "UNAUTHORIZED", 4 = "PASSWORD_EXPIRED", 5 = "DISABLED", 6 = "BLOCKED", 7 = "TIME_OUT", 8 = "NO_INTERNET", 9 = "INVALID_ACCOUNT", 10 = "REQUIRE_UPDATE", 11 = "SYSTEM_DOWN", 12 = "PENDING_COMMAND", 13 = "PENDING_LOGIN", 14 = "REGISTERED"

Loading...