Rest API for Oracle Banking Corporate Lending

Create an External Response

post

/OLExternalResponseService/OLExternalResponse/CreateExResponse

This operation creates an external response using OLExternalResponse Service (OLDEXRES).

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

Root Schema : ExresMasDto

Type: object

Show Source

exresDetList: array exresDetList
masCommMode: string

Indicates MasCommMode
masDestinationSource: string

Indicates MasDestinationSource
masExtStatus: string

Indicates MasExtStatus
masForcePost: string

Indicates MasForcePost
masKeyid: string

Indicates MasKeyid
masLogTime: string

Indicates MasLogTime
masMsgid(required): string

Indicates MasMsgid
masProcessStatus: string

Indicates MasProcessStatus
masRetryCount: number

Indicates MasRetryCount
masSeqNo(required): number

Indicates MasSeqNo
masServiceCode: string

Indicates MasServiceCode

{
    "type":"object",
    "required":[
        "masMsgid",
        "masSeqNo"
    ],
    "properties":{
        "masMsgid":{
            "type":"string",
            "description":"Indicates MasMsgid"
        },
        "masCommMode":{
            "type":"string",
            "description":"Indicates MasCommMode"
        },
        "masForcePost":{
            "type":"string",
            "description":"Indicates MasForcePost"
        },
        "masProcessStatus":{
            "type":"string",
            "description":"Indicates MasProcessStatus"
        },
        "masRetryCount":{
            "type":"number",
            "description":"Indicates MasRetryCount"
        },
        "masKeyid":{
            "type":"string",
            "description":"Indicates MasKeyid"
        },
        "masExtStatus":{
            "type":"string",
            "description":"Indicates MasExtStatus"
        },
        "masLogTime":{
            "type":"string",
            "description":"Indicates MasLogTime"
        },
        "masSeqNo":{
            "type":"number",
            "description":"Indicates MasSeqNo"
        },
        "masDestinationSource":{
            "type":"string",
            "description":"Indicates MasDestinationSource"
        },
        "masServiceCode":{
            "type":"string",
            "description":"Indicates MasServiceCode"
        },
        "exresDetList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExresDetDto"
            }
        }
    }
}

Nested Schema : exresDetList

Type: array

Show Source

Array of: object ExresDetDto

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

Nested Schema : ExresDetDto

Type: object

Show Source

detErrorCodes: string

Indicates DetErrorCodes
detErrorParam: string

Indicates DetErrorParam
detExtStatus: string

Indicates DetExtStatus
detMsgid(required): string

Indicates DetMsgid
detReqSerialNo(required): number

Indicates DetReqSerialNo
detRequestTime: string

Indicates DetRequestTime
detRequestXml: string

Indicates DetRequestXml
detResponseTime: string

Indicates DetResponseTime
detResponseXml: string

Indicates DetResponseXml
detSeqNo(required): number

Indicates DetSeqNo
detVersioned: string

Indicates DetVersioned

{
    "type":"object",
    "required":[
        "detMsgid",
        "detReqSerialNo",
        "detSeqNo"
    ],
    "properties":{
        "detReqSerialNo":{
            "type":"number",
            "description":"Indicates DetReqSerialNo"
        },
        "detErrorCodes":{
            "type":"string",
            "description":"Indicates DetErrorCodes"
        },
        "detErrorParam":{
            "type":"string",
            "description":"Indicates DetErrorParam"
        },
        "detResponseXml":{
            "type":"string",
            "description":"Indicates DetResponseXml"
        },
        "detRequestTime":{
            "type":"string",
            "description":"Indicates DetRequestTime"
        },
        "detVersioned":{
            "type":"string",
            "description":"Indicates DetVersioned"
        },
        "detSeqNo":{
            "type":"number",
            "description":"Indicates DetSeqNo"
        },
        "detResponseTime":{
            "type":"string",
            "description":"Indicates DetResponseTime"
        },
        "detMsgid":{
            "type":"string",
            "description":"Indicates DetMsgid"
        },
        "detExtStatus":{
            "type":"string",
            "description":"Indicates DetExtStatus"
        },
        "detRequestXml":{
            "type":"string",
            "description":"Indicates DetRequestXml"
        }
    }
}

Response

Supported Media Types

application/json

201 Response

CreateExResponse Successfully Performed

Root Schema : RESTResponse

Type: object

Show Source

Bulk-Pymnt-Master-Full: object BulkPymntMasterDto
FCUBS_ERROR_RESP: object FCUBSErrorResponse
FCUBS_WARNING_RESP: object FCUBSWarnResponse

{
    "type":"object",
    "properties":{
        "Bulk-Pymnt-Master-Full":{
            "$ref":"#/definitions/BulkPymntMasterDto"
        },
        "FCUBS_ERROR_RESP":{
            "$ref":"#/definitions/FCUBSErrorResponse"
        },
        "FCUBS_WARNING_RESP":{
            "$ref":"#/definitions/FCUBSWarnResponse"
        }
    }
}

Nested Schema : BulkPymntMasterDto

Type: object

Show Source

actionCode: string

Indicates ActionCode
counterparty: string

Indicates Counterparty
currency: string

Indicates Currency
finalResponseStatus: string

Indicates FinalResponseStatus
processingDate: string

Indicates ProcessingDate
processRefNo: string

Indicates ProcessRefNo
pymntHdrList: array pymntHdrList
simulate: string

Indicates Simulate
totalAmountPaid: number

Indicates TotalAmountPaid

{
    "type":"object",
    "properties":{
        "processRefNo":{
            "type":"string",
            "description":"Indicates ProcessRefNo"
        },
        "simulate":{
            "type":"string",
            "description":"Indicates Simulate"
        },
        "counterparty":{
            "type":"string",
            "description":"Indicates Counterparty"
        },
        "processingDate":{
            "type":"string",
            "description":"Indicates ProcessingDate"
        },
        "actionCode":{
            "type":"string",
            "description":"Indicates ActionCode"
        },
        "finalResponseStatus":{
            "type":"string",
            "description":"Indicates FinalResponseStatus"
        },
        "currency":{
            "type":"string",
            "description":"Indicates Currency"
        },
        "totalAmountPaid":{
            "type":"number",
            "description":"Indicates TotalAmountPaid"
        },
        "pymntHdrList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PymntHdrDto"
            }
        }
    }
}

Nested Schema : FCUBSErrorResponse

Type: object

Show Source

error: array error

Indicates Errors

{
    "type":"object",
    "properties":{
        "error":{
            "type":"array",
            "description":"Indicates Errors",
            "items":{
                "$ref":"#/definitions/FCUBSError"
            }
        }
    }
}

Nested Schema : FCUBSWarnResponse

Type: object

Show Source

warning: array warning

Indicates Warning

{
    "type":"object",
    "properties":{
        "warning":{
            "type":"array",
            "description":"Indicates Warning",
            "items":{
                "$ref":"#/definitions/FCUBSWarn"
            }
        }
    }
}

Nested Schema : pymntHdrList

Type: array

Show Source

Array of: object PymntHdrDto

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

Nested Schema : PymntHdrDto

Type: object

Show Source

branch: string

Indicates Branch
ccy: string

Indicates Ccy
contractRefNo: string

Indicates ContractRefNo
counterparty: string

Indicates Counterparty
errorRespList: array errorRespList
latestEventSeqNo: number

Indicates LatestEventSeqNo
pymntSummaryList: array pymntSummaryList
resStatus: string

Indicates ResStatus
userDefinedStatus: string

Indicates UserDefinedStatus

{
    "type":"object",
    "properties":{
        "contractRefNo":{
            "type":"string",
            "description":"Indicates ContractRefNo"
        },
        "branch":{
            "type":"string",
            "description":"Indicates Branch"
        },
        "ccy":{
            "type":"string",
            "description":"Indicates Ccy"
        },
        "counterparty":{
            "type":"string",
            "description":"Indicates Counterparty"
        },
        "resStatus":{
            "type":"string",
            "description":"Indicates ResStatus"
        },
        "latestEventSeqNo":{
            "type":"number",
            "description":"Indicates LatestEventSeqNo"
        },
        "userDefinedStatus":{
            "type":"string",
            "description":"Indicates UserDefinedStatus"
        },
        "pymntSummaryList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PymntSummaryDto"
            }
        },
        "errorRespList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ErrorRespDto"
            }
        }
    }
}

Nested Schema : errorRespList

Type: array

Show Source

Array of: object ErrorRespDto

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

Nested Schema : pymntSummaryList

Type: array

Show Source

Array of: object PymntSummaryDto

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

Nested Schema : ErrorRespDto

Type: object

Show Source

contractRefNo: string

Indicates ContractRefNo
errCode: string

Indicates ErrCode
errDesc: string

Indicates ErrDesc
errType: string

Indicates ErrType
eventSeqNo: number

Indicates EventSeqNo
ovdSeqNo: number

Indicates OvdSeqNo

{
    "type":"object",
    "properties":{
        "contractRefNo":{
            "type":"string",
            "description":"Indicates ContractRefNo"
        },
        "eventSeqNo":{
            "type":"number",
            "description":"Indicates EventSeqNo"
        },
        "ovdSeqNo":{
            "type":"number",
            "description":"Indicates OvdSeqNo"
        },
        "errCode":{
            "type":"string",
            "description":"Indicates ErrCode"
        },
        "errDesc":{
            "type":"string",
            "description":"Indicates ErrDesc"
        },
        "errType":{
            "type":"string",
            "description":"Indicates ErrType"
        }
    }
}

Nested Schema : PymntSummaryDto

Type: object

Show Source

contractRefNo: string

Indicates ContractRefNo
eventSeqNo: number

Indicates EventSeqNo
limitDate: string

Indicates LimitDate
pymtDetailsList: array pymtDetailsList
schDate: string

Indicates SchDate
totalPaid: number

Indicates TotalPaid
valueDate: string

Indicates ValueDate

{
    "type":"object",
    "properties":{
        "contractRefNo":{
            "type":"string",
            "description":"Indicates ContractRefNo"
        },
        "eventSeqNo":{
            "type":"number",
            "description":"Indicates EventSeqNo"
        },
        "valueDate":{
            "type":"string",
            "description":"Indicates ValueDate"
        },
        "limitDate":{
            "type":"string",
            "description":"Indicates LimitDate"
        },
        "schDate":{
            "type":"string",
            "description":"Indicates SchDate"
        },
        "totalPaid":{
            "type":"number",
            "description":"Indicates TotalPaid"
        },
        "pymtDetailsList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PymtDetailsDto"
            }
        }
    }
}

Nested Schema : pymtDetailsList

Type: array

Show Source

Array of: object PymtDetailsDto

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

Nested Schema : PymtDetailsDto

Type: object

Show Source

amountDue: number

Indicates AmountDue
amountPaid: number

Indicates AmountPaid
component: string

Indicates Component
contractRefNo: string

Indicates ContractRefNo
eventSeqNo: number

Indicates EventSeqNo
overdueDays: number

Indicates OverdueDays
taxPaid: number

Indicates TaxPaid

{
    "type":"object",
    "properties":{
        "contractRefNo":{
            "type":"string",
            "description":"Indicates ContractRefNo"
        },
        "eventSeqNo":{
            "type":"number",
            "description":"Indicates EventSeqNo"
        },
        "component":{
            "type":"string",
            "description":"Indicates Component"
        },
        "amountDue":{
            "type":"number",
            "description":"Indicates AmountDue"
        },
        "overdueDays":{
            "type":"number",
            "description":"Indicates OverdueDays"
        },
        "amountPaid":{
            "type":"number",
            "description":"Indicates AmountPaid"
        },
        "taxPaid":{
            "type":"number",
            "description":"Indicates TaxPaid"
        }
    }
}

Nested Schema : error

Type: array

Indicates Errors

Show Source

Array of: object FCUBSError

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

Nested Schema : FCUBSError

Type: object

Show Source

ecode: string

Indicates Error Code
edesc: string

Indicates Error Description

{
    "type":"object",
    "properties":{
        "ecode":{
            "type":"string",
            "description":"Indicates Error Code"
        },
        "edesc":{
            "type":"string",
            "description":"Indicates Error Description"
        }
    }
}

Nested Schema : warning

Type: array

Indicates Warning

Show Source

Array of: object FCUBSWarn

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

Nested Schema : FCUBSWarn

Type: object

Show Source

wcode: string

Indicates Warning Code
wdesc: string

Indicates Warning Description

{
    "type":"object",
    "properties":{
        "wcode":{
            "type":"string",
            "description":"Indicates Warning Code"
        },
        "wdesc":{
            "type":"string",
            "description":"Indicates Warning Description"
        }
    }
}

400 Response

Failed while processing request

401 Response

User Not Authorized

405 Response

Method Not Allowed

500 Response

Internal Server Error