Rest API for Oracle Banking Cash Management

Instruments payments status

post

/service/v1/isInstrumentPmtInProgress

This endpoint is used to check instruments payments status info.

Request

Supported Media Types

application/json
application/xml

Header Parameters

appId(required): string

Application Id
branchCode(required): string

Branch Code
userId(required): string

User Id

Request Body that contains data required for checking instrument or payment status.

Root Schema : InstrumentPmtCollection

Type: object

List of InstrumentPmt

Show Source

InstrumentPmtModelList: array InstrumentPmtModelList

{
    "description":"List of InstrumentPmt",
    "type":"object",
    "properties":{
        "InstrumentPmtModelList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/InstrumentPmtModel"
            }
        }
    }
}

Nested Schema : InstrumentPmtModelList

Type: array

Show Source

Array of: object InstrumentPmtModel

Instrument Payment Model

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

Nested Schema : InstrumentPmtModel

Type: object

Instrument Payment Model

Show Source

financeReferenceNo: string

Instrument finance reference number
isInProgress: string

isInProgress
paymentReferenceNo: string

Payment reference number

{
    "description":"Instrument Payment Model",
    "type":"object",
    "properties":{
        "financeReferenceNo":{
            "type":"string",
            "description":"Instrument finance reference number"
        },
        "paymentReferenceNo":{
            "type":"string",
            "description":"Payment reference number"
        },
        "isInProgress":{
            "type":"string",
            "description":"isInProgress"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

201 Response

Returns the details of instrument or payment status

Root Schema : InstrumentPmtResponseCollection

Type: object

List of InstrumentPmt

Show Source

errCode: string

errCode
errDesc: string

errDesc
InstrumentPmtModelList: array InstrumentPmtModelList

{
    "description":"List of InstrumentPmt",
    "type":"object",
    "properties":{
        "InstrumentPmtModelList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/InstrumentPmtModel"
            }
        },
        "errCode":{
            "type":"string",
            "description":"errCode"
        },
        "errDesc":{
            "type":"string",
            "description":"errDesc"
        }
    }
}

Nested Schema : InstrumentPmtModelList

Type: array

Show Source

Array of: object InstrumentPmtModel

Instrument Payment Model

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

Nested Schema : InstrumentPmtModel

Type: object

Instrument Payment Model

Show Source

financeReferenceNo: string

Instrument finance reference number
isInProgress: string

isInProgress
paymentReferenceNo: string

Payment reference number

{
    "description":"Instrument Payment Model",
    "type":"object",
    "properties":{
        "financeReferenceNo":{
            "type":"string",
            "description":"Instrument finance reference number"
        },
        "paymentReferenceNo":{
            "type":"string",
            "description":"Payment reference number"
        },
        "isInProgress":{
            "type":"string",
            "description":"isInProgress"
        }
    }
}

400 Response

Bad Request

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error