Jump to

• Request
• Response

Retrieves the list of Netting Transactions

get

/service/v1/getNettingInquiry

This API retrieves the list of Netting Transactions.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• fromNettTxnDate: string
  Netting Txn From Date
• fromPayInOutDate: string
  PayInOut From Date
• fromSettDate: string
  Settlement From Date
• limit: integer
  Limit

  Default Value: 0
• nettingCcy: string
  Netting Currency
• nettingTxnNo: string
  Back Office Reference No of Netting Txn
• nettingTxnStatus: string
  Netting Txn Status
• offset: integer
  Offset

  Default Value: 0
• partyId(required): string
  Logged in Party Id
• toNettTxnDate: string
  Netting Txn To Date
• toPayInOutToDate: string
  PayInOut To Date
• toSettDate: string
  Settlement To Date

Header Parameters

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successfully performs the operation

Body ()

Root Schema : NettingTxnInquiryCollection

Type: object

Collection of Netting Transactions.

Show Source

• data: array data
• errors: array errors
• message: string
• paging: object PagingDto
• responseStatus: string

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

Nested Schema : data

Type: array

Show Source

• Array of: object NettingTxnInquiryModel
  Netting Transactions Inquiry model

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

Nested Schema : errors

Type: array

Show Source

• Array of: object ErrorDTO
  Netting Transactions Status Update Errors

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults: integer

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

Nested Schema : NettingTxnInquiryModel

Type: object

Netting Transactions Inquiry model

Show Source

• beneficiaryId: string
  Beneficiary Id
• id: string
  Id
• loginEntityType: string
  Login Entity Type
• modNo: integer
  Mod No
• netPayIn: number
  Net Pay In
• netPayOut: number
  Net Pay Out
• nettingTxnDate: string
  Netting Txn Date
• nettingTxnNo: string
  Netting Txn No
• nettingTxnStatus: string
  Netting Txn Status
• nettingTxnType: string
  Netting Txn Type
• payInOutDate: string
  PayInOut Date
• payInStatus: string
  Pay In Status
• payOutStatus: string
  Pay Out Status
• settlementDate: string
  Settlement Date
• stage: string
  Stage
• structureDescription: string
  Structure Description
• transactionOwnerDescription: string
  Transaction Owner Description
• transactionOwnerRole: string
  Transaction Owner Role

{
    "description":"Netting Transactions Inquiry model",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "modNo":{
            "type":"integer",
            "description":"Mod No"
        },
        "nettingTxnNo":{
            "type":"string",
            "description":"Netting Txn No"
        },
        "nettingTxnDate":{
            "type":"string",
            "description":"Netting Txn Date"
        },
        "settlementDate":{
            "type":"string",
            "description":"Settlement Date"
        },
        "payInOutDate":{
            "type":"string",
            "description":"PayInOut Date"
        },
        "netPayIn":{
            "type":"number",
            "description":"Net Pay In"
        },
        "netPayOut":{
            "type":"number",
            "description":"Net Pay Out"
        },
        "nettingTxnStatus":{
            "type":"string",
            "description":"Netting Txn Status"
        },
        "payInStatus":{
            "type":"string",
            "description":"Pay In Status"
        },
        "stage":{
            "type":"string",
            "description":"Stage"
        },
        "payOutStatus":{
            "type":"string",
            "description":"Pay Out Status"
        },
        "loginEntityType":{
            "type":"string",
            "description":"Login Entity Type"
        },
        "nettingTxnType":{
            "type":"string",
            "description":"Netting Txn Type"
        },
        "beneficiaryId":{
            "type":"string",
            "description":"Beneficiary Id"
        },
        "structureDescription":{
            "type":"string",
            "description":"Structure Description"
        },
        "transactionOwnerRole":{
            "type":"string",
            "description":"Transaction Owner Role"
        },
        "transactionOwnerDescription":{
            "type":"string",
            "description":"Transaction Owner Description"
        }
    }
}

Nested Schema : ErrorDTO

Type: object

Netting Transactions Status Update Errors

Show Source

• errorCode: string
  Error Code
• errorDesc: string
  Error Description

{
    "description":"Netting Transactions Status Update Errors",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Description"
        }
    }
}

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