Jump to

• Request
• Response

Inquire the list of the Netting Transactions

get

/service/v1/getNettingTxn

This endpoint provides the list of Netting Transactions for a given set of parameters.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• acceptRejectDateFrom(optional): string
  Acceptance/rejection Date Range of Netting Transaction in yyyy-MM-dd format
• acceptRejectDateTo(optional): string
  Acceptance/rejection Date Range of Netting Transaction in yyyy-MM-dd format
• agreementCode(optional): string
  Agreement Id Associated with Netting Transaction
• associatedPartyId(optional): string
  Associated Party Id/Counterparty Id linked to Netted Transaction
• corporateId: string
  Logged in CIF Id of Source System
• creationDateFrom(optional): string
  Creation Date Range of Netting Transaction in yyyy-MM-dd format
• creationDateTo(optional): string
  Creation Date Range of Netting Transaction in yyyy-MM-dd format
• isNetReceivablePayable(optional): string
  Transaction Status of Netting Transaction
• limit(optional): integer
  Limit is maximum no of records to be fetched
• nettingCcy(optional): string
  Currency of Netting Transaction
• nettingTxnAmtFrom(optional): number
  Netting Transaction Amount from
• nettingTxnAmtTo(optional): number
  Netting Transaction Amount to
• nettingTxnNo(optional): string
  Back Office Reference No of Netting Txn
• nettingTxnStatus(optional): string
  Transaction Status of Netting Transaction
• offset(optional): integer
  Offset is starting no of records to be fetched
• settlementDateFrom(optional): string
  Settlement Date Range of Netting Transaction in yyyy-MM-dd format
• settlementDateTo(optional): string
  Settlement Date Range of Netting Transaction in yyyy-MM-dd format

Header Parameters

• appId: string
  Source Application Id
• branchCode: string
  Branch Code
• userId: string
  Source User id

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successfully performs the operation

Body ()

Root Schema : NettingTransactionCollection

Type: object

Collection of Netting Transactions.

Show Source

• data(optional): array data
• message(optional): string
• paging(optional): object PagingDto
• responseStatus(optional): string

{
    "description":"Collection of Netting Transactions.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/NettingTransactionModel"
            }
        },
        "paging":{
            "description":"Paging DTO Model",
            "$ref":"#/definitions/PagingDto"
        },
        "responseStatus":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object NettingTransactionModel
  Service Get API Netting Transactions model

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : NettingTransactionModel

Type: object

Service Get API Netting Transactions model

Show Source

• acceptRejectDate(optional): string
  Acceptance/rejection date of netting transaction
• corporateId(optional): string
  Logged in CIF id of source system
• corporateName(optional): string
  Corporate Name
• counterpartyId(optional): string
  Associated party id/counterparty id linked to netted transactions
• counterpartyName(optional): string
  Counterparty Name
• creationDate(optional): string
  Creation date of netting transaction
• isSettlementFlag(optional): string
  Is Settlement Flag
• lastUpdatedDate(optional): string
  Last Updated Date
• netPayablesDue(optional): number
  Net Payables Due
• netReceivablesDue(optional): number
  Net Receivables Due
• nettingAgreement(optional): string
  Agreement id associated with netting transaction
• nettingAmount(optional): number
  Netting transaction Amount
• nettingCcy(optional): string
  Currency of netting transaction
• nettingTxnNo(optional): string
  Back office reference no of Netting Txn
• nettingTxnStatus(optional): string
  Netting Transaction Status
• relationshipCode(optional): string
  Relationship Code
• remarks(optional): string
  Remarks
• settlementDate(optional): string
  Settlement date range of netting transaction
• totalPayables(optional): number
  Total Payables
• totalReceivables(optional): number
  Total Receivables

{
    "description":"Service Get API Netting Transactions model",
    "type":"object",
    "properties":{
        "nettingTxnNo":{
            "type":"string",
            "description":"Back office reference no of Netting Txn"
        },
        "corporateId":{
            "type":"string",
            "description":"Logged in CIF id of source system"
        },
        "nettingCcy":{
            "type":"string",
            "description":"Currency of netting transaction"
        },
        "counterpartyId":{
            "type":"string",
            "description":"Associated party id/counterparty id linked to netted transactions"
        },
        "nettingAgreement":{
            "type":"string",
            "description":"Agreement id associated with netting transaction"
        },
        "creationDate":{
            "type":"string",
            "description":"Creation date of netting transaction"
        },
        "acceptRejectDate":{
            "type":"string",
            "description":"Acceptance/rejection date of netting transaction"
        },
        "settlementDate":{
            "type":"string",
            "description":"Settlement date range of netting transaction"
        },
        "nettingAmount":{
            "type":"number",
            "description":"Netting transaction Amount"
        },
        "relationshipCode":{
            "type":"string",
            "description":"Relationship Code"
        },
        "totalReceivables":{
            "type":"number",
            "description":"Total Receivables"
        },
        "totalPayables":{
            "type":"number",
            "description":"Total Payables"
        },
        "netReceivablesDue":{
            "type":"number",
            "description":"Net Receivables Due"
        },
        "netPayablesDue":{
            "type":"number",
            "description":"Net Payables Due"
        },
        "nettingTxnStatus":{
            "type":"string",
            "description":"Netting Transaction Status"
        },
        "counterpartyName":{
            "type":"string",
            "description":"Counterparty Name"
        },
        "corporateName":{
            "type":"string",
            "description":"Corporate Name"
        },
        "isSettlementFlag":{
            "type":"string",
            "description":"Is Settlement Flag"
        },
        "remarks":{
            "type":"string",
            "description":"Remarks"
        },
        "lastUpdatedDate":{
            "type":"string",
            "description":"Last Updated Date"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top