Jump to

• Request
• Response

Modify a LB Bulk Payment

post

/LBBulkPaymentService/LBBulkPayment/ModifyBulkPayment

This operation modifies 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

ModifyBulkPayment 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