Jump to

• Request
• Response

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(optional): string
  Authentication Status to determine if record is authorized (A) or unauthorized (U).
• branchCode(optional): string
  Branch Code for SMS
• includecloseandunauth(optional): boolean
  includecloseandunauth needs to be set to fetch summary record, defult value is false
• limit(optional): integer
  Limit is maximum number of records to be fetched
• networkType(optional): string
  Network Type of the record that needs to be fetched
• offset(optional): integer
  Offset is starting number of records to be fetched
• productCategory(optional): string
  Product Category of the record that needs to be fetched
• productCode(optional): string
  Product Code of the record that needs to be fetched
• productDescription(optional): string
  Product Description of the record that needs to be fetched
• productType(optional): string
  Product Type of the record that needs to be fetched
• recordStat(optional): string
  Record Status

Header Parameters

• appId: string
  Application Id for SMS
• branchCode: string
  Branch Code for SMS
• userId: string
  User Id for SMS

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string
  URL of newly created productmaster

Body ()

Root Schema : CmTmProductMasterCollection

Type: object

Collection of product.

Show Source

• data(optional): array data
• paging(optional): 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(optional): 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(optional): string
  Branch Code
• clearingDays(optional): number
  Clearing Days
• currency(optional): string
  Currency
• cutOffTime(optional): string
  Cut-Off Time
• effectiveDate(optional): string
  Effective Date
• expiryDate(optional): string
  Expiry Date
• maxTxnAmt(optional): number
  Maximum Transaction Amount
• minTxnAmt(optional): number
  Minimum Transaction Amount
• networkType(optional): string
  Network Type
• productCategory(optional): string
  Product Category
• productCode(optional): string
  Product Code
• productDescription(optional): string
  Product Description
• productExposureLimit(optional): number
  Product Exposure Limit
• productType(optional): string
  Product Type
• txnControllerRefNo(optional): 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

Back to Top