Rest API for Oracle Banking Cash Management

Fetch the products of cash and instrument collections

get

/service/v1/product

This API fetches products of cash and instrument collections based on given parameters.

Request

Supported Media Types

application/json
application/xml

Query Parameters

authStat: string

Authentication Status to determine if record is authorized (A) or unauthorized (U).
branchCode: string

Branch Code for SMS
includecloseandunauth: boolean

includecloseandunauth needs to be set to fetch summary record, defult value is false
limit: integer

Limit is maximum number of records to be fetched
networkType: string

Network Type of the record that needs to be fetched
offset: integer

Offset is starting number of records to be fetched
productCategory: string

Product Category of the record that needs to be fetched
productCode: string

Product Code of the record that needs to be fetched
productDescription: string

Product Description of the record that needs to be fetched
productType: string

Product Type of the record that needs to be fetched
recordStat: string

Record Status

Header Parameters

appId(required): string

Application Id for SMS
branchCode(required): string

Branch Code for SMS
userId(required): string

User Id for SMS

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of succes or failure

Headers

Location: string

URL of newly created productmaster

Root Schema : CmTmProductMasterCollection

Type: object

Collection of product.

Show Source

data: array data
paging: object PagingDto

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

Nested Schema : data

Type: array

Show Source

Array of: object CmTmProductMasterDTO

Contains details of the product.

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

Nested Schema : PagingDto

Type: object

Show Source

totalResults: integer

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

Nested Schema : CmTmProductMasterDTO

Type: object

Contains details of the product.

Match All

Show Source

allOf GenericDto
object CmTmProductMasterDTO-allOf[1]

{
    "description":"Contains details of the product.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "branchCode":{
                    "type":"string",
                    "description":"Branch Code"
                },
                "clearingDays":{
                    "type":"number",
                    "description":"Clearing Days"
                },
                "currency":{
                    "type":"string",
                    "description":"Currency"
                },
                "cutOffTime":{
                    "type":"string",
                    "description":"Cut-Off Time"
                },
                "effectiveDate":{
                    "type":"string",
                    "description":"Effective Date"
                },
                "expiryDate":{
                    "type":"string",
                    "description":"Expiry Date"
                },
                "maxTxnAmt":{
                    "type":"number",
                    "description":"Maximum Transaction Amount"
                },
                "minTxnAmt":{
                    "type":"number",
                    "description":"Minimum Transaction Amount"
                },
                "networkType":{
                    "type":"string",
                    "description":"Network Type"
                },
                "productCategory":{
                    "type":"string",
                    "description":"Product Category"
                },
                "productCode":{
                    "type":"string",
                    "description":"Product Code"
                },
                "productDescription":{
                    "type":"string",
                    "description":"Product Description"
                },
                "productExposureLimit":{
                    "type":"number",
                    "description":"Product Exposure Limit"
                },
                "productType":{
                    "type":"string",
                    "description":"Product Type"
                },
                "txnControllerRefNo":{
                    "type":"string",
                    "description":"Transaction Controller Ref Number"
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

object GenericDto-allOf[0]

Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : CmTmProductMasterDTO-allOf[1]

Type: object

Show Source

branchCode: string

Branch Code
clearingDays: number

Clearing Days
currency: string

Currency
cutOffTime: string

Cut-Off Time
effectiveDate: string

Effective Date
expiryDate: string

Expiry Date
maxTxnAmt: number

Maximum Transaction Amount
minTxnAmt: number

Minimum Transaction Amount
networkType: string

Network Type
productCategory: string

Product Category
productCode: string

Product Code
productDescription: string

Product Description
productExposureLimit: number

Product Exposure Limit
productType: string

Product Type
txnControllerRefNo: string

Transaction Controller Ref Number

{
    "type":"object",
    "properties":{
        "branchCode":{
            "type":"string",
            "description":"Branch Code"
        },
        "clearingDays":{
            "type":"number",
            "description":"Clearing Days"
        },
        "currency":{
            "type":"string",
            "description":"Currency"
        },
        "cutOffTime":{
            "type":"string",
            "description":"Cut-Off Time"
        },
        "effectiveDate":{
            "type":"string",
            "description":"Effective Date"
        },
        "expiryDate":{
            "type":"string",
            "description":"Expiry Date"
        },
        "maxTxnAmt":{
            "type":"number",
            "description":"Maximum Transaction Amount"
        },
        "minTxnAmt":{
            "type":"number",
            "description":"Minimum Transaction Amount"
        },
        "networkType":{
            "type":"string",
            "description":"Network Type"
        },
        "productCategory":{
            "type":"string",
            "description":"Product Category"
        },
        "productCode":{
            "type":"string",
            "description":"Product Code"
        },
        "productDescription":{
            "type":"string",
            "description":"Product Description"
        },
        "productExposureLimit":{
            "type":"number",
            "description":"Product Exposure Limit"
        },
        "productType":{
            "type":"string",
            "description":"Product Type"
        },
        "txnControllerRefNo":{
            "type":"string",
            "description":"Transaction Controller Ref Number"
        }
    }
}

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