Jump to

• Request
• Response

Authorize OL Loan Payment

post

/OLLoanPaymentService/OLLoanPayment/AuthorizePayment

This operation authorizes OL Loan Payment using OLLoanPayment Service(OLDPMNT).

Request

Header Parameters

• BRANCH: string
  Enter Transaction Branch
• ENTITY(optional): string
  Enter Entity ID
• SOURCE: string
  Enter Source Code of External System
• USERID: string
  Enter User ID

Body ()

Root Schema : OlvwsPaymentSummaryDto

Type: object

Show Source

• advices(optional): string
  Indicates Advices
• allowtaxrefund(optional): string
  Indicates Allowtaxrefund
• amountSchDtlsList(optional): array amountSchDtlsList
• audittrial(optional): object AudittrialDto
• branch(optional): string
  Indicates Branch
• breakup(optional): string
  Indicates Breakup
• ccy(optional): string
  Indicates Ccy
• charges(optional): string
  Indicates Charges
• cpty(optional): string
  Indicates Cpty
• currevntseqno(optional): string
  Indicates Currevntseqno
• currpmnt(optional): number
  Indicates Currpmnt
• currverui(optional): number
  Indicates Currverui
• ddaadvreq(optional): string
  Indicates Ddaadvreq
• departcode(optional): string
  Indicates Departcode
• discrate(optional): number
  Indicates Discrate
• ecaStat(optional): string
  Indicates EcaStat
• events(optional): string
  Indicates Events
• eventseqno(optional): number
  Indicates Eventseqno
• exttrnrefno(optional): string
  Indicates Exttrnrefno
• fccref(optional): string
  Indicates Fccref
• intwaiver(optional): string
  Indicates Intwaiver
• intwaiveramt(optional): number
  Indicates Intwaiveramt
• l(optional): string
  Indicates L
• latevntseqno(optional): number
  Indicates Latevntseqno
• latverno(optional): number
  Indicates Latverno
• lcyeqvtlimitamt(optional): number
  Indicates Lcyeqvtlimitamt
• lcyeqvtliqdfacevalue(optional): number
  Indicates Lcyeqvtliqdfacevalue
• lcyeqvttotpaid(optional): number
  Indicates Lcyeqvttotpaid
• lcyresdamt(optional): number
  Indicates Lcyresdamt
• limitamt(optional): number
  Indicates Limitamt
• limitdt(optional): string
  Indicates Limitdt
• liqddep(optional): string
  Indicates Liqddep
• liqdfaceval(optional): number
  Indicates Liqdfaceval
• liqdintprepaidprin(optional): string
  Indicates Liqdintprepaidprin
• liqdorder(optional): string
  Indicates Liqdorder
• madte(optional): string
  Indicates Madte
• mis(optional): string
  Indicates Mis
• modulecode(optional): string
  Indicates Modulecode
• msgprev(optional): string
  Indicates Msgprev
• msgvwList(optional): array msgvwList
• negativeamountsettled(optional): number
  Indicates Negativeamountsettled
• netAmountSettled(optional): number
  Indicates NetAmountSettled
• netamtdue(optional): number
  Indicates Netamtdue
• next(optional): string
  Indicates Next
• next1(optional): string
  Indicates Next1
• oltbsContractControl(optional): object OltbsContractControlDto
• olvwsPaymentBreakupList(optional): array olvwsPaymentBreakupList
• osbal(optional): number
  Indicates Osbal
• osbalrep(optional): number
  Indicates Osbalrep
• ovdmemoposting(optional): string
  Indicates Ovdmemoposting
• p(optional): string
  Indicates P
• paymentstat(optional): string
  Indicates Paymentstat
• paymntrem(optional): string
  Indicates Paymntrem
• payschdprocess(optional): string
  Indicates Payschdprocess
• penaltyAmt(optional): number
  Indicates PenaltyAmt
• pnlRate(optional): number
  Indicates PnlRate
• preAdjAmt2(optional): number
  Indicates PreAdjAmt2
• prepaidprintrate(optional): number
  Indicates Prepaidprintrate
• prepmtadjamt1(optional): number
  Indicates Prepmtadjamt1
• prev(optional): string
  Indicates Prev
• prev1(optional): string
  Indicates Prev1
• prodcode(optional): string
  Indicates Prodcode
• reappintoutamt(optional): string
  Indicates Reappintoutamt
• reappintprepaidamt(optional): string
  Indicates Reappintprepaidamt
• reduceTenor(optional): string
  Indicates ReduceTenor
• resdliqdflag(optional): string
  Indicates Resdliqdflag
• residamt(optional): number
  Indicates Residamt
• s(optional): string
  Indicates S
• schdtls(optional): string
  Indicates Schdtls
• schDtlsList(optional): array schDtlsList
• settlements(optional): string
  Indicates Settlements
• status(optional): string
  Indicates Status
• subsysstat(optional): string
  Indicates Subsysstat
• tax(optional): string
  Indicates Tax
• totpamnt(optional): number
  Indicates Totpamnt
• totvernoui(optional): number
  Indicates Totvernoui
• treassource(optional): string
  Indicates Treassource
• valdt(optional): string
  Indicates Valdt
• vernavoflblui(optional): string
  Indicates Vernavoflblui
• version(optional): string
  Indicates Version
• viewAdv(optional): string
  Indicates ViewAdv
• xref(optional): string
  Indicates Xref

{
    "type":"object",
    "properties":{
        "ccy":{
            "type":"string",
            "description":"Indicates Ccy"
        },
        "paymntrem":{
            "type":"string",
            "description":"Indicates Paymntrem"
        },
        "preAdjAmt2":{
            "type":"number",
            "description":"Indicates PreAdjAmt2"
        },
        "prepmtadjamt1":{
            "type":"number",
            "description":"Indicates Prepmtadjamt1"
        },
        "penaltyAmt":{
            "type":"number",
            "description":"Indicates PenaltyAmt"
        },
        "pnlRate":{
            "type":"number",
            "description":"Indicates PnlRate"
        },
        "liqdfaceval":{
            "type":"number",
            "description":"Indicates Liqdfaceval"
        },
        "limitamt":{
            "type":"number",
            "description":"Indicates Limitamt"
        },
        "discrate":{
            "type":"number",
            "description":"Indicates Discrate"
        },
        "netAmountSettled":{
            "type":"number",
            "description":"Indicates NetAmountSettled"
        },
        "osbal":{
            "type":"number",
            "description":"Indicates Osbal"
        },
        "status":{
            "type":"string",
            "description":"Indicates Status"
        },
        "cpty":{
            "type":"string",
            "description":"Indicates Cpty"
        },
        "eventseqno":{
            "type":"number",
            "description":"Indicates Eventseqno"
        },
        "fccref":{
            "type":"string",
            "description":"Indicates Fccref"
        },
        "xref":{
            "type":"string",
            "description":"Indicates Xref"
        },
        "branch":{
            "type":"string",
            "description":"Indicates Branch"
        },
        "departcode":{
            "type":"string",
            "description":"Indicates Departcode"
        },
        "treassource":{
            "type":"string",
            "description":"Indicates Treassource"
        },
        "ovdmemoposting":{
            "type":"string",
            "description":"Indicates Ovdmemoposting"
        },
        "ddaadvreq":{
            "type":"string",
            "description":"Indicates Ddaadvreq"
        },
        "intwaiveramt":{
            "type":"number",
            "description":"Indicates Intwaiveramt"
        },
        "intwaiver":{
            "type":"string",
            "description":"Indicates Intwaiver"
        },
        "payschdprocess":{
            "type":"string",
            "description":"Indicates Payschdprocess"
        },
        "exttrnrefno":{
            "type":"string",
            "description":"Indicates Exttrnrefno"
        },
        "liqddep":{
            "type":"string",
            "description":"Indicates Liqddep"
        },
        "reappintprepaidamt":{
            "type":"string",
            "description":"Indicates Reappintprepaidamt"
        },
        "reappintoutamt":{
            "type":"string",
            "description":"Indicates Reappintoutamt"
        },
        "liqdintprepaidprin":{
            "type":"string",
            "description":"Indicates Liqdintprepaidprin"
        },
        "prepaidprintrate":{
            "type":"number",
            "description":"Indicates Prepaidprintrate"
        },
        "allowtaxrefund":{
            "type":"string",
            "description":"Indicates Allowtaxrefund"
        },
        "osbalrep":{
            "type":"number",
            "description":"Indicates Osbalrep"
        },
        "p":{
            "type":"string",
            "description":"Indicates P"
        },
        "l":{
            "type":"string",
            "description":"Indicates L"
        },
        "s":{
            "type":"string",
            "description":"Indicates S"
        },
        "modulecode":{
            "type":"string",
            "description":"Indicates Modulecode"
        },
        "prodcode":{
            "type":"string",
            "description":"Indicates Prodcode"
        },
        "settlements":{
            "type":"string",
            "description":"Indicates Settlements"
        },
        "tax":{
            "type":"string",
            "description":"Indicates Tax"
        },
        "events":{
            "type":"string",
            "description":"Indicates Events"
        },
        "mis":{
            "type":"string",
            "description":"Indicates Mis"
        },
        "charges":{
            "type":"string",
            "description":"Indicates Charges"
        },
        "latevntseqno":{
            "type":"number",
            "description":"Indicates Latevntseqno"
        },
        "currevntseqno":{
            "type":"string",
            "description":"Indicates Currevntseqno"
        },
        "latverno":{
            "type":"number",
            "description":"Indicates Latverno"
        },
        "prev1":{
            "type":"string",
            "description":"Indicates Prev1"
        },
        "next1":{
            "type":"string",
            "description":"Indicates Next1"
        },
        "version":{
            "type":"string",
            "description":"Indicates Version"
        },
        "currverui":{
            "type":"number",
            "description":"Indicates Currverui"
        },
        "vernavoflblui":{
            "type":"string",
            "description":"Indicates Vernavoflblui"
        },
        "totvernoui":{
            "type":"number",
            "description":"Indicates Totvernoui"
        },
        "breakup":{
            "type":"string",
            "description":"Indicates Breakup"
        },
        "netamtdue":{
            "type":"number",
            "description":"Indicates Netamtdue"
        },
        "lcyeqvttotpaid":{
            "type":"number",
            "description":"Indicates Lcyeqvttotpaid"
        },
        "lcyeqvtlimitamt":{
            "type":"number",
            "description":"Indicates Lcyeqvtlimitamt"
        },
        "lcyeqvtliqdfacevalue":{
            "type":"number",
            "description":"Indicates Lcyeqvtliqdfacevalue"
        },
        "next":{
            "type":"string",
            "description":"Indicates Next"
        },
        "prev":{
            "type":"string",
            "description":"Indicates Prev"
        },
        "advices":{
            "type":"string",
            "description":"Indicates Advices"
        },
        "subsysstat":{
            "type":"string",
            "description":"Indicates Subsysstat"
        },
        "negativeamountsettled":{
            "type":"number",
            "description":"Indicates Negativeamountsettled"
        },
        "valdt":{
            "type":"string",
            "description":"Indicates Valdt"
        },
        "limitdt":{
            "type":"string",
            "description":"Indicates Limitdt"
        },
        "totpamnt":{
            "type":"number",
            "description":"Indicates Totpamnt"
        },
        "currpmnt":{
            "type":"number",
            "description":"Indicates Currpmnt"
        },
        "liqdorder":{
            "type":"string",
            "description":"Indicates Liqdorder"
        },
        "ecaStat":{
            "type":"string",
            "description":"Indicates EcaStat"
        },
        "madte":{
            "type":"string",
            "description":"Indicates Madte"
        },
        "schdtls":{
            "type":"string",
            "description":"Indicates Schdtls"
        },
        "paymentstat":{
            "type":"string",
            "description":"Indicates Paymentstat"
        },
        "residamt":{
            "type":"number",
            "description":"Indicates Residamt"
        },
        "viewAdv":{
            "type":"string",
            "description":"Indicates ViewAdv"
        },
        "resdliqdflag":{
            "type":"string",
            "description":"Indicates Resdliqdflag"
        },
        "reduceTenor":{
            "type":"string",
            "description":"Indicates ReduceTenor"
        },
        "msgprev":{
            "type":"string",
            "description":"Indicates Msgprev"
        },
        "lcyresdamt":{
            "type":"number",
            "description":"Indicates Lcyresdamt"
        },
        "olvwsPaymentBreakupList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/OlvwsPaymentBreakupDto"
            }
        },
        "audittrial":{
            "$ref":"#/definitions/AudittrialDto"
        },
        "schDtlsList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SchDtlsDto"
            }
        },
        "amountSchDtlsList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AmountSchDtlsDto"
            }
        },
        "oltbsContractControl":{
            "$ref":"#/definitions/OltbsContractControlDto"
        },
        "msgvwList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MsgvwDto"
            }
        }
    }
}

Nested Schema : amountSchDtlsList

Type: array

Show Source

• Array of: object AmountSchDtlsDto

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

Nested Schema : AudittrialDto

Type: object

Show Source

• auth(optional): string
  Indicates Auth
• authstatus(optional): string
  Indicates Authstatus
• checkerDtStamp(optional): string
  Indicates CheckerDtStamp
• checkid(optional): string
  Indicates Checkid
• contrefno(optional): string
  Indicates Contrefno
• contstat(optional): string
  Indicates Contstat
• contstatus(optional): string
  Indicates Contstatus
• eventcode(optional): string
  Indicates Eventcode
• eventdate(optional): string
  Indicates Eventdate
• evntseqno(optional): number
  Indicates Evntseqno
• liqdtxntyp(optional): string
  Indicates Liqdtxntyp
• makerdatestamp(optional): string
  Indicates Makerdatestamp
• makerid2(optional): string
  Indicates Makerid2
• module(optional): string
  Indicates Module
• workflowStatus(optional): string
  Indicates WorkflowStatus
• wrkflwstatus(optional): string
  Indicates Wrkflwstatus

{
    "type":"object",
    "properties":{
        "liqdtxntyp":{
            "type":"string",
            "description":"Indicates Liqdtxntyp"
        },
        "wrkflwstatus":{
            "type":"string",
            "description":"Indicates Wrkflwstatus"
        },
        "authstatus":{
            "type":"string",
            "description":"Indicates Authstatus"
        },
        "contstatus":{
            "type":"string",
            "description":"Indicates Contstatus"
        },
        "eventcode":{
            "type":"string",
            "description":"Indicates Eventcode"
        },
        "eventdate":{
            "type":"string",
            "description":"Indicates Eventdate"
        },
        "evntseqno":{
            "type":"number",
            "description":"Indicates Evntseqno"
        },
        "checkerDtStamp":{
            "type":"string",
            "description":"Indicates CheckerDtStamp"
        },
        "checkid":{
            "type":"string",
            "description":"Indicates Checkid"
        },
        "makerdatestamp":{
            "type":"string",
            "description":"Indicates Makerdatestamp"
        },
        "makerid2":{
            "type":"string",
            "description":"Indicates Makerid2"
        },
        "contrefno":{
            "type":"string",
            "description":"Indicates Contrefno"
        },
        "module":{
            "type":"string",
            "description":"Indicates Module"
        },
        "contstat":{
            "type":"string",
            "description":"Indicates Contstat"
        },
        "auth":{
            "type":"string",
            "description":"Indicates Auth"
        },
        "workflowStatus":{
            "type":"string",
            "description":"Indicates WorkflowStatus"
        }
    }
}

Nested Schema : msgvwList

Type: array

Show Source

• Array of: object MsgvwDto

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

Nested Schema : OltbsContractControlDto

Type: object

Show Source

• contractrefno(optional): string
  Indicates Contractrefno
• entryby(optional): string
  Indicates Entryby
• processcode(optional): string
  Indicates Processcode

{
    "type":"object",
    "properties":{
        "processcode":{
            "type":"string",
            "description":"Indicates Processcode"
        },
        "entryby":{
            "type":"string",
            "description":"Indicates Entryby"
        },
        "contractrefno":{
            "type":"string",
            "description":"Indicates Contractrefno"
        }
    }
}

Nested Schema : olvwsPaymentBreakupList

Type: array

Show Source

• Array of: object OlvwsPaymentBreakupDto

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

Nested Schema : schDtlsList

Type: array

Show Source

• Array of: object SchDtlsDto

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

Nested Schema : AmountSchDtlsDto

Type: object

Show Source

• aamtDue(optional): number
  Indicates AamtDue
• amtccy(optional): string
  Indicates Amtccy
• amtntdue(optional): number
  Indicates Amtntdue
• amtoverdue(optional): number
  Indicates Amtoverdue
• compName(optional): string
  Indicates CompName
• component(optional): string
  Indicates Component
• contrefno(optional): string
  Indicates Contrefno
• duedate(optional): string
  Indicates Duedate

{
    "type":"object",
    "properties":{
        "amtccy":{
            "type":"string",
            "description":"Indicates Amtccy"
        },
        "component":{
            "type":"string",
            "description":"Indicates Component"
        },
        "contrefno":{
            "type":"string",
            "description":"Indicates Contrefno"
        },
        "duedate":{
            "type":"string",
            "description":"Indicates Duedate"
        },
        "compName":{
            "type":"string",
            "description":"Indicates CompName"
        },
        "amtoverdue":{
            "type":"number",
            "description":"Indicates Amtoverdue"
        },
        "aamtDue":{
            "type":"number",
            "description":"Indicates AamtDue"
        },
        "amtntdue":{
            "type":"number",
            "description":"Indicates Amtntdue"
        }
    }
}

Nested Schema : MsgvwDto

Type: object

Show Source

• authstat(optional): string
  Allowed Values: [ "A", "U" ]

  Indicates Authstat
• contrrefno(optional): string
  Indicates Contrrefno
• dcn(optional): string
  Indicates Dcn
• esn(optional): number
  Indicates Esn
• media(optional): string
  Indicates Media
• message(optional): string
  Indicates Message
• msgstatus(optional): string
  Allowed Values: [ "C", "V", "G", "H", "P", "E", "R", "N" ]

  Indicates Msgstatus
• msgtype(optional): string
  Indicates Msgtype
• name(optional): string
  Indicates Name
• receiver(optional): string
  Indicates Receiver
• runningno(optional): number
  Indicates Runningno
• swiftmsgtype(optional): string
  Indicates Swiftmsgtype
• testingstatus(optional): string
  Allowed Values: [ "R", "I" ]

  Indicates Testingstatus

{
    "type":"object",
    "properties":{
        "authstat":{
            "type":"string",
            "description":"Indicates Authstat",
            "enum":[
                "A",
                "U"
            ]
        },
        "dcn":{
            "type":"string",
            "description":"Indicates Dcn"
        },
        "msgstatus":{
            "type":"string",
            "description":"Indicates Msgstatus",
            "enum":[
                "C",
                "V",
                "G",
                "H",
                "P",
                "E",
                "R",
                "N"
            ]
        },
        "name":{
            "type":"string",
            "description":"Indicates Name"
        },
        "testingstatus":{
            "type":"string",
            "description":"Indicates Testingstatus",
            "enum":[
                "R",
                "I"
            ]
        },
        "esn":{
            "type":"number",
            "description":"Indicates Esn"
        },
        "message":{
            "type":"string",
            "description":"Indicates Message"
        },
        "msgtype":{
            "type":"string",
            "description":"Indicates Msgtype"
        },
        "media":{
            "type":"string",
            "description":"Indicates Media"
        },
        "contrrefno":{
            "type":"string",
            "description":"Indicates Contrrefno"
        },
        "runningno":{
            "type":"number",
            "description":"Indicates Runningno"
        },
        "receiver":{
            "type":"string",
            "description":"Indicates Receiver"
        },
        "swiftmsgtype":{
            "type":"string",
            "description":"Indicates Swiftmsgtype"
        }
    }
}

Nested Schema : OlvwsPaymentBreakupDto

Type: object

Show Source

• amtdue(optional): number
  Indicates Amtdue
• amtpaid(optional): number
  Indicates Amtpaid
• comp(optional): string
  Indicates Comp
• eventseqno(optional): number
  Indicates Eventseqno
• fccref(optional): string
  Indicates Fccref
• overdueDays(optional): number
  Indicates OverdueDays
• payReceive(optional): number
  Indicates PayReceive
• taxpaid(optional): number
  Indicates Taxpaid

{
    "type":"object",
    "properties":{
        "fccref":{
            "type":"string",
            "description":"Indicates Fccref"
        },
        "comp":{
            "type":"string",
            "description":"Indicates Comp"
        },
        "amtdue":{
            "type":"number",
            "description":"Indicates Amtdue"
        },
        "overdueDays":{
            "type":"number",
            "description":"Indicates OverdueDays"
        },
        "amtpaid":{
            "type":"number",
            "description":"Indicates Amtpaid"
        },
        "taxpaid":{
            "type":"number",
            "description":"Indicates Taxpaid"
        },
        "payReceive":{
            "type":"number",
            "description":"Indicates PayReceive"
        },
        "eventseqno":{
            "type":"number",
            "description":"Indicates Eventseqno"
        }
    }
}

Nested Schema : SchDtlsDto

Type: object

Show Source

• amountdue(optional): number
  Indicates Amountdue
• amtsettled(optional): number
  Indicates Amtsettled
• component(optional): string
  Indicates Component
• contractRefNo(optional): string
  Indicates ContractRefNo
• duedate(optional): string
  Indicates Duedate
• eventSeqNo(optional): number
  Indicates EventSeqNo
• paidDate(optional): string
  Indicates PaidDate

{
    "type":"object",
    "properties":{
        "amountdue":{
            "type":"number",
            "description":"Indicates Amountdue"
        },
        "amtsettled":{
            "type":"number",
            "description":"Indicates Amtsettled"
        },
        "eventSeqNo":{
            "type":"number",
            "description":"Indicates EventSeqNo"
        },
        "paidDate":{
            "type":"string",
            "description":"Indicates PaidDate"
        },
        "duedate":{
            "type":"string",
            "description":"Indicates Duedate"
        },
        "component":{
            "type":"string",
            "description":"Indicates Component"
        },
        "contractRefNo":{
            "type":"string",
            "description":"Indicates ContractRefNo"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

AuthorizePayment Successfully Performed

400 Response

Failed while processing request

401 Response

User Not Authorized

405 Response

Method Not Allowed

500 Response

Internal Server Error

Back to Top