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

FCUBS_ERROR_RESP: object FCUBSErrorResponse
FCUBS_WARNING_RESP: object FCUBSWarnResponse
Head-Full: object HeadDto

{
    "type":"object",
    "properties":{
        "Head-Full":{
            "$ref":"#/definitions/HeadDto"
        },
        "FCUBS_ERROR_RESP":{
            "$ref":"#/definitions/FCUBSErrorResponse"
        },
        "FCUBS_WARNING_RESP":{
            "$ref":"#/definitions/FCUBSWarnResponse"
        }
    }
}

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

Type: object

Show Source

eventList: array eventList
isWorstStatus: string

Indicates IsWorstStatus
maxtxnamt: number

Indicates Maxtxnamt
mintxnamt: number

Indicates Mintxnamt
refno: string

Indicates Refno
status: string

Indicates Status
statusDescription: string

Indicates StatusDescription
trnFromDt: string

Indicates Transaction From Date
trnToDt: string

Indicates TrnToDt

{
    "type":"object",
    "properties":{
        "refno":{
            "type":"string",
            "description":"Indicates Refno"
        },
        "trnFromDt":{
            "type":"string",
            "description":"Indicates Transaction From Date"
        },
        "trnToDt":{
            "type":"string",
            "description":"Indicates TrnToDt"
        },
        "mintxnamt":{
            "type":"number",
            "description":"Indicates Mintxnamt"
        },
        "maxtxnamt":{
            "type":"number",
            "description":"Indicates Maxtxnamt"
        },
        "status":{
            "type":"string",
            "description":"Indicates Status"
        },
        "statusDescription":{
            "type":"string",
            "description":"Indicates StatusDescription"
        },
        "isWorstStatus":{
            "type":"string",
            "description":"Indicates IsWorstStatus"
        },
        "eventList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EventDto"
            }
        }
    }
}

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"
        }
    }
}

Nested Schema : eventList

Type: array

Show Source

Array of: object EventDto

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

Nested Schema : EventDto

Type: object

Show Source

accountList: array accountList
authstat: string

Allowed Values: [ "A", "U" ]

Indicates Authorized A - Authorized U - Unauthorized
checkerId: string

Indicates User Id who has Authorized the creation\modification of Customer Account.
contrefno: string

Indicates Contract Reference
desc: string

Indicates Event Description
eventcd: string

Indicates Event Code
eventdt: string

Indictes Event Date
eventno: number

Indicates the Event Sequence No
makerid: string

Indicates Maker ID
module: string

Indicates Module
msgList: array msgList
reversedesn: number

Indicates Reversed ESN

{
    "type":"object",
    "properties":{
        "module":{
            "type":"string",
            "description":"Indicates Module"
        },
        "contrefno":{
            "type":"string",
            "description":"Indicates Contract Reference"
        },
        "eventno":{
            "type":"number",
            "description":"Indicates the Event Sequence No"
        },
        "eventdt":{
            "type":"string",
            "description":"Indictes Event Date"
        },
        "eventcd":{
            "type":"string",
            "description":"Indicates Event Code"
        },
        "desc":{
            "type":"string",
            "description":"Indicates Event Description"
        },
        "authstat":{
            "type":"string",
            "description":"Indicates Authorized\tA - Authorized\tU - Unauthorized",
            "enum":[
                "A",
                "U"
            ]
        },
        "makerid":{
            "type":"string",
            "description":"Indicates Maker ID"
        },
        "checkerId":{
            "type":"string",
            "description":"Indicates User Id who has Authorized the creation\\modification of Customer Account."
        },
        "reversedesn":{
            "type":"number",
            "description":"Indicates Reversed ESN"
        },
        "accountList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AccountDto"
            }
        },
        "msgList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MsgDto"
            }
        }
    }
}

Nested Schema : accountList

Type: array

Show Source

Array of: object AccountDto

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

Nested Schema : msgList

Type: array

Show Source

Array of: object MsgDto

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

Nested Schema : AccountDto

Type: object

Show Source

acbrn: string

Indicates Branch
acccy: string

Indicates Account Currency
accno: string

Indicates Account
acctype: string

Indicates Account/GL Number
acdesc: string

Indicates Account Description
acsrno: number

Indicates Entry Serial Number
amttag: string

Indicates Amount tag
bnkLcy: string

Indicates Local Currency
drcrind: string

Indicates Debit/Credit
event: string

Indicates Event
eventSrNo: number

Indicates ESN
exrate: number

Indicates Exchange Rate
fcyamt: number

Indicates Foreign Currency Amount
lcyamt: number

Indicates Local Currency Amount
relatedCustomer: string

Indicates Related Customer
relatedReference: string

Indicates Related Reference
trncd: string

Indicates Transaction Code
trndt: string

Indicates Transaction From Date
trnrefno: string

Indicates transaction reference number of project details
valdt: string

Indicates Value Date

{
    "type":"object",
    "properties":{
        "acbrn":{
            "type":"string",
            "description":"Indicates Branch"
        },
        "accno":{
            "type":"string",
            "description":"Indicates Account"
        },
        "acccy":{
            "type":"string",
            "description":"Indicates Account Currency"
        },
        "bnkLcy":{
            "type":"string",
            "description":"Indicates Local Currency"
        },
        "drcrind":{
            "type":"string",
            "description":"Indicates Debit/Credit"
        },
        "trncd":{
            "type":"string",
            "description":"Indicates Transaction Code"
        },
        "amttag":{
            "type":"string",
            "description":"Indicates Amount tag"
        },
        "fcyamt":{
            "type":"number",
            "description":"Indicates Foreign Currency Amount"
        },
        "trndt":{
            "type":"string",
            "description":"Indicates Transaction From Date"
        },
        "valdt":{
            "type":"string",
            "description":"Indicates Value Date"
        },
        "trnrefno":{
            "type":"string",
            "description":"Indicates transaction reference number of project details"
        },
        "acsrno":{
            "type":"number",
            "description":"Indicates Entry Serial Number"
        },
        "exrate":{
            "type":"number",
            "description":"Indicates Exchange Rate"
        },
        "lcyamt":{
            "type":"number",
            "description":"Indicates Local Currency Amount"
        },
        "event":{
            "type":"string",
            "description":"Indicates Event"
        },
        "acdesc":{
            "type":"string",
            "description":"Indicates Account Description"
        },
        "eventSrNo":{
            "type":"number",
            "description":"Indicates ESN"
        },
        "relatedCustomer":{
            "type":"string",
            "description":"Indicates Related Customer"
        },
        "relatedReference":{
            "type":"string",
            "description":"Indicates Related Reference"
        },
        "acctype":{
            "type":"string",
            "description":"Indicates Account/GL Number"
        }
    }
}

Nested Schema : MsgDto

Type: object

Show Source

authstat: string

Indicates Authstat
ccy: string

Indicates Ccy
counterparty: string

Indicates Counterparty
dcn: string

Indicates Dcn
esn: number

Indicates Esn
media: string

Indicates Media
message: string

Indicates Message
msgdesc: string

Indicates Msgdesc
msgdetList: array msgdetList
msgstat: string

Indicates Msgstat
msgtype: string

Indicates Msgtype
name: string

Indicates Name
pmntrefno: string

Indicates Pmntrefno
receiver: string

Indicates Receiver
refno: string

Indicates Refno
runningNo: number

Indicates RunningNo
swiftmsgtype: string

Indicates Swiftmsgtype
teststat: string

Indicates Teststat

{
    "type":"object",
    "properties":{
        "refno":{
            "type":"string",
            "description":"Indicates Refno"
        },
        "message":{
            "type":"string",
            "description":"Indicates Message"
        },
        "msgtype":{
            "type":"string",
            "description":"Indicates Msgtype"
        },
        "dcn":{
            "type":"string",
            "description":"Indicates Dcn"
        },
        "runningNo":{
            "type":"number",
            "description":"Indicates RunningNo"
        },
        "authstat":{
            "type":"string",
            "description":"Indicates Authstat"
        },
        "counterparty":{
            "type":"string",
            "description":"Indicates Counterparty"
        },
        "esn":{
            "type":"number",
            "description":"Indicates Esn"
        },
        "media":{
            "type":"string",
            "description":"Indicates Media"
        },
        "msgstat":{
            "type":"string",
            "description":"Indicates Msgstat"
        },
        "name":{
            "type":"string",
            "description":"Indicates Name"
        },
        "receiver":{
            "type":"string",
            "description":"Indicates Receiver"
        },
        "teststat":{
            "type":"string",
            "description":"Indicates Teststat"
        },
        "ccy":{
            "type":"string",
            "description":"Indicates Ccy"
        },
        "pmntrefno":{
            "type":"string",
            "description":"Indicates Pmntrefno"
        },
        "msgdesc":{
            "type":"string",
            "description":"Indicates Msgdesc"
        },
        "swiftmsgtype":{
            "type":"string",
            "description":"Indicates Swiftmsgtype"
        },
        "msgdetList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MsgdetDto"
            }
        }
    }
}

Nested Schema : msgdetList

Type: array

Show Source

Array of: object MsgdetDto

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

Nested Schema : MsgdetDto

Type: object

Show Source

dcn: string

Indicates Dcn
msg: string

Indicates Msg
runningno: number

Indicates Runningno

{
    "type":"object",
    "properties":{
        "dcn":{
            "type":"string",
            "description":"Indicates Dcn"
        },
        "msg":{
            "type":"string",
            "description":"Indicates Msg"
        },
        "runningno":{
            "type":"number",
            "description":"Indicates Runningno"
        }
    }
}

400 Response

Failed while processing request

401 Response

User Not Authorized

405 Response

Method Not Allowed

500 Response

Internal Server Error