Rest API for Oracle Banking Cash Management

Retrieves the list of Discount Offers

post

/service/v1/discountOffer

This endpoint is used to retrieves the list of discount offers.

Request

Supported Media Types

application/json
application/xml

Header Parameters

appId(required): string

Application Id
branchCode(required): string

Branch Code
userId(required): string

User Id

Discount offer Search Model

Root Schema : discOfferSearchModel

Type: object

Discount offer Search Model

Show Source

applicabilityBasis: string

applicabilityBasis
autoApplicabilityBasis: string

autoApplicabilityBasis
autoApplicable: string

autoApplicable
counterparty: string

counterparty
counterpartyRole: string

counterpartyRole
discountOfferActiveStatus: string

discountOfferActiveStatus
discountRuleDesc: string

discountRuleDesc
discountRuleId: string

discountRuleId
discountType: string

discountType
earlyPaymentDate: string

earlyPaymentDate
effectiveDateFrom: string

effectiveDateFrom
effectiveDateTo: string

effectiveDateTo
expiryDateFrom: string

expiryDateFrom
expiryDateTo: string

expiryDateTo
limit: integer

limit
offset: integer

offset
orderBy: string

Order By Parameter from Third Party API
requestorParty: string

requestorParty
requestorPartyRole: string

requestorPartyRole

{
    "description":"Discount offer Search Model",
    "type":"object",
    "properties":{
        "discountRuleId":{
            "type":"string",
            "description":"discountRuleId"
        },
        "discountRuleDesc":{
            "type":"string",
            "description":"discountRuleDesc"
        },
        "discountType":{
            "type":"string",
            "description":"discountType"
        },
        "requestorPartyRole":{
            "type":"string",
            "description":"requestorPartyRole"
        },
        "requestorParty":{
            "type":"string",
            "description":"requestorParty"
        },
        "counterpartyRole":{
            "type":"string",
            "description":"counterpartyRole"
        },
        "counterparty":{
            "type":"string",
            "description":"counterparty"
        },
        "effectiveDateFrom":{
            "type":"string",
            "description":"effectiveDateFrom"
        },
        "effectiveDateTo":{
            "type":"string",
            "description":"effectiveDateTo"
        },
        "expiryDateFrom":{
            "type":"string",
            "description":"expiryDateFrom"
        },
        "expiryDateTo":{
            "type":"string",
            "description":"expiryDateTo"
        },
        "discountOfferActiveStatus":{
            "type":"string",
            "description":"discountOfferActiveStatus"
        },
        "applicabilityBasis":{
            "type":"string",
            "description":"applicabilityBasis"
        },
        "autoApplicable":{
            "type":"string",
            "description":"autoApplicable"
        },
        "autoApplicabilityBasis":{
            "type":"string",
            "description":"autoApplicabilityBasis"
        },
        "earlyPaymentDate":{
            "type":"string",
            "description":"earlyPaymentDate"
        },
        "offset":{
            "type":"integer",
            "description":"offset"
        },
        "limit":{
            "type":"integer",
            "description":"limit"
        },
        "orderBy":{
            "type":"string",
            "description":"Order By Parameter from Third Party API"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

200 Response

Successful performs the operation

Root Schema : DiscountOfferModelCollection

Type: object

Collection of Discount Offers

Show Source

data: array data
errorCode: string

errorCode
errorDescription: string

errorDescription
paging: object paging
status: string

Status

{
    "description":"Collection of Discount Offers",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DiscountOfferServiceModel"
            }
        },
        "status":{
            "description":"Status",
            "type":"string"
        },
        "errorDescription":{
            "description":"errorDescription",
            "type":"string"
        },
        "errorCode":{
            "description":"errorCode",
            "type":"string"
        },
        "paging":{
            "type":"object"
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object DiscountOfferServiceModel

Finance Transaction Model

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

Nested Schema : paging

Type: object

Nested Schema : DiscountOfferServiceModel

Type: object

Finance Transaction Model

Show Source

action: string

action
applicabilityBasis: string

applicabilityBasis
autoApplicabilityBasis: string

autoApplicabilityBasis
autoApplicable: string

autoApplicable
checkerDtStamp: string(date)

Checker Dt Stamp
checkerId: string

checkerId
chgPrcId: string

chgPrcId
chgPrcTemplateId: string

chgPrcTemplateId
counterparty: string

counterparty
counterPartyName: string

counterPartyName
counterpartyRole: string

counterpartyRole
currency: string

currency
discOfferRangeServiceModelList: array discOfferRangeServiceModelList
discountOfferActiveStatus: string

discountOfferActiveStatus
discountRate: number

discountRate
discountRuleDesc: string

discountRuleDesc
discountRuleId: string

discountRuleId
discountType: string

discountType
earlyPaymentDate: string

earlyPaymentDate
effectiveDate: string

effectiveDate
expiryDate: string

expiryDate
id: string

id
instrumentAmountFrom: number

instrumentAmountFrom
instrumentAmountTo: number

instrumentAmountTo
makerDtStamp: string(date)

Maker Dt Stamp
makerId: string

makerId
maxTenor: number

maxTenor
minTenor: number

minTenor
relationshipCode: string

relationshipCode
requestorParty: string

requestorParty
requestorPartyName: string

requestorPartyName
requestorPartyRole: string

requestorPartyRole
seqNo: integer(int64)

seqNo
slidingScaleApplicable: string

slidingScaleApplicable
sourceTxnId: string

sourceTxnId
stageId: string

stageId

{
    "description":"Finance Transaction Model",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object"
        }
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"id"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64",
            "description":"seqNo"
        },
        "discountRuleId":{
            "type":"string",
            "description":"discountRuleId"
        },
        "discountRuleDesc":{
            "type":"string",
            "description":"discountRuleDesc"
        },
        "discountType":{
            "type":"string",
            "description":"discountType"
        },
        "requestorPartyRole":{
            "type":"string",
            "description":"requestorPartyRole"
        },
        "requestorParty":{
            "type":"string",
            "description":"requestorParty"
        },
        "relationshipCode":{
            "type":"string",
            "description":"relationshipCode"
        },
        "counterpartyRole":{
            "type":"string",
            "description":"counterpartyRole"
        },
        "counterparty":{
            "type":"string",
            "description":"counterparty"
        },
        "currency":{
            "type":"string",
            "description":"currency"
        },
        "requestorPartyName":{
            "type":"string",
            "description":"requestorPartyName"
        },
        "counterPartyName":{
            "type":"string",
            "description":"counterPartyName"
        },
        "effectiveDate":{
            "type":"string",
            "description":"effectiveDate"
        },
        "expiryDate":{
            "type":"string",
            "description":"expiryDate"
        },
        "instrumentAmountFrom":{
            "type":"number",
            "description":"instrumentAmountFrom"
        },
        "instrumentAmountTo":{
            "type":"number",
            "description":"instrumentAmountTo"
        },
        "discountOfferActiveStatus":{
            "type":"string",
            "description":"discountOfferActiveStatus"
        },
        "slidingScaleApplicable":{
            "type":"string",
            "description":"slidingScaleApplicable"
        },
        "minTenor":{
            "type":"number",
            "description":"minTenor"
        },
        "maxTenor":{
            "type":"number",
            "description":"maxTenor"
        },
        "discountRate":{
            "type":"number",
            "description":"discountRate"
        },
        "makerDtStamp":{
            "type":"string",
            "format":"date",
            "description":"Maker Dt Stamp"
        },
        "makerId":{
            "type":"string",
            "description":"makerId"
        },
        "checkerDtStamp":{
            "type":"string",
            "format":"date",
            "description":"Checker Dt Stamp"
        },
        "checkerId":{
            "type":"string",
            "description":"checkerId"
        },
        "chgPrcTemplateId":{
            "type":"string",
            "description":"chgPrcTemplateId"
        },
        "chgPrcId":{
            "type":"string",
            "description":"chgPrcId"
        },
        "applicabilityBasis":{
            "type":"string",
            "description":"applicabilityBasis"
        },
        "autoApplicable":{
            "type":"string",
            "description":"autoApplicable"
        },
        "autoApplicabilityBasis":{
            "type":"string",
            "description":"autoApplicabilityBasis"
        },
        "earlyPaymentDate":{
            "type":"string",
            "description":"earlyPaymentDate"
        },
        "action":{
            "type":"string",
            "description":"action"
        },
        "stageId":{
            "type":"string",
            "description":"stageId"
        },
        "sourceTxnId":{
            "type":"string",
            "description":"sourceTxnId"
        },
        "discOfferRangeServiceModelList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DiscOfferRangeServiceModel"
            }
        }
    }
}

Match All

Show Source

allOf GenericDto
object DiscountOfferServiceModel-allOf[1]

{
    "description":"Finance Transaction Model",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object"
        }
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"id"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64",
            "description":"seqNo"
        },
        "discountRuleId":{
            "type":"string",
            "description":"discountRuleId"
        },
        "discountRuleDesc":{
            "type":"string",
            "description":"discountRuleDesc"
        },
        "discountType":{
            "type":"string",
            "description":"discountType"
        },
        "requestorPartyRole":{
            "type":"string",
            "description":"requestorPartyRole"
        },
        "requestorParty":{
            "type":"string",
            "description":"requestorParty"
        },
        "relationshipCode":{
            "type":"string",
            "description":"relationshipCode"
        },
        "counterpartyRole":{
            "type":"string",
            "description":"counterpartyRole"
        },
        "counterparty":{
            "type":"string",
            "description":"counterparty"
        },
        "currency":{
            "type":"string",
            "description":"currency"
        },
        "requestorPartyName":{
            "type":"string",
            "description":"requestorPartyName"
        },
        "counterPartyName":{
            "type":"string",
            "description":"counterPartyName"
        },
        "effectiveDate":{
            "type":"string",
            "description":"effectiveDate"
        },
        "expiryDate":{
            "type":"string",
            "description":"expiryDate"
        },
        "instrumentAmountFrom":{
            "type":"number",
            "description":"instrumentAmountFrom"
        },
        "instrumentAmountTo":{
            "type":"number",
            "description":"instrumentAmountTo"
        },
        "discountOfferActiveStatus":{
            "type":"string",
            "description":"discountOfferActiveStatus"
        },
        "slidingScaleApplicable":{
            "type":"string",
            "description":"slidingScaleApplicable"
        },
        "minTenor":{
            "type":"number",
            "description":"minTenor"
        },
        "maxTenor":{
            "type":"number",
            "description":"maxTenor"
        },
        "discountRate":{
            "type":"number",
            "description":"discountRate"
        },
        "makerDtStamp":{
            "type":"string",
            "format":"date",
            "description":"Maker Dt Stamp"
        },
        "makerId":{
            "type":"string",
            "description":"makerId"
        },
        "checkerDtStamp":{
            "type":"string",
            "format":"date",
            "description":"Checker Dt Stamp"
        },
        "checkerId":{
            "type":"string",
            "description":"checkerId"
        },
        "chgPrcTemplateId":{
            "type":"string",
            "description":"chgPrcTemplateId"
        },
        "chgPrcId":{
            "type":"string",
            "description":"chgPrcId"
        },
        "applicabilityBasis":{
            "type":"string",
            "description":"applicabilityBasis"
        },
        "autoApplicable":{
            "type":"string",
            "description":"autoApplicable"
        },
        "autoApplicabilityBasis":{
            "type":"string",
            "description":"autoApplicabilityBasis"
        },
        "earlyPaymentDate":{
            "type":"string",
            "description":"earlyPaymentDate"
        },
        "action":{
            "type":"string",
            "description":"action"
        },
        "stageId":{
            "type":"string",
            "description":"stageId"
        },
        "sourceTxnId":{
            "type":"string",
            "description":"sourceTxnId"
        },
        "discOfferRangeServiceModelList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DiscOfferRangeServiceModel"
            }
        }
    }
}

Nested Schema : discOfferRangeServiceModelList

Type: array

Show Source

Array of: object DiscOfferRangeServiceModel

discount detail

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

Nested Schema : GenericDto

Match All

Show Source

object GenericDto-allOf[0]
Generic Response.

{
    "allOf":[
        {
            "type":"object"
        },
        {
            "description":"Generic Response.",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Nested Schema : DiscountOfferServiceModel-allOf[1]

Type: object

Nested Schema : DiscOfferRangeServiceModel

Type: object

discount detail

Show Source

discountMasterId: string

discountMasterId
discountRate: number

discountRate
discountRuleId: string

discountRuleId
id: string

id
lowerDiscountRateThreshold: number

lowerDiscountRateThreshold
remainingTenorFrom: number

remainingTenorFrom
remainingTenorTo: number

remainingTenorTo
seqNo: number

seqNo
slidingScaleApplicable: string

Sliding Scale Applicable
upperDiscountRateThreshold: number

upperDiscountRateThreshold

{
    "description":"discount detail",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id"
        },
        "seqNo":{
            "type":"number",
            "description":"seqNo"
        },
        "discountRuleId":{
            "type":"string",
            "description":"discountRuleId"
        },
        "remainingTenorFrom":{
            "type":"number",
            "description":"remainingTenorFrom"
        },
        "remainingTenorTo":{
            "type":"number",
            "description":"remainingTenorTo"
        },
        "discountRate":{
            "type":"number",
            "description":"discountRate"
        },
        "upperDiscountRateThreshold":{
            "type":"number",
            "description":"upperDiscountRateThreshold"
        },
        "lowerDiscountRateThreshold":{
            "type":"number",
            "description":"lowerDiscountRateThreshold"
        },
        "discountMasterId":{
            "type":"string",
            "description":"discountMasterId"
        },
        "slidingScaleApplicable":{
            "type":"string",
            "description":"Sliding Scale Applicable"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error