Rest API for Oracle Banking Liquidity Management

Get all valid loan

get

/loan

This endpoint is used to get all valid loan maintenance records.

Request

Supported Media Types

application/json
application/xml

Query Parameters

borrowingCustomerId(optional): string

borrower customer ID
creditDisbursementAccount(optional): string

credit disbursement account
customerId1(optional): string

customer 1 Id
customerId2(optional): string

customer 2 ID
debitDisbursementAccount(optional): string

dedit disbursement account
debitDisbursementAmount(optional): number

debit amount
debitDisbursementAmountFrom(optional): number

Pattern: ^[0-9]*[.]?[0-9]*$

debit amount from
debitDisbursementAmountTo(optional): number

Pattern: ^[0-9]*[.]?[0-9]*$

debit amount to
debitDisbursementCurrency(optional): string

debit disbursement currency
disbursementDateFrom(optional): string

loan date from
disbursementDateTo(optional): string

loan date to
iclReference(optional): string

icl reference
lendingCustomerId(optional): string

lender customer ID
limit(optional): integer

limit is maximum no of records to be fetched
loanIcProductCode(optional): string

loan IC product
loanMaturityDate(optional): string

loan maturity date
loanReference(optional): string

loan reference
loanStatus(optional): string

loan status
loanType(optional): string

loan type
offset(optional): integer

offset is starting no of records to be fetched
parentCustomerId(optional): string

parent customer Id
settlementReference(optional): string

settlement reference
sweepId(optional): string

sweep id
sweepLogId(optional): string

sweep logid

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of succes or failure

Headers

Location: string

Root Schema : IclTbLoanCollection

Type: object

Collection of loan.

Show Source

data(optional): array data
paging(optional): object PagingDto

{
    "description":"Collection of loan.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IclTbLoanDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object IclTbLoanDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/IclTbLoanDTO"
    }
}

Nested Schema : PagingDto

Type: object

Show Source

totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : IclTbLoanDTO

Type: object

Show Source

autoSettleOnMaturity(optional): string
bookingMode(optional): string
borrowingCustomerId(optional): string
borrowingCustomerName(optional): string
creditDisbursementAccount(optional): string
creditDisbursementAccountDesc(optional): string
creditDisbursementAmount(optional): number
creditDisbursementCurrency(optional): string
debitDisbursementAccount(optional): string
debitDisbursementAmount(optional): number
debitDisbursementCurrency(optional): string
debitDisbursementDesc(optional): string
exchangeLoanRate(optional): number
iclBookingReport(optional): string
iclReference(optional): string
iclSettlementReport(optional): string
IclTbLoanTransactionDTO(optional): array IclTbLoanTransactionDTO
interestAccrualFrequency(optional): string
interestAccrued(optional): number
interestLiquidationFrequency(optional): string
interestOs(optional): number
lendingCustomerId(optional): string
lendingCustomerName(optional): string
liquidateInterest(optional): string
loanDate(optional): string
loanIcProductCode(optional): string
loanInterestRate(optional): number
loanMaturityDate(optional): string
loanOs(optional): number
loanReference(optional): string
loanStatus(optional): string
loanType(optional): string
parentCustomerId(optional): string
parentCustomerName(optional): string
settlementDate(optional): string
settlementReference(optional): string
structureDesc(optional): string
structureId(optional): string

Pattern: [0-9a-fA-Z-]{1,36}
structureMasterId(optional): string
structureMasterVersionNo(optional): integer
sweepId(optional): string
sweepLogId(optional): string

{
    "type":"object",
    "properties":{
        "autoSettleOnMaturity":{
            "type":"string",
            "description":""
        },
        "bookingMode":{
            "type":"string",
            "description":""
        },
        "borrowingCustomerId":{
            "type":"string",
            "description":""
        },
        "borrowingCustomerName":{
            "type":"string",
            "description":""
        },
        "creditDisbursementAccount":{
            "type":"string",
            "description":""
        },
        "creditDisbursementAccountDesc":{
            "type":"string",
            "description":""
        },
        "creditDisbursementAmount":{
            "type":"number",
            "description":""
        },
        "creditDisbursementCurrency":{
            "type":"string",
            "description":""
        },
        "debitDisbursementAccount":{
            "type":"string",
            "description":""
        },
        "debitDisbursementAmount":{
            "type":"number",
            "description":""
        },
        "debitDisbursementCurrency":{
            "type":"string",
            "description":""
        },
        "debitDisbursementDesc":{
            "type":"string",
            "description":""
        },
        "exchangeLoanRate":{
            "type":"number",
            "description":""
        },
        "iclBookingReport":{
            "type":"string",
            "description":""
        },
        "iclReference":{
            "type":"string",
            "description":""
        },
        "iclSettlementReport":{
            "type":"string",
            "description":""
        },
        "interestAccrualFrequency":{
            "type":"string",
            "description":""
        },
        "interestAccrued":{
            "type":"number",
            "description":""
        },
        "interestLiquidationFrequency":{
            "type":"string",
            "description":""
        },
        "interestOs":{
            "type":"number",
            "description":""
        },
        "lendingCustomerId":{
            "type":"string",
            "description":""
        },
        "lendingCustomerName":{
            "type":"string",
            "description":""
        },
        "liquidateInterest":{
            "type":"string",
            "description":""
        },
        "loanDate":{
            "type":"string",
            "description":""
        },
        "loanIcProductCode":{
            "type":"string",
            "description":""
        },
        "loanInterestRate":{
            "type":"number",
            "description":""
        },
        "loanMaturityDate":{
            "type":"string",
            "description":""
        },
        "loanOs":{
            "type":"number",
            "description":""
        },
        "loanReference":{
            "type":"string",
            "description":""
        },
        "loanStatus":{
            "type":"string",
            "description":""
        },
        "loanType":{
            "type":"string",
            "description":""
        },
        "parentCustomerId":{
            "type":"string",
            "description":""
        },
        "parentCustomerName":{
            "type":"string",
            "description":""
        },
        "settlementDate":{
            "type":"string",
            "description":""
        },
        "settlementReference":{
            "type":"string",
            "description":""
        },
        "structureId":{
            "type":"string",
            "description":"",
            "pattern":"[0-9a-fA-Z-]{1,36}"
        },
        "structureDesc":{
            "type":"string",
            "description":""
        },
        "structureMasterId":{
            "type":"string",
            "description":""
        },
        "structureMasterVersionNo":{
            "type":"integer",
            "description":""
        },
        "sweepId":{
            "type":"string",
            "description":""
        },
        "sweepLogId":{
            "type":"string",
            "description":""
        },
        "IclTbLoanTransactionDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IclTbLoanTransactionDTO"
            }
        }
    }
}

Nested Schema : IclTbLoanTransactionDTO

Type: array

Show Source

Array of: object IclTbLoanTransactionDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/IclTbLoanTransactionDTO"
    }
}

Nested Schema : IclTbLoanTransactionDTO

Type: object

Show Source

basicAmount(optional): number
currency(optional): string
days(optional): number
endDate(optional): string
id(optional): string
interestMethod(optional): string
interestPaid(optional): number
loanId(optional): string
principalPaid(optional): number
rate(optional): number
startDate(optional): string
valueDate(optional): string

{
    "type":"object",
    "properties":{
        "basicAmount":{
            "type":"number",
            "description":""
        },
        "currency":{
            "type":"string",
            "description":""
        },
        "days":{
            "type":"number",
            "description":""
        },
        "endDate":{
            "type":"string",
            "description":""
        },
        "id":{
            "type":"string",
            "description":""
        },
        "interestMethod":{
            "type":"string",
            "description":""
        },
        "interestPaid":{
            "type":"number",
            "description":""
        },
        "loanId":{
            "type":"string",
            "description":""
        },
        "principalPaid":{
            "type":"number",
            "description":""
        },
        "rate":{
            "type":"number",
            "description":""
        },
        "startDate":{
            "type":"string",
            "description":""
        },
        "valueDate":{
            "type":"string",
            "description":""
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error