Jump to

• Request
• Response

Create a LB Bulk Payment

post

/LBBulkPaymentService/LBBulkPayment/CreateBulkPayment

This operation creates a LB bulk payment using LBBulkPayment Service (LBDBLKPT).

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

Type: object

Show Source

• actionCode(optional): string
  Indicates ActionCode
• counterparty(optional): string
  Indicates Counterparty
• currency(optional): string
  Indicates Currency
• finalResponseStatus(optional): string
  Indicates FinalResponseStatus
• processingDate(optional): string
  Indicates ProcessingDate
• processRefNo(optional): string
  Indicates ProcessRefNo
• pymntHdrList(optional): array pymntHdrList
• simulate(optional): string
  Indicates Simulate
• totalAmountPaid(optional): 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 : pymntHdrList

Type: array

Show Source

• Array of: object PymntHdrDto

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

Nested Schema : PymntHdrDto

Type: object

Show Source

• branch(optional): string
  Indicates Branch
• ccy(optional): string
  Indicates Ccy
• contractRefNo(optional): string
  Indicates ContractRefNo
• counterparty(optional): string
  Indicates Counterparty
• errorRespList(optional): array errorRespList
• latestEventSeqNo(optional): number
  Indicates LatestEventSeqNo
• pymntSummaryList(optional): array pymntSummaryList
• resStatus(optional): string
  Indicates ResStatus
• userDefinedStatus(optional): 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(optional): string
  Indicates ContractRefNo
• errCode(optional): string
  Indicates ErrCode
• errDesc(optional): string
  Indicates ErrDesc
• errType(optional): string
  Indicates ErrType
• eventSeqNo(optional): number
  Indicates EventSeqNo
• ovdSeqNo(optional): 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(optional): string
  Indicates ContractRefNo
• eventSeqNo(optional): number
  Indicates EventSeqNo
• limitDate(optional): string
  Indicates LimitDate
• pymtDetailsList(optional): array pymtDetailsList
• schDate(optional): string
  Indicates SchDate
• totalPaid(optional): number
  Indicates TotalPaid
• valueDate(optional): 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(optional): number
  Indicates AmountDue
• amountPaid(optional): number
  Indicates AmountPaid
• component(optional): string
  Indicates Component
• contractRefNo(optional): string
  Indicates ContractRefNo
• eventSeqNo(optional): number
  Indicates EventSeqNo
• overdueDays(optional): number
  Indicates OverdueDays
• taxPaid(optional): 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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : RESTResponse

Type: object

Show Source

• Cstbs-Contract-Pmt-Hdr-Full(optional): object CstbsContractPmtHdrDto
• FCUBS_ERROR_RESP(optional): object FCUBSErrorResponse
• FCUBS_WARNING_RESP(optional): object FCUBSWarnResponse

{
    "type":"object",
    "properties":{
        "Cstbs-Contract-Pmt-Hdr-Full":{
            "$ref":"#/definitions/CstbsContractPmtHdrDto"
        },
        "FCUBS_ERROR_RESP":{
            "$ref":"#/definitions/FCUBSErrorResponse"
        },
        "FCUBS_WARNING_RESP":{
            "$ref":"#/definitions/FCUBSWarnResponse"
        }
    }
}

Nested Schema : CstbsContractPmtHdrDto

Type: object

Show Source

• assetCcy(optional): string
  Indicates AssetCcy
• balance(optional): number
  Indicates Balance
• btnauthui(optional): string
  Indicates Btnauthui
• btnSetlinfo(optional): string
  Indicates BtnSetlinfo
• contrrefno(optional): string
  Indicates Contrrefno
• contstat(optional): string
  Indicates Contstat
• counterparty(optional): string
  Indicates Counterparty
• currentesnui(optional): number
  Indicates Currentesnui
• curreventcode(optional): string
  Indicates Curreventcode
• latevnseqno(optional): number
  Indicates Latevnseqno
• latverno(optional): number
  Indicates Latverno
• moducd(optional): string
  Indicates Moducd
• oltbsContractLiqSummary(optional): object OltbsContractLiqSummaryDto
• paymentstat(optional): string
  Indicates Paymentstat

{
    "type":"object",
    "properties":{
        "assetCcy":{
            "type":"string",
            "description":"Indicates AssetCcy"
        },
        "contstat":{
            "type":"string",
            "description":"Indicates Contstat"
        },
        "moducd":{
            "type":"string",
            "description":"Indicates Moducd"
        },
        "curreventcode":{
            "type":"string",
            "description":"Indicates Curreventcode"
        },
        "counterparty":{
            "type":"string",
            "description":"Indicates Counterparty"
        },
        "latverno":{
            "type":"number",
            "description":"Indicates Latverno"
        },
        "latevnseqno":{
            "type":"number",
            "description":"Indicates Latevnseqno"
        },
        "contrrefno":{
            "type":"string",
            "description":"Indicates Contrrefno"
        },
        "balance":{
            "type":"number",
            "description":"Indicates Balance"
        },
        "paymentstat":{
            "type":"string",
            "description":"Indicates Paymentstat"
        },
        "currentesnui":{
            "type":"number",
            "description":"Indicates Currentesnui"
        },
        "btnSetlinfo":{
            "type":"string",
            "description":"Indicates BtnSetlinfo"
        },
        "btnauthui":{
            "type":"string",
            "description":"Indicates Btnauthui"
        },
        "oltbsContractLiqSummary":{
            "$ref":"#/definitions/OltbsContractLiqSummaryDto"
        }
    }
}

Nested Schema : FCUBSErrorResponse

Type: object

Show Source

• ERROR(optional): array ERROR

{
    "type":"object",
    "properties":{
        "ERROR":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FCUBSError"
            }
        }
    }
}

Nested Schema : FCUBSWarnResponse

Type: object

Show Source

• WARNING(optional): array WARNING

{
    "type":"object",
    "properties":{
        "WARNING":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FCUBSWarn"
            }
        }
    }
}

Nested Schema : OltbsContractLiqSummaryDto

Type: object

Show Source

• amtblkrmks(optional): string
  Indicates Amtblkrmks
• asstdate(optional): string
  Indicates Asstdate
• contrrefno(optional): string
  Indicates Contrrefno
• eventSeqNo1(optional): number
  Indicates EventSeqNo1
• oltbsContractLiqPmtList(optional): array oltbsContractLiqPmtList
• oltbsContractOvdList(optional): array oltbsContractOvdList
• paymentstatus(optional): string
  Indicates Paymentstatus
• prepaymentPenaltyAmount(optional): number
  Indicates PrepaymentPenaltyAmount
• prepaymentpenaltyrate(optional): number
  Indicates Prepaymentpenaltyrate
• rekytotlpaid(optional): number
  Indicates Rekytotlpaid
• showDet(optional): string
  Indicates ShowDet

{
    "type":"object",
    "properties":{
        "rekytotlpaid":{
            "type":"number",
            "description":"Indicates Rekytotlpaid"
        },
        "asstdate":{
            "type":"string",
            "description":"Indicates Asstdate"
        },
        "eventSeqNo1":{
            "type":"number",
            "description":"Indicates EventSeqNo1"
        },
        "contrrefno":{
            "type":"string",
            "description":"Indicates Contrrefno"
        },
        "paymentstatus":{
            "type":"string",
            "description":"Indicates Paymentstatus"
        },
        "amtblkrmks":{
            "type":"string",
            "description":"Indicates Amtblkrmks"
        },
        "prepaymentPenaltyAmount":{
            "type":"number",
            "description":"Indicates PrepaymentPenaltyAmount"
        },
        "prepaymentpenaltyrate":{
            "type":"number",
            "description":"Indicates Prepaymentpenaltyrate"
        },
        "showDet":{
            "type":"string",
            "description":"Indicates ShowDet"
        },
        "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(optional): number
  Indicates Amountdue
• amountpaid(optional): number
  Indicates Amountpaid
• amountTagg(optional): string
  Indicates AmountTagg
• contractrefno(optional): string
  Indicates Contractrefno
• eventseqno(optional): number
  Indicates Eventseqno
• odDays(optional): number
  Indicates OdDays
• taxpaid(optional): number
  Indicates Taxpaid

{
    "type":"object",
    "properties":{
        "taxpaid":{
            "type":"number",
            "description":"Indicates Taxpaid"
        },
        "odDays":{
            "type":"number",
            "description":"Indicates OdDays"
        },
        "amountpaid":{
            "type":"number",
            "description":"Indicates Amountpaid"
        },
        "amountdue":{
            "type":"number",
            "description":"Indicates Amountdue"
        },
        "amountTagg":{
            "type":"string",
            "description":"Indicates AmountTagg"
        },
        "eventseqno":{
            "type":"number",
            "description":"Indicates Eventseqno"
        },
        "contractrefno":{
            "type":"string",
            "description":"Indicates Contractrefno"
        }
    }
}

Nested Schema : OltbsContractOvdDto

Type: object

Show Source

• acstatus(optional): string
  Indicates Acstatus
• authdtstamp(optional): string
  Indicates Authdtstamp
• checker(optional): string
  Indicates Checker
• confirmed(optional): string
  Indicates Confirmed
• contractrefno(optional): string
  Indicates Contractrefno
• errcode(optional): string
  Indicates Errcode
• errmsg(optional): string
  Indicates Errmsg
• eventseqno(optional): number
  Indicates Eventseqno
• module(optional): string
  Indicates Module
• onlineauthid(optional): string
  Indicates Onlineauthid
• ovdseqno(optional): number
  Indicates Ovdseqno
• ovdstatus(optional): string
  Indicates Ovdstatus
• ovdtype(optional): string
  Indicates Ovdtype
• parameters(optional): string
  Indicates Parameters
• remarks(optional): string
  Indicates Remarks
• txtstatus(optional): string
  Indicates Txtstatus

{
    "type":"object",
    "properties":{
        "ovdtype":{
            "type":"string",
            "description":"Indicates Ovdtype"
        },
        "confirmed":{
            "type":"string",
            "description":"Indicates Confirmed"
        },
        "ovdstatus":{
            "type":"string",
            "description":"Indicates Ovdstatus"
        },
        "txtstatus":{
            "type":"string",
            "description":"Indicates Txtstatus"
        },
        "authdtstamp":{
            "type":"string",
            "description":"Indicates Authdtstamp"
        },
        "checker":{
            "type":"string",
            "description":"Indicates Checker"
        },
        "remarks":{
            "type":"string",
            "description":"Indicates Remarks"
        },
        "onlineauthid":{
            "type":"string",
            "description":"Indicates Onlineauthid"
        },
        "parameters":{
            "type":"string",
            "description":"Indicates Parameters"
        },
        "errcode":{
            "type":"string",
            "description":"Indicates Errcode"
        },
        "module":{
            "type":"string",
            "description":"Indicates Module"
        },
        "ovdseqno":{
            "type":"number",
            "description":"Indicates Ovdseqno"
        },
        "eventseqno":{
            "type":"number",
            "description":"Indicates Eventseqno"
        },
        "contractrefno":{
            "type":"string",
            "description":"Indicates Contractrefno"
        },
        "acstatus":{
            "type":"string",
            "description":"Indicates Acstatus"
        },
        "errmsg":{
            "type":"string",
            "description":"Indicates Errmsg"
        }
    }
}

Nested Schema : ERROR

Type: array

Show Source

• Array of: object FCUBSError

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

Nested Schema : FCUBSError

Type: object

Show Source

• ECODE(optional): string
• EDESC(optional): string

{
    "type":"object",
    "properties":{
        "ECODE":{
            "type":"string"
        },
        "EDESC":{
            "type":"string"
        }
    }
}

Nested Schema : WARNING

Type: array

Show Source

• Array of: object FCUBSWarn

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

Nested Schema : FCUBSWarn

Type: object

Show Source

• WCODE(optional): string
• WDESC(optional): string

{
    "type":"object",
    "properties":{
        "WCODE":{
            "type":"string"
        },
        "WDESC":{
            "type":"string"
        }
    }
}

201 Response

CreateBulkPayment 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