Jump to

• Request
• Response

Operation to AuthorizeIDCommodity

post

/IslamicDerivativeCommodityTrackingService/IslamicDerivativeCommodityTracking/AuthorizeIDCommodity

This operation authorizes the Islamic Derivatives Commodity.

Request

Header Parameters

• BRANCH(required): string
  Enter Transaction Branch
• ENTITY: string
  Enter Entity ID
• SOURCE(required): string
  Enter Source Code of External System
• USERID(required): string
  Enter User ID

Body ()

Root Schema : ComdconrctDto

Type: object

Show Source

• authstat: string
  Indicates Authstat
• automanualflag: string
  Indicates Auto Processing
• bookdt: string
  Indicates Book Date
• brn: string
  Indicates Branach Code.
• chkdttime: string
  Indicates Date Time
• chkr: string
  Indicates Checker
• comdmasterList: array comdmasterList
• conrefno(required): string
  Indicates Contract Reference
• constat: string
  Indicates Contract Status P - Processed R - Reversed T - Tanked
• contccy: string
  Refers to Out Leg Currency
• counterpaerty: string
  Indicates Counterparty
• curreventcd: string
  Indicates Event
• esn: number
  Indicates Event Sequence Number
• eventseqno(required): number
  Indicates ESN
• extrefno: string
  Indicates Source Reference
• fundrefno: string
  Indicates Fund Reference
• latestevntcode: string
  Indicates Latest Event Code
• latverno: number
  Indicates Latest Version Number
• liabilitycif: string
  Indicates Liability CIF
• makdttime: string
  Indicates Date Time
• maker: string
  Indicates Maker
• modcd: string
  Indicates Module
• prdcd: string
  Indicates Product Code
• prdtp: string
  Indicates Product Type S - Small M - Medium L - Large
• response: string
  Indicates Response A - Accepted R - Rejected I - Interested Flag N - Not Interested T - Tell A Friend
• reversedcontref: string
  Indicates Reverse Contract Reference
• secuploadstatus: string
  Indicates Security Upload Status
• serialno: string
  Indicate serial number
• source: string
  Indicates Source Code
• stopdt: string
  Indicates Stop Date
• templatestatus: string
  Indicates Template Status
• txnstat: string
  Indicates Status K - Cancel V - Reversed S - Closed A - Active H - Hold Y - Yet to be Initiated
• userdefstat: string
  Indicates User Defined Status
• userefno: string
  Indicates User Reference

{
    "type":"object",
    "required":[
        "conrefno",
        "eventseqno"
    ],
    "properties":{
        "eventseqno":{
            "type":"number",
            "description":"Indicates ESN"
        },
        "userefno":{
            "type":"string",
            "description":"Indicates User Reference"
        },
        "latverno":{
            "type":"number",
            "description":"Indicates Latest Version Number"
        },
        "brn":{
            "type":"string",
            "description":"Indicates Branach Code."
        },
        "prdcd":{
            "type":"string",
            "description":"Indicates Product Code"
        },
        "counterpaerty":{
            "type":"string",
            "description":"Indicates  Counterparty"
        },
        "constat":{
            "type":"string",
            "description":"Indicates Contract Status\tP - Processed\tR - Reversed\tT - Tanked"
        },
        "authstat":{
            "type":"string",
            "description":"Indicates Authstat"
        },
        "templatestatus":{
            "type":"string",
            "description":"Indicates  Template Status"
        },
        "prdtp":{
            "type":"string",
            "description":"Indicates Product Type\tS - Small\tM - Medium\tL - Large"
        },
        "curreventcd":{
            "type":"string",
            "description":"Indicates  Event"
        },
        "modcd":{
            "type":"string",
            "description":"Indicates  Module"
        },
        "userdefstat":{
            "type":"string",
            "description":"Indicates  User Defined Status"
        },
        "contccy":{
            "type":"string",
            "description":"Refers to Out Leg Currency"
        },
        "latestevntcode":{
            "type":"string",
            "description":"Indicates  Latest Event Code"
        },
        "extrefno":{
            "type":"string",
            "description":"Indicates Source Reference"
        },
        "automanualflag":{
            "type":"string",
            "description":"Indicates  Auto Processing"
        },
        "fundrefno":{
            "type":"string",
            "description":"Indicates Fund Reference"
        },
        "response":{
            "type":"string",
            "description":"Indicates Response\tA - Accepted\tR - Rejected\tI - Interested Flag\tN - Not Interested\tT - Tell A Friend"
        },
        "secuploadstatus":{
            "type":"string",
            "description":"Indicates  Security Upload Status"
        },
        "stopdt":{
            "type":"string",
            "description":"Indicates  Stop Date"
        },
        "liabilitycif":{
            "type":"string",
            "description":"Indicates  Liability CIF"
        },
        "source":{
            "type":"string",
            "description":"Indicates Source Code"
        },
        "reversedcontref":{
            "type":"string",
            "description":"Indicates  Reverse Contract Reference"
        },
        "conrefno":{
            "type":"string",
            "description":"Indicates Contract Reference"
        },
        "bookdt":{
            "type":"string",
            "description":"Indicates Book Date"
        },
        "serialno":{
            "type":"string",
            "description":"Indicate serial number"
        },
        "maker":{
            "type":"string",
            "description":"Indicates Maker"
        },
        "makdttime":{
            "type":"string",
            "description":"Indicates Date Time"
        },
        "chkr":{
            "type":"string",
            "description":"Indicates Checker"
        },
        "chkdttime":{
            "type":"string",
            "description":"Indicates Date Time"
        },
        "esn":{
            "type":"number",
            "description":"Indicates Event Sequence Number"
        },
        "txnstat":{
            "type":"string",
            "description":"Indicates Status\tK - Cancel\tV - Reversed\tS - Closed\tA - Active\tH - Hold\tY - Yet to be Initiated"
        },
        "comdmasterList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ComdmasterDto"
            }
        }
    }
}

Nested Schema : comdmasterList

Type: array

Show Source

• Array of: object ComdmasterDto

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

Nested Schema : ComdmasterDto

Type: object

Show Source

• comdseettled: string
  Indicates Commodity Settled Y - on N - Off
• contrefno: string
  Indicates Contract Reference Number
• counterprtyname: string
  Indicates Counter Party Name
• countryprty: string
  Indicates Counter Party
• eventseqno: number
  Indicates ESN
• globalagmtdt: string
  Indicates Agreement Date
• globalagmtref: string
  Indicates Global Reference
• goodsdesc: string
  Indicates Goods Description
• guaranteeref: string
  Indicates Guarantee Reference
• legtype(required): string
  Indicates Leg Type
• loc: string
  Indicates Location
• operation: string
  Indicates Operation
• payment: string
  Indicates Payment
• purchaseprice: number
  Indicates Purchase Price
• purchaseunitprice: number
  Indicates Purchase Unit Price
• qty: number
  Indicates Quantity
• qtyunits: string
  Indicates Units
• saleprice: number
  Indicates Sale price
• saleunitprice: number
  Indicates Sale Unit Price
• title: string
  Indicates Prefix 1

{
    "type":"object",
    "required":[
        "legtype"
    ],
    "properties":{
        "legtype":{
            "type":"string",
            "description":"Indicates Leg Type"
        },
        "operation":{
            "type":"string",
            "description":"Indicates Operation"
        },
        "goodsdesc":{
            "type":"string",
            "description":"Indicates Goods Description"
        },
        "globalagmtref":{
            "type":"string",
            "description":"Indicates Global Reference"
        },
        "globalagmtdt":{
            "type":"string",
            "description":"Indicates Agreement Date"
        },
        "qtyunits":{
            "type":"string",
            "description":"Indicates Units"
        },
        "qty":{
            "type":"number",
            "description":"Indicates Quantity"
        },
        "purchaseprice":{
            "type":"number",
            "description":"Indicates Purchase Price"
        },
        "purchaseunitprice":{
            "type":"number",
            "description":"Indicates Purchase Unit Price"
        },
        "saleprice":{
            "type":"number",
            "description":"Indicates  Sale price"
        },
        "saleunitprice":{
            "type":"number",
            "description":"Indicates  Sale Unit Price"
        },
        "loc":{
            "type":"string",
            "description":"Indicates Location"
        },
        "counterprtyname":{
            "type":"string",
            "description":"Indicates Counter Party Name"
        },
        "title":{
            "type":"string",
            "description":"Indicates Prefix 1"
        },
        "payment":{
            "type":"string",
            "description":"Indicates Payment"
        },
        "guaranteeref":{
            "type":"string",
            "description":"Indicates  Guarantee Reference"
        },
        "comdseettled":{
            "type":"string",
            "description":"Indicates Commodity Settled\tY - on\tN - Off"
        },
        "countryprty":{
            "type":"string",
            "description":"Indicates Counter Party"
        },
        "contrefno":{
            "type":"string",
            "description":"Indicates Contract Reference Number"
        },
        "eventseqno":{
            "type":"number",
            "description":"Indicates  ESN"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

AuthorizeIDCommodity Successfully Performed

Body ()

Root Schema : RESTResponse

Type: object

Show Source

• FCUBS_ERROR_RESP: object FCUBSErrorResponse
• FCUBS_WARNING_RESP: object FCUBSWarnResponse
• Stfincle-Full: object StfincleDto

{
    "type":"object",
    "properties":{
        "Stfincle-Full":{
            "$ref":"#/definitions/StfincleDto"
        },
        "FCUBS_ERROR_RESP":{
            "$ref":"#/definitions/FCUBSErrorResponse"
        },
        "FCUBS_WARNING_RESP":{
            "$ref":"#/definitions/FCUBSWarnResponse"
        }
    }
}

Nested Schema : FCUBSErrorResponse

Type: object

Show Source

• ERROR: array ERROR

{
    "type":"object",
    "properties":{
        "ERROR":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FCUBSError"
            }
        }
    }
}

Nested Schema : FCUBSWarnResponse

Type: object

Show Source

• WARNING: array WARNING

{
    "type":"object",
    "properties":{
        "WARNING":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FCUBSWarn"
            }
        }
    }
}

Nested Schema : StfincleDto

Type: object

Show Source

• authstat: string
  Indicates Authstat
• checker: string
  Indicates Checker
• checkerstamp: string
  Indicates Checkerstamp
• description: string
  Indicates Description
• fcEndDate(required): string
  Indicates End Date
• fcStartDate(required): string
  Indicates Start Date
• finCycle(required): string
  Indicates Financial Cycle
• maker: string
  Indicates Maker
• makerstamp: string
  Indicates Makerstamp
• modno: number
  Indicates Modno
• onceauth: string
  Indicates Onceauth
• stprdcdsList: array stprdcdsList
• txnstat: string
  Indicates Txnstat
• udf: string
  Indicates Udf

{
    "type":"object",
    "required":[
        "fcEndDate",
        "fcStartDate",
        "finCycle"
    ],
    "properties":{
        "finCycle":{
            "type":"string",
            "description":"Indicates Financial Cycle"
        },
        "fcStartDate":{
            "type":"string",
            "description":"Indicates Start Date"
        },
        "description":{
            "type":"string",
            "description":"Indicates Description"
        },
        "fcEndDate":{
            "type":"string",
            "description":"Indicates End Date"
        },
        "udf":{
            "type":"string",
            "description":"Indicates Udf"
        },
        "maker":{
            "type":"string",
            "description":"Indicates Maker"
        },
        "makerstamp":{
            "type":"string",
            "description":"Indicates Makerstamp"
        },
        "checker":{
            "type":"string",
            "description":"Indicates Checker"
        },
        "checkerstamp":{
            "type":"string",
            "description":"Indicates Checkerstamp"
        },
        "modno":{
            "type":"number",
            "description":"Indicates Modno"
        },
        "txnstat":{
            "type":"string",
            "description":"Indicates Txnstat"
        },
        "authstat":{
            "type":"string",
            "description":"Indicates Authstat"
        },
        "onceauth":{
            "type":"string",
            "description":"Indicates Onceauth"
        },
        "stprdcdsList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StprdcdsDto"
            }
        }
    }
}

Nested Schema : ERROR

Type: array

Show Source

• Array of: object FCUBSError

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

Nested Schema : FCUBSError

Type: object

Show Source

• ECODE: string
• EDESC: string

{
    "type":"object",
    "properties":{
        "ECODE":{
            "type":"string"
        },
        "EDESC":{
            "type":"string"
        }
    }
}

Nested Schema : WARNING

Type: array

Show Source

• Array of: object FCUBSWarn

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

Nested Schema : FCUBSWarn

Type: object

Show Source

• WCODE: string
• WDESC: string

{
    "type":"object",
    "properties":{
        "WCODE":{
            "type":"string"
        },
        "WDESC":{
            "type":"string"
        }
    }
}

Nested Schema : stprdcdsList

Type: array

Show Source

• Array of: object StprdcdsDto

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

Nested Schema : StprdcdsDto

Type: object

Show Source

• fcEndDate(required): string
  Indicates End Date
• fcStartDate: string
  Indicates Start Date
• finCycle: string
  Indicates FinCycle
• periodCode(required): string
  Indicates Period Code

{
    "type":"object",
    "required":[
        "fcEndDate",
        "periodCode"
    ],
    "properties":{
        "periodCode":{
            "type":"string",
            "description":"Indicates Period Code"
        },
        "fcStartDate":{
            "type":"string",
            "description":"Indicates Start Date"
        },
        "fcEndDate":{
            "type":"string",
            "description":"Indicates End Date"
        },
        "finCycle":{
            "type":"string",
            "description":"Indicates FinCycle"
        }
    }
}

400 Response

Failed while processing request

401 Response

User Not Authorized

405 Response

Method Not Allowed

500 Response

Internal Server Error

Back to Top