Rest API for Oracle Banking Corporate Lending

Authorize an OL Loan Payment

post

/OLLoanPaymentAuthService/OLLoanPaymentAuth/AuthorizePayMtAuth

This operation authorizes an OL Loan Payment using OLLoanPaymentAuth Service (OLDPMAUT).

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 : CstbsContractPmtHdrDto

Type: object

Show Source

assetCcy: string

This field indicates Currency
balance: number

This field indicates Balance
btnauthui: string

This field indicates Authorize
btnSetlinfo: string

This field indicates Settlement Info
contrrefno: string

This field indicates Contract Ref No
contstat: string

This field indicates Contract Status
counterparty: string

This field indicates Counterparty
currentesnui: number

This field indicates Payment Status
curreventcode: string

This field indicates Current Event Code
latevnseqno: number

This field indicates Latest event sequence number
latverno: number

This field indicates Latest Version Number
moducd: string

This field indicates Module Code
oltbsContractLiqSummary: object OltbsContractLiqSummaryDto
paymentstat: string

This field indicates Payment Status

{
    "type":"object",
    "properties":{
        "assetCcy":{
            "type":"string",
            "description":"This field indicates Currency"
        },
        "contstat":{
            "type":"string",
            "description":"This field indicates Contract Status"
        },
        "moducd":{
            "type":"string",
            "description":"This field indicates Module Code"
        },
        "curreventcode":{
            "type":"string",
            "description":"This field indicates Current Event Code"
        },
        "counterparty":{
            "type":"string",
            "description":"This field indicates Counterparty"
        },
        "latverno":{
            "type":"number",
            "description":"This field indicates Latest Version Number"
        },
        "latevnseqno":{
            "type":"number",
            "description":"This field indicates Latest event sequence number"
        },
        "contrrefno":{
            "type":"string",
            "description":"This field indicates Contract Ref No"
        },
        "balance":{
            "type":"number",
            "description":"This field indicates Balance"
        },
        "paymentstat":{
            "type":"string",
            "description":"This field indicates Payment Status"
        },
        "currentesnui":{
            "type":"number",
            "description":"This field indicates Payment Status"
        },
        "btnSetlinfo":{
            "type":"string",
            "description":"This field indicates Settlement Info"
        },
        "btnauthui":{
            "type":"string",
            "description":"This field indicates Authorize"
        },
        "oltbsContractLiqSummary":{
            "$ref":"#/definitions/OltbsContractLiqSummaryDto"
        }
    }
}

Nested Schema : OltbsContractLiqSummaryDto

Type: object

Show Source

amtblkrmks: string

This field indicates Remarks
asstdate: string

This field indicates Value Date
contrrefno: string

This field indicates Contract Ref No
eventSeqNo1: number

This field indicates Event Seq No
oltbsContractLiqPmtList: array oltbsContractLiqPmtList
oltbsContractOvdList: array oltbsContractOvdList
paymentstatus: string

This field indicates Payment Status
prepaymentPenaltyAmount: number

This field indicates Penalty Amount
prepaymentpenaltyrate: number

This field indicates Penalty Rate
rekytotlpaid: number

This field indicates Total Paid
showDet: string

This field indicates Show Details

{
    "type":"object",
    "properties":{
        "rekytotlpaid":{
            "type":"number",
            "description":"This field indicates Total Paid"
        },
        "asstdate":{
            "type":"string",
            "description":"This field indicates Value Date"
        },
        "eventSeqNo1":{
            "type":"number",
            "description":"This field indicates Event Seq No"
        },
        "contrrefno":{
            "type":"string",
            "description":"This field indicates Contract Ref No"
        },
        "paymentstatus":{
            "type":"string",
            "description":"This field indicates Payment Status"
        },
        "amtblkrmks":{
            "type":"string",
            "description":"This field indicates Remarks"
        },
        "prepaymentPenaltyAmount":{
            "type":"number",
            "description":"This field indicates Penalty Amount"
        },
        "prepaymentpenaltyrate":{
            "type":"number",
            "description":"This field indicates Penalty Rate"
        },
        "showDet":{
            "type":"string",
            "description":"This field indicates Show Details"
        },
        "oltbsContractLiqPmtList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/OltbsContractLiqPmtDto"
            }
        },
        "oltbsContractOvdList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/OltbsContractOvdDto"
            }
        }
    }
}

Nested Schema : oltbsContractLiqPmtList

Type: array

Show Source

Array of: object OltbsContractLiqPmtDto

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

Nested Schema : oltbsContractOvdList

Type: array

Show Source

Array of: object OltbsContractOvdDto

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

Nested Schema : OltbsContractLiqPmtDto

Type: object

Show Source

amountdue: number

This field indicates Amount Due
amountpaid: number

This field indicates Amount Paid
amountTagg: string

This field indicates Component
contractrefno: string

This field indicates Contract Reference
eventseqno: number

This field indicates ESN
odDays: number

This field indicates OD Days
taxpaid: number

This field indicates Tax Paid

{
    "type":"object",
    "properties":{
        "taxpaid":{
            "type":"number",
            "description":"This field indicates Tax Paid"
        },
        "odDays":{
            "type":"number",
            "description":"This field indicates OD Days"
        },
        "amountpaid":{
            "type":"number",
            "description":"This field indicates Amount Paid"
        },
        "amountdue":{
            "type":"number",
            "description":"This field indicates Amount Due"
        },
        "amountTagg":{
            "type":"string",
            "description":"This field indicates Component"
        },
        "eventseqno":{
            "type":"number",
            "description":"This field indicates ESN"
        },
        "contractrefno":{
            "type":"string",
            "description":"This field indicates Contract Reference"
        }
    }
}

Nested Schema : OltbsContractOvdDto

Type: object

Show Source

acstatus: string

This field indicates Status
authdtstamp: string

This field indicates Auth Date Stamp
checker: string

This field indicates Auth By
confirmed: string

This field indicates Confirmed
contractrefno: string

This field indicates Contract Reference
errcode: string

This field indicates Error Code
errmsg: string

This field indicates Error Message
eventseqno: number

This field indicates ESN
module: string

This field indicates Module
onlineauthid: string

This field indicates Online Authorizer Id
ovdseqno: number

This field indicates Sequence Number
ovdstatus: string

This field indicates Override Status
ovdtype: string

This field indicates Override Type
parameters: string

This field indicates Parameters
remarks: string

This field indicates Remarks
txtstatus: string

This field indicates Status

{
    "type":"object",
    "properties":{
        "ovdtype":{
            "type":"string",
            "description":"This field indicates Override Type"
        },
        "confirmed":{
            "type":"string",
            "description":"This field indicates Confirmed"
        },
        "ovdstatus":{
            "type":"string",
            "description":"This field indicates Override Status"
        },
        "txtstatus":{
            "type":"string",
            "description":"This field indicates Status"
        },
        "authdtstamp":{
            "type":"string",
            "description":"This field indicates Auth Date Stamp"
        },
        "checker":{
            "type":"string",
            "description":"This field indicates Auth By"
        },
        "remarks":{
            "type":"string",
            "description":"This field indicates Remarks"
        },
        "onlineauthid":{
            "type":"string",
            "description":"This field indicates Online Authorizer Id"
        },
        "parameters":{
            "type":"string",
            "description":"This field indicates Parameters"
        },
        "errcode":{
            "type":"string",
            "description":"This field indicates Error Code"
        },
        "module":{
            "type":"string",
            "description":"This field indicates Module"
        },
        "ovdseqno":{
            "type":"number",
            "description":"This field indicates Sequence Number"
        },
        "eventseqno":{
            "type":"number",
            "description":"This field indicates ESN"
        },
        "contractrefno":{
            "type":"string",
            "description":"This field indicates Contract Reference"
        },
        "acstatus":{
            "type":"string",
            "description":"This field indicates Status"
        },
        "errmsg":{
            "type":"string",
            "description":"This field indicates Error Message"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

AuthorizePayMtAuth 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