Jump to

• Request
• Response

Authorize the payment transaction

post

/service/v1/authorizePayment

This endpoint authorizes the payment transaction.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
  appId
• branchCode: string
  branchCode
• userId: string
  user id for SMS

Body ()

Request Body that contains data required for creating a new Invoice.

Root Schema : ConductorWorkflowModel

Type: object

ConductorWorkflowModel

Show Source

• acceptedInvoicesModel(optional): object AcceptedInvoicesModel
  AcceptedInvoicesModel
• amount(optional): number
  amount
• appId(optional): string
  AppId of Workflow Service
• applicationCode(optional): string
  Application code
• applicationNumber(optional): string
  Reference number without seqno
• branchCode(optional): string
  Branch Code
• businessDate(optional): string
  Business Date
• currencyCode(optional): string
  currencyCode
• customerNumber(optional): string
  customerNumber
• errorCode(optional): string
  Error Code
• errorDesc(optional): string
  Error Desc
• event(optional): string
  amount
• instrumentModel(optional): InstrumentModel
  Instruement Model
• priority(optional): string
  amount
• processCode(optional): string
  Process Code to identify workflow
• processingDate(optional): string
  Processing Date
• processName(optional): string
  Process Name to identify workflow
• product(optional): string
  Product type to identify service for instrument
• productCategory(optional): string
  productCategory
• productCode(optional): string
  amount
• stageDescription(optional): string
  Stage desc
• stageId(optional): string
  Stage Id
• taskInstanceId(optional): string
  Task Instance Id
• transactionReferenceNo(optional): string
  Transaction Referenec No
• uri(optional): string
  EndPoint of Workflow Service
• userId(optional): string
  User Id
• workflowInstanceId(optional): string
  Workflow Instance Id
• workflowType(optional): string
  amount

{
    "description":"ConductorWorkflowModel",
    "type":"object",
    "properties":{
        "processCode":{
            "type":"string",
            "description":"Process Code to identify workflow"
        },
        "processName":{
            "type":"string",
            "description":"Process Name to identify workflow"
        },
        "userId":{
            "type":"string",
            "description":"User Id"
        },
        "stageId":{
            "type":"string",
            "description":"Stage Id"
        },
        "stageDescription":{
            "type":"string",
            "description":"Stage desc"
        },
        "branchCode":{
            "type":"string",
            "description":"Branch Code"
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Desc"
        },
        "transactionReferenceNo":{
            "type":"string",
            "description":"Transaction Referenec No"
        },
        "processingDate":{
            "description":"Processing Date",
            "type":"string"
        },
        "businessDate":{
            "description":"Business Date",
            "type":"string"
        },
        "workflowInstanceId":{
            "description":"Workflow Instance Id",
            "type":"string"
        },
        "taskInstanceId":{
            "description":"Task Instance Id",
            "type":"string"
        },
        "appId":{
            "description":"AppId of Workflow Service",
            "type":"string"
        },
        "uri":{
            "description":"EndPoint of Workflow Service",
            "type":"string"
        },
        "product":{
            "description":"Product type to identify service for instrument",
            "type":"string"
        },
        "applicationCode":{
            "description":"Application code",
            "type":"string"
        },
        "instrumentModel":{
            "$ref":"#/definitions/InstrumentModel"
        },
        "workflowType":{
            "description":"amount",
            "type":"string"
        },
        "productCode":{
            "description":"amount",
            "type":"string"
        },
        "event":{
            "description":"amount",
            "type":"string"
        },
        "priority":{
            "description":"amount",
            "type":"string"
        },
        "amount":{
            "description":"amount",
            "type":"number"
        },
        "customerNumber":{
            "description":"customerNumber",
            "type":"string"
        },
        "currencyCode":{
            "description":"currencyCode",
            "type":"string"
        },
        "productCategory":{
            "description":"productCategory",
            "type":"string"
        },
        "applicationNumber":{
            "description":"Reference number without seqno",
            "type":"string"
        },
        "acceptedInvoicesModel":{
            "description":"acceptedInvoicesModel",
            "$ref":"#/definitions/AcceptedInvoicesModel"
        }
    }
}

Nested Schema : AcceptedInvoicesModel

Type: object

AcceptedInvoicesModel

Show Source

• corporateId(optional): string
  Corporate Id
• counterPartyId(optional): string
  CounterParty Id
• invoiceDetails(optional): array invoiceDetails
  invoiceDetails
• invoiceTransactionNo(optional): string
  Transaction No for invoices
• nettingAmount(optional): number
  Netted Amount for transaction
• nettingCcy(optional): string
  Netting Currency
• nettingTransactionNo(optional): string
  Netting Transacation No
• paymentTransactionNo(optional): string
  Payment Transaction No
• relationShipCode(optional): string
  Relation Ship Code

{
    "description":"AcceptedInvoicesModel",
    "properties":{
        "nettingTransactionNo":{
            "description":"Netting Transacation No",
            "type":"string"
        },
        "nettingAmount":{
            "type":"number",
            "description":"Netted Amount for transaction"
        },
        "nettingCcy":{
            "description":"Netting Currency",
            "type":"string"
        },
        "corporateId":{
            "description":"Corporate Id",
            "type":"string"
        },
        "counterPartyId":{
            "description":"CounterParty Id",
            "type":"string"
        },
        "relationShipCode":{
            "description":"Relation Ship Code",
            "type":"string"
        },
        "paymentTransactionNo":{
            "type":"string",
            "description":"Payment Transaction No"
        },
        "invoiceTransactionNo":{
            "description":"Transaction No for invoices",
            "type":"string"
        },
        "invoiceDetails":{
            "description":"invoiceDetails",
            "type":"array",
            "items":{
                "$ref":"#/definitions/NettingInvoicesModel"
            }
        }
    }
}

Nested Schema : InstrumentModel

Instruement Model

Match All

Show Source

• object TransactionModel
  Discriminator: model_Type
• object InstrumentModel-allOf[1]

{
    "description":"Instruement Model",
    "allOf":[
        {
            "$ref":"#/definitions/TransactionModel"
        },
        {
            "type":"object",
            "properties":{
                "referenceNum":{
                    "description":"Reference Num of the batch",
                    "type":"string"
                },
                "depositSlipRefNo":{
                    "description":"Deposit Slip Ref No of the Instrument",
                    "type":"string"
                },
                "depositSlipNo":{
                    "description":"no of the DepositSlipNo",
                    "type":"integer",
                    "format":"int64"
                },
                "instrumentRefNo":{
                    "description":"Instrument Ref No of the Instrument",
                    "type":"string"
                },
                "instrumentNo":{
                    "description":"no of the Instrument",
                    "type":"integer",
                    "format":"int64"
                },
                "instrumentDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Instrument Date"
                },
                "instrumentType":{
                    "description":"Instrument Type",
                    "type":"string"
                },
                "instrumentAmtCcy":{
                    "description":"Instrument Amount Currency",
                    "type":"string"
                },
                "instrumentAmt":{
                    "description":"Instrument Amount",
                    "type":"number"
                },
                "routingNumber":{
                    "description":"Routing Number",
                    "type":"number"
                },
                "drawnOnBankCode":{
                    "description":"Drawn On Bank Code",
                    "type":"string"
                },
                "drawnOnBankName":{
                    "description":"Drawn On Bank Name",
                    "type":"string"
                },
                "drawnOnBranchCode":{
                    "description":"Drawn On Branch Code",
                    "type":"string"
                },
                "drawnOnBranchName":{
                    "description":"Drawn On Branch Name",
                    "type":"string"
                },
                "payableAtLocationCode":{
                    "description":"Payable At Location Code",
                    "type":"string"
                },
                "payableAtLocationDesc":{
                    "description":"Payable At Location Description",
                    "type":"string"
                },
                "payableAtLocClusterCode":{
                    "description":"Payable At Location Cluster Code",
                    "type":"string"
                },
                "payableAtLocClusterDesc":{
                    "description":"Payable At Location Cluster Description",
                    "type":"string"
                },
                "drawerId":{
                    "description":"Drawer Id",
                    "type":"string"
                },
                "drawerName":{
                    "description":"Drawer Name",
                    "type":"string"
                },
                "drawerAcNo":{
                    "description":"Drawer Account Number",
                    "type":"number"
                },
                "drawerAcName":{
                    "description":"Drawer Account Name",
                    "type":"string"
                },
                "clearingNetworkCode":{
                    "description":"Clearing Network Code",
                    "type":"string"
                },
                "clearingNetworkDesc":{
                    "description":"Clearing Network Description",
                    "type":"string"
                },
                "corporateRefNo":{
                    "description":"Corporate Reference Number",
                    "type":"string"
                },
                "creditAccountNo":{
                    "description":"Credit Account Number",
                    "type":"number"
                },
                "productCode":{
                    "description":"Product Code",
                    "type":"string"
                },
                "productDesc":{
                    "description":"Product Description",
                    "type":"string"
                },
                "divisionCode":{
                    "description":"Division Code",
                    "type":"string"
                },
                "divisionCodeDesc":{
                    "description":"Division Code Description",
                    "type":"string"
                },
                "instrumentStatus":{
                    "description":"Instrument Status",
                    "type":"string"
                },
                "instrumentCount":{
                    "description":"Instrument Count",
                    "type":"number"
                },
                "instrumentAmountValue":{
                    "description":"Instrument Amount Value",
                    "type":"number"
                },
                "noOfMiscFields":{
                    "description":"Number Of Miscellaneous Fields",
                    "type":"number"
                },
                "misc1":{
                    "description":"Miscellaneous 1",
                    "type":"string"
                },
                "misc2":{
                    "description":"Miscellaneous 2",
                    "type":"string"
                },
                "misc3":{
                    "description":"Miscellaneous 3",
                    "type":"string"
                },
                "misc4":{
                    "description":"Miscellaneous 4",
                    "type":"string"
                },
                "misc5":{
                    "description":"Miscellaneous 5",
                    "type":"string"
                },
                "misc6":{
                    "description":"Miscellaneous 6",
                    "type":"string"
                },
                "misc7":{
                    "description":"Miscellaneous 7",
                    "type":"string"
                },
                "misc8":{
                    "description":"Miscellaneous 8",
                    "type":"string"
                },
                "misc9":{
                    "description":"Miscellaneous 9",
                    "type":"string"
                },
                "misc10":{
                    "description":"Miscellaneous 10",
                    "type":"string"
                },
                "misc11":{
                    "description":"Miscellaneous 11",
                    "type":"string"
                },
                "misc12":{
                    "description":"Miscellaneous 12",
                    "type":"string"
                },
                "misc13":{
                    "description":"Miscellaneous 13",
                    "type":"string"
                },
                "misc14":{
                    "description":"Miscellaneous 14",
                    "type":"string"
                },
                "misc15":{
                    "description":"Miscellaneous 15",
                    "type":"string"
                },
                "misc16":{
                    "description":"Miscellaneous 16",
                    "type":"string"
                },
                "misc17":{
                    "description":"Miscellaneous 17",
                    "type":"string"
                },
                "misc18":{
                    "description":"Miscellaneous 18",
                    "type":"string"
                },
                "misc19":{
                    "description":"Miscellaneous 19",
                    "type":"string"
                },
                "misc20":{
                    "description":"Miscellaneous 20",
                    "type":"string"
                },
                "misc21":{
                    "description":"Miscellaneous 21",
                    "type":"string"
                },
                "misc22":{
                    "description":"Miscellaneous 22",
                    "type":"string"
                },
                "misc23":{
                    "description":"Miscellaneous 23",
                    "type":"string"
                },
                "misc24":{
                    "description":"Miscellaneous 24",
                    "type":"string"
                },
                "misc25":{
                    "description":"Miscellaneous 25",
                    "type":"string"
                },
                "misc26":{
                    "description":"Miscellaneous 26",
                    "type":"string"
                },
                "misc27":{
                    "description":"Miscellaneous 27",
                    "type":"string"
                },
                "misc28":{
                    "description":"Miscellaneous 28",
                    "type":"string"
                },
                "misc29":{
                    "description":"Miscellaneous 29",
                    "type":"string"
                },
                "misc30":{
                    "description":"Miscellaneous 30",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : invoiceDetails

Type: array

invoiceDetails

Show Source

• Array of: object NettingInvoicesModel

{
    "description":"invoiceDetails",
    "type":"array",
    "items":{
        "$ref":"#/definitions/NettingInvoicesModel"
    }
}

Nested Schema : NettingInvoicesModel

Type: object

Show Source

• id(optional): string
  Id
• identifier(optional): string
  Identifier For Receivable or Payable
• invoiceAmount(optional): number
  Invoice Amount
• invoiceCcy(optional): string
  Invoice Currency
• invoiceRefNo(optional): string
  Invoice Ref No
• invoiceStatus(optional): string
  Invoice Status
• nettedInvAmount(optional): number
  Netted Inv Amount
• nettingStatus(optional): string
  Invoice Netting Status
• nettingTxnNo(optional): string
  Netting Transaction Number
• outStandingAmount(optional): number
  Invoice OutStanding Amount
• paymentDueDate(optional): string
  Invoice Payment Due Date
• paymentStatus(optional): string
  Invoice Payment Status
• remainingOutStandingAmount(optional): number
  Remaining Out Standing Amount
• sourceRefNo(optional): string
  Source Ref No

{
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "nettingTxnNo":{
            "type":"string",
            "description":"Netting Transaction Number"
        },
        "sourceRefNo":{
            "type":"string",
            "description":"Source Ref No"
        },
        "identifier":{
            "type":"string",
            "description":"Identifier For Receivable or Payable"
        },
        "invoiceRefNo":{
            "type":"string",
            "description":"Invoice Ref No"
        },
        "invoiceStatus":{
            "type":"string",
            "description":"Invoice Status"
        },
        "paymentStatus":{
            "type":"string",
            "description":"Invoice Payment Status"
        },
        "nettingStatus":{
            "type":"string",
            "description":"Invoice Netting Status"
        },
        "outStandingAmount":{
            "type":"number",
            "description":"Invoice OutStanding Amount"
        },
        "invoiceAmount":{
            "type":"number",
            "description":"Invoice Amount"
        },
        "paymentDueDate":{
            "type":"string",
            "description":"Invoice Payment Due Date"
        },
        "nettedInvAmount":{
            "type":"number",
            "description":"Netted Inv Amount"
        },
        "remainingOutStandingAmount":{
            "type":"number",
            "description":"Remaining Out Standing Amount"
        },
        "invoiceCcy":{
            "type":"string",
            "description":"Invoice Currency"
        }
    }
}

Nested Schema : TransactionModel

Type: object

Discriminator: model_Type

Nested Schema : InstrumentModel-allOf[1]

Type: object

Show Source

• clearingNetworkCode(optional): string
  Clearing Network Code
• clearingNetworkDesc(optional): string
  Clearing Network Description
• corporateRefNo(optional): string
  Corporate Reference Number
• creditAccountNo(optional): number
  Credit Account Number
• depositSlipNo(optional): integer(int64)
  no of the DepositSlipNo
• depositSlipRefNo(optional): string
  Deposit Slip Ref No of the Instrument
• divisionCode(optional): string
  Division Code
• divisionCodeDesc(optional): string
  Division Code Description
• drawerAcName(optional): string
  Drawer Account Name
• drawerAcNo(optional): number
  Drawer Account Number
• drawerId(optional): string
  Drawer Id
• drawerName(optional): string
  Drawer Name
• drawnOnBankCode(optional): string
  Drawn On Bank Code
• drawnOnBankName(optional): string
  Drawn On Bank Name
• drawnOnBranchCode(optional): string
  Drawn On Branch Code
• drawnOnBranchName(optional): string
  Drawn On Branch Name
• instrumentAmountValue(optional): number
  Instrument Amount Value
• instrumentAmt(optional): number
  Instrument Amount
• instrumentAmtCcy(optional): string
  Instrument Amount Currency
• instrumentCount(optional): number
  Instrument Count
• instrumentDate(optional): string(date)
  Instrument Date
• instrumentNo(optional): integer(int64)
  no of the Instrument
• instrumentRefNo(optional): string
  Instrument Ref No of the Instrument
• instrumentStatus(optional): string
  Instrument Status
• instrumentType(optional): string
  Instrument Type
• misc1(optional): string
  Miscellaneous 1
• misc10(optional): string
  Miscellaneous 10
• misc11(optional): string
  Miscellaneous 11
• misc12(optional): string
  Miscellaneous 12
• misc13(optional): string
  Miscellaneous 13
• misc14(optional): string
  Miscellaneous 14
• misc15(optional): string
  Miscellaneous 15
• misc16(optional): string
  Miscellaneous 16
• misc17(optional): string
  Miscellaneous 17
• misc18(optional): string
  Miscellaneous 18
• misc19(optional): string
  Miscellaneous 19
• misc2(optional): string
  Miscellaneous 2
• misc20(optional): string
  Miscellaneous 20
• misc21(optional): string
  Miscellaneous 21
• misc22(optional): string
  Miscellaneous 22
• misc23(optional): string
  Miscellaneous 23
• misc24(optional): string
  Miscellaneous 24
• misc25(optional): string
  Miscellaneous 25
• misc26(optional): string
  Miscellaneous 26
• misc27(optional): string
  Miscellaneous 27
• misc28(optional): string
  Miscellaneous 28
• misc29(optional): string
  Miscellaneous 29
• misc3(optional): string
  Miscellaneous 3
• misc30(optional): string
  Miscellaneous 30
• misc4(optional): string
  Miscellaneous 4
• misc5(optional): string
  Miscellaneous 5
• misc6(optional): string
  Miscellaneous 6
• misc7(optional): string
  Miscellaneous 7
• misc8(optional): string
  Miscellaneous 8
• misc9(optional): string
  Miscellaneous 9
• noOfMiscFields(optional): number
  Number Of Miscellaneous Fields
• payableAtLocationCode(optional): string
  Payable At Location Code
• payableAtLocationDesc(optional): string
  Payable At Location Description
• payableAtLocClusterCode(optional): string
  Payable At Location Cluster Code
• payableAtLocClusterDesc(optional): string
  Payable At Location Cluster Description
• productCode(optional): string
  Product Code
• productDesc(optional): string
  Product Description
• referenceNum(optional): string
  Reference Num of the batch
• routingNumber(optional): number
  Routing Number

{
    "type":"object",
    "properties":{
        "referenceNum":{
            "description":"Reference Num of the batch",
            "type":"string"
        },
        "depositSlipRefNo":{
            "description":"Deposit Slip Ref No of the Instrument",
            "type":"string"
        },
        "depositSlipNo":{
            "description":"no of the DepositSlipNo",
            "type":"integer",
            "format":"int64"
        },
        "instrumentRefNo":{
            "description":"Instrument Ref No of the Instrument",
            "type":"string"
        },
        "instrumentNo":{
            "description":"no of the Instrument",
            "type":"integer",
            "format":"int64"
        },
        "instrumentDate":{
            "type":"string",
            "format":"date",
            "description":"Instrument Date"
        },
        "instrumentType":{
            "description":"Instrument Type",
            "type":"string"
        },
        "instrumentAmtCcy":{
            "description":"Instrument Amount Currency",
            "type":"string"
        },
        "instrumentAmt":{
            "description":"Instrument Amount",
            "type":"number"
        },
        "routingNumber":{
            "description":"Routing Number",
            "type":"number"
        },
        "drawnOnBankCode":{
            "description":"Drawn On Bank Code",
            "type":"string"
        },
        "drawnOnBankName":{
            "description":"Drawn On Bank Name",
            "type":"string"
        },
        "drawnOnBranchCode":{
            "description":"Drawn On Branch Code",
            "type":"string"
        },
        "drawnOnBranchName":{
            "description":"Drawn On Branch Name",
            "type":"string"
        },
        "payableAtLocationCode":{
            "description":"Payable At Location Code",
            "type":"string"
        },
        "payableAtLocationDesc":{
            "description":"Payable At Location Description",
            "type":"string"
        },
        "payableAtLocClusterCode":{
            "description":"Payable At Location Cluster Code",
            "type":"string"
        },
        "payableAtLocClusterDesc":{
            "description":"Payable At Location Cluster Description",
            "type":"string"
        },
        "drawerId":{
            "description":"Drawer Id",
            "type":"string"
        },
        "drawerName":{
            "description":"Drawer Name",
            "type":"string"
        },
        "drawerAcNo":{
            "description":"Drawer Account Number",
            "type":"number"
        },
        "drawerAcName":{
            "description":"Drawer Account Name",
            "type":"string"
        },
        "clearingNetworkCode":{
            "description":"Clearing Network Code",
            "type":"string"
        },
        "clearingNetworkDesc":{
            "description":"Clearing Network Description",
            "type":"string"
        },
        "corporateRefNo":{
            "description":"Corporate Reference Number",
            "type":"string"
        },
        "creditAccountNo":{
            "description":"Credit Account Number",
            "type":"number"
        },
        "productCode":{
            "description":"Product Code",
            "type":"string"
        },
        "productDesc":{
            "description":"Product Description",
            "type":"string"
        },
        "divisionCode":{
            "description":"Division Code",
            "type":"string"
        },
        "divisionCodeDesc":{
            "description":"Division Code Description",
            "type":"string"
        },
        "instrumentStatus":{
            "description":"Instrument Status",
            "type":"string"
        },
        "instrumentCount":{
            "description":"Instrument Count",
            "type":"number"
        },
        "instrumentAmountValue":{
            "description":"Instrument Amount Value",
            "type":"number"
        },
        "noOfMiscFields":{
            "description":"Number Of Miscellaneous Fields",
            "type":"number"
        },
        "misc1":{
            "description":"Miscellaneous 1",
            "type":"string"
        },
        "misc2":{
            "description":"Miscellaneous 2",
            "type":"string"
        },
        "misc3":{
            "description":"Miscellaneous 3",
            "type":"string"
        },
        "misc4":{
            "description":"Miscellaneous 4",
            "type":"string"
        },
        "misc5":{
            "description":"Miscellaneous 5",
            "type":"string"
        },
        "misc6":{
            "description":"Miscellaneous 6",
            "type":"string"
        },
        "misc7":{
            "description":"Miscellaneous 7",
            "type":"string"
        },
        "misc8":{
            "description":"Miscellaneous 8",
            "type":"string"
        },
        "misc9":{
            "description":"Miscellaneous 9",
            "type":"string"
        },
        "misc10":{
            "description":"Miscellaneous 10",
            "type":"string"
        },
        "misc11":{
            "description":"Miscellaneous 11",
            "type":"string"
        },
        "misc12":{
            "description":"Miscellaneous 12",
            "type":"string"
        },
        "misc13":{
            "description":"Miscellaneous 13",
            "type":"string"
        },
        "misc14":{
            "description":"Miscellaneous 14",
            "type":"string"
        },
        "misc15":{
            "description":"Miscellaneous 15",
            "type":"string"
        },
        "misc16":{
            "description":"Miscellaneous 16",
            "type":"string"
        },
        "misc17":{
            "description":"Miscellaneous 17",
            "type":"string"
        },
        "misc18":{
            "description":"Miscellaneous 18",
            "type":"string"
        },
        "misc19":{
            "description":"Miscellaneous 19",
            "type":"string"
        },
        "misc20":{
            "description":"Miscellaneous 20",
            "type":"string"
        },
        "misc21":{
            "description":"Miscellaneous 21",
            "type":"string"
        },
        "misc22":{
            "description":"Miscellaneous 22",
            "type":"string"
        },
        "misc23":{
            "description":"Miscellaneous 23",
            "type":"string"
        },
        "misc24":{
            "description":"Miscellaneous 24",
            "type":"string"
        },
        "misc25":{
            "description":"Miscellaneous 25",
            "type":"string"
        },
        "misc26":{
            "description":"Miscellaneous 26",
            "type":"string"
        },
        "misc27":{
            "description":"Miscellaneous 27",
            "type":"string"
        },
        "misc28":{
            "description":"Miscellaneous 28",
            "type":"string"
        },
        "misc29":{
            "description":"Miscellaneous 29",
            "type":"string"
        },
        "misc30":{
            "description":"Miscellaneous 30",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns the authorized payment status.

Body ()

Root Schema : ConductorWorkflowModel

Type: object

ConductorWorkflowModel

Show Source

• acceptedInvoicesModel(optional): object AcceptedInvoicesModel
  AcceptedInvoicesModel
• amount(optional): number
  amount
• appId(optional): string
  AppId of Workflow Service
• applicationCode(optional): string
  Application code
• applicationNumber(optional): string
  Reference number without seqno
• branchCode(optional): string
  Branch Code
• businessDate(optional): string
  Business Date
• currencyCode(optional): string
  currencyCode
• customerNumber(optional): string
  customerNumber
• errorCode(optional): string
  Error Code
• errorDesc(optional): string
  Error Desc
• event(optional): string
  amount
• instrumentModel(optional): InstrumentModel
  Instruement Model
• priority(optional): string
  amount
• processCode(optional): string
  Process Code to identify workflow
• processingDate(optional): string
  Processing Date
• processName(optional): string
  Process Name to identify workflow
• product(optional): string
  Product type to identify service for instrument
• productCategory(optional): string
  productCategory
• productCode(optional): string
  amount
• stageDescription(optional): string
  Stage desc
• stageId(optional): string
  Stage Id
• taskInstanceId(optional): string
  Task Instance Id
• transactionReferenceNo(optional): string
  Transaction Referenec No
• uri(optional): string
  EndPoint of Workflow Service
• userId(optional): string
  User Id
• workflowInstanceId(optional): string
  Workflow Instance Id
• workflowType(optional): string
  amount

{
    "description":"ConductorWorkflowModel",
    "type":"object",
    "properties":{
        "processCode":{
            "type":"string",
            "description":"Process Code to identify workflow"
        },
        "processName":{
            "type":"string",
            "description":"Process Name to identify workflow"
        },
        "userId":{
            "type":"string",
            "description":"User Id"
        },
        "stageId":{
            "type":"string",
            "description":"Stage Id"
        },
        "stageDescription":{
            "type":"string",
            "description":"Stage desc"
        },
        "branchCode":{
            "type":"string",
            "description":"Branch Code"
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Desc"
        },
        "transactionReferenceNo":{
            "type":"string",
            "description":"Transaction Referenec No"
        },
        "processingDate":{
            "description":"Processing Date",
            "type":"string"
        },
        "businessDate":{
            "description":"Business Date",
            "type":"string"
        },
        "workflowInstanceId":{
            "description":"Workflow Instance Id",
            "type":"string"
        },
        "taskInstanceId":{
            "description":"Task Instance Id",
            "type":"string"
        },
        "appId":{
            "description":"AppId of Workflow Service",
            "type":"string"
        },
        "uri":{
            "description":"EndPoint of Workflow Service",
            "type":"string"
        },
        "product":{
            "description":"Product type to identify service for instrument",
            "type":"string"
        },
        "applicationCode":{
            "description":"Application code",
            "type":"string"
        },
        "instrumentModel":{
            "$ref":"#/definitions/InstrumentModel"
        },
        "workflowType":{
            "description":"amount",
            "type":"string"
        },
        "productCode":{
            "description":"amount",
            "type":"string"
        },
        "event":{
            "description":"amount",
            "type":"string"
        },
        "priority":{
            "description":"amount",
            "type":"string"
        },
        "amount":{
            "description":"amount",
            "type":"number"
        },
        "customerNumber":{
            "description":"customerNumber",
            "type":"string"
        },
        "currencyCode":{
            "description":"currencyCode",
            "type":"string"
        },
        "productCategory":{
            "description":"productCategory",
            "type":"string"
        },
        "applicationNumber":{
            "description":"Reference number without seqno",
            "type":"string"
        },
        "acceptedInvoicesModel":{
            "description":"acceptedInvoicesModel",
            "$ref":"#/definitions/AcceptedInvoicesModel"
        }
    }
}

Nested Schema : AcceptedInvoicesModel

Type: object

AcceptedInvoicesModel

Show Source

• corporateId(optional): string
  Corporate Id
• counterPartyId(optional): string
  CounterParty Id
• invoiceDetails(optional): array invoiceDetails
  invoiceDetails
• invoiceTransactionNo(optional): string
  Transaction No for invoices
• nettingAmount(optional): number
  Netted Amount for transaction
• nettingCcy(optional): string
  Netting Currency
• nettingTransactionNo(optional): string
  Netting Transacation No
• paymentTransactionNo(optional): string
  Payment Transaction No
• relationShipCode(optional): string
  Relation Ship Code

{
    "description":"AcceptedInvoicesModel",
    "properties":{
        "nettingTransactionNo":{
            "description":"Netting Transacation No",
            "type":"string"
        },
        "nettingAmount":{
            "type":"number",
            "description":"Netted Amount for transaction"
        },
        "nettingCcy":{
            "description":"Netting Currency",
            "type":"string"
        },
        "corporateId":{
            "description":"Corporate Id",
            "type":"string"
        },
        "counterPartyId":{
            "description":"CounterParty Id",
            "type":"string"
        },
        "relationShipCode":{
            "description":"Relation Ship Code",
            "type":"string"
        },
        "paymentTransactionNo":{
            "type":"string",
            "description":"Payment Transaction No"
        },
        "invoiceTransactionNo":{
            "description":"Transaction No for invoices",
            "type":"string"
        },
        "invoiceDetails":{
            "description":"invoiceDetails",
            "type":"array",
            "items":{
                "$ref":"#/definitions/NettingInvoicesModel"
            }
        }
    }
}

Nested Schema : InstrumentModel

Instruement Model

Match All

Show Source

• object TransactionModel
  Discriminator: model_Type
• object InstrumentModel-allOf[1]

{
    "description":"Instruement Model",
    "allOf":[
        {
            "$ref":"#/definitions/TransactionModel"
        },
        {
            "type":"object",
            "properties":{
                "referenceNum":{
                    "description":"Reference Num of the batch",
                    "type":"string"
                },
                "depositSlipRefNo":{
                    "description":"Deposit Slip Ref No of the Instrument",
                    "type":"string"
                },
                "depositSlipNo":{
                    "description":"no of the DepositSlipNo",
                    "type":"integer",
                    "format":"int64"
                },
                "instrumentRefNo":{
                    "description":"Instrument Ref No of the Instrument",
                    "type":"string"
                },
                "instrumentNo":{
                    "description":"no of the Instrument",
                    "type":"integer",
                    "format":"int64"
                },
                "instrumentDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Instrument Date"
                },
                "instrumentType":{
                    "description":"Instrument Type",
                    "type":"string"
                },
                "instrumentAmtCcy":{
                    "description":"Instrument Amount Currency",
                    "type":"string"
                },
                "instrumentAmt":{
                    "description":"Instrument Amount",
                    "type":"number"
                },
                "routingNumber":{
                    "description":"Routing Number",
                    "type":"number"
                },
                "drawnOnBankCode":{
                    "description":"Drawn On Bank Code",
                    "type":"string"
                },
                "drawnOnBankName":{
                    "description":"Drawn On Bank Name",
                    "type":"string"
                },
                "drawnOnBranchCode":{
                    "description":"Drawn On Branch Code",
                    "type":"string"
                },
                "drawnOnBranchName":{
                    "description":"Drawn On Branch Name",
                    "type":"string"
                },
                "payableAtLocationCode":{
                    "description":"Payable At Location Code",
                    "type":"string"
                },
                "payableAtLocationDesc":{
                    "description":"Payable At Location Description",
                    "type":"string"
                },
                "payableAtLocClusterCode":{
                    "description":"Payable At Location Cluster Code",
                    "type":"string"
                },
                "payableAtLocClusterDesc":{
                    "description":"Payable At Location Cluster Description",
                    "type":"string"
                },
                "drawerId":{
                    "description":"Drawer Id",
                    "type":"string"
                },
                "drawerName":{
                    "description":"Drawer Name",
                    "type":"string"
                },
                "drawerAcNo":{
                    "description":"Drawer Account Number",
                    "type":"number"
                },
                "drawerAcName":{
                    "description":"Drawer Account Name",
                    "type":"string"
                },
                "clearingNetworkCode":{
                    "description":"Clearing Network Code",
                    "type":"string"
                },
                "clearingNetworkDesc":{
                    "description":"Clearing Network Description",
                    "type":"string"
                },
                "corporateRefNo":{
                    "description":"Corporate Reference Number",
                    "type":"string"
                },
                "creditAccountNo":{
                    "description":"Credit Account Number",
                    "type":"number"
                },
                "productCode":{
                    "description":"Product Code",
                    "type":"string"
                },
                "productDesc":{
                    "description":"Product Description",
                    "type":"string"
                },
                "divisionCode":{
                    "description":"Division Code",
                    "type":"string"
                },
                "divisionCodeDesc":{
                    "description":"Division Code Description",
                    "type":"string"
                },
                "instrumentStatus":{
                    "description":"Instrument Status",
                    "type":"string"
                },
                "instrumentCount":{
                    "description":"Instrument Count",
                    "type":"number"
                },
                "instrumentAmountValue":{
                    "description":"Instrument Amount Value",
                    "type":"number"
                },
                "noOfMiscFields":{
                    "description":"Number Of Miscellaneous Fields",
                    "type":"number"
                },
                "misc1":{
                    "description":"Miscellaneous 1",
                    "type":"string"
                },
                "misc2":{
                    "description":"Miscellaneous 2",
                    "type":"string"
                },
                "misc3":{
                    "description":"Miscellaneous 3",
                    "type":"string"
                },
                "misc4":{
                    "description":"Miscellaneous 4",
                    "type":"string"
                },
                "misc5":{
                    "description":"Miscellaneous 5",
                    "type":"string"
                },
                "misc6":{
                    "description":"Miscellaneous 6",
                    "type":"string"
                },
                "misc7":{
                    "description":"Miscellaneous 7",
                    "type":"string"
                },
                "misc8":{
                    "description":"Miscellaneous 8",
                    "type":"string"
                },
                "misc9":{
                    "description":"Miscellaneous 9",
                    "type":"string"
                },
                "misc10":{
                    "description":"Miscellaneous 10",
                    "type":"string"
                },
                "misc11":{
                    "description":"Miscellaneous 11",
                    "type":"string"
                },
                "misc12":{
                    "description":"Miscellaneous 12",
                    "type":"string"
                },
                "misc13":{
                    "description":"Miscellaneous 13",
                    "type":"string"
                },
                "misc14":{
                    "description":"Miscellaneous 14",
                    "type":"string"
                },
                "misc15":{
                    "description":"Miscellaneous 15",
                    "type":"string"
                },
                "misc16":{
                    "description":"Miscellaneous 16",
                    "type":"string"
                },
                "misc17":{
                    "description":"Miscellaneous 17",
                    "type":"string"
                },
                "misc18":{
                    "description":"Miscellaneous 18",
                    "type":"string"
                },
                "misc19":{
                    "description":"Miscellaneous 19",
                    "type":"string"
                },
                "misc20":{
                    "description":"Miscellaneous 20",
                    "type":"string"
                },
                "misc21":{
                    "description":"Miscellaneous 21",
                    "type":"string"
                },
                "misc22":{
                    "description":"Miscellaneous 22",
                    "type":"string"
                },
                "misc23":{
                    "description":"Miscellaneous 23",
                    "type":"string"
                },
                "misc24":{
                    "description":"Miscellaneous 24",
                    "type":"string"
                },
                "misc25":{
                    "description":"Miscellaneous 25",
                    "type":"string"
                },
                "misc26":{
                    "description":"Miscellaneous 26",
                    "type":"string"
                },
                "misc27":{
                    "description":"Miscellaneous 27",
                    "type":"string"
                },
                "misc28":{
                    "description":"Miscellaneous 28",
                    "type":"string"
                },
                "misc29":{
                    "description":"Miscellaneous 29",
                    "type":"string"
                },
                "misc30":{
                    "description":"Miscellaneous 30",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : invoiceDetails

Type: array

invoiceDetails

Show Source

• Array of: object NettingInvoicesModel

{
    "description":"invoiceDetails",
    "type":"array",
    "items":{
        "$ref":"#/definitions/NettingInvoicesModel"
    }
}

Nested Schema : NettingInvoicesModel

Type: object

Show Source

• id(optional): string
  Id
• identifier(optional): string
  Identifier For Receivable or Payable
• invoiceAmount(optional): number
  Invoice Amount
• invoiceCcy(optional): string
  Invoice Currency
• invoiceRefNo(optional): string
  Invoice Ref No
• invoiceStatus(optional): string
  Invoice Status
• nettedInvAmount(optional): number
  Netted Inv Amount
• nettingStatus(optional): string
  Invoice Netting Status
• nettingTxnNo(optional): string
  Netting Transaction Number
• outStandingAmount(optional): number
  Invoice OutStanding Amount
• paymentDueDate(optional): string
  Invoice Payment Due Date
• paymentStatus(optional): string
  Invoice Payment Status
• remainingOutStandingAmount(optional): number
  Remaining Out Standing Amount
• sourceRefNo(optional): string
  Source Ref No

{
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "nettingTxnNo":{
            "type":"string",
            "description":"Netting Transaction Number"
        },
        "sourceRefNo":{
            "type":"string",
            "description":"Source Ref No"
        },
        "identifier":{
            "type":"string",
            "description":"Identifier For Receivable or Payable"
        },
        "invoiceRefNo":{
            "type":"string",
            "description":"Invoice Ref No"
        },
        "invoiceStatus":{
            "type":"string",
            "description":"Invoice Status"
        },
        "paymentStatus":{
            "type":"string",
            "description":"Invoice Payment Status"
        },
        "nettingStatus":{
            "type":"string",
            "description":"Invoice Netting Status"
        },
        "outStandingAmount":{
            "type":"number",
            "description":"Invoice OutStanding Amount"
        },
        "invoiceAmount":{
            "type":"number",
            "description":"Invoice Amount"
        },
        "paymentDueDate":{
            "type":"string",
            "description":"Invoice Payment Due Date"
        },
        "nettedInvAmount":{
            "type":"number",
            "description":"Netted Inv Amount"
        },
        "remainingOutStandingAmount":{
            "type":"number",
            "description":"Remaining Out Standing Amount"
        },
        "invoiceCcy":{
            "type":"string",
            "description":"Invoice Currency"
        }
    }
}

Nested Schema : TransactionModel

Type: object

Discriminator: model_Type

Nested Schema : InstrumentModel-allOf[1]

Type: object

Show Source

• clearingNetworkCode(optional): string
  Clearing Network Code
• clearingNetworkDesc(optional): string
  Clearing Network Description
• corporateRefNo(optional): string
  Corporate Reference Number
• creditAccountNo(optional): number
  Credit Account Number
• depositSlipNo(optional): integer(int64)
  no of the DepositSlipNo
• depositSlipRefNo(optional): string
  Deposit Slip Ref No of the Instrument
• divisionCode(optional): string
  Division Code
• divisionCodeDesc(optional): string
  Division Code Description
• drawerAcName(optional): string
  Drawer Account Name
• drawerAcNo(optional): number
  Drawer Account Number
• drawerId(optional): string
  Drawer Id
• drawerName(optional): string
  Drawer Name
• drawnOnBankCode(optional): string
  Drawn On Bank Code
• drawnOnBankName(optional): string
  Drawn On Bank Name
• drawnOnBranchCode(optional): string
  Drawn On Branch Code
• drawnOnBranchName(optional): string
  Drawn On Branch Name
• instrumentAmountValue(optional): number
  Instrument Amount Value
• instrumentAmt(optional): number
  Instrument Amount
• instrumentAmtCcy(optional): string
  Instrument Amount Currency
• instrumentCount(optional): number
  Instrument Count
• instrumentDate(optional): string(date)
  Instrument Date
• instrumentNo(optional): integer(int64)
  no of the Instrument
• instrumentRefNo(optional): string
  Instrument Ref No of the Instrument
• instrumentStatus(optional): string
  Instrument Status
• instrumentType(optional): string
  Instrument Type
• misc1(optional): string
  Miscellaneous 1
• misc10(optional): string
  Miscellaneous 10
• misc11(optional): string
  Miscellaneous 11
• misc12(optional): string
  Miscellaneous 12
• misc13(optional): string
  Miscellaneous 13
• misc14(optional): string
  Miscellaneous 14
• misc15(optional): string
  Miscellaneous 15
• misc16(optional): string
  Miscellaneous 16
• misc17(optional): string
  Miscellaneous 17
• misc18(optional): string
  Miscellaneous 18
• misc19(optional): string
  Miscellaneous 19
• misc2(optional): string
  Miscellaneous 2
• misc20(optional): string
  Miscellaneous 20
• misc21(optional): string
  Miscellaneous 21
• misc22(optional): string
  Miscellaneous 22
• misc23(optional): string
  Miscellaneous 23
• misc24(optional): string
  Miscellaneous 24
• misc25(optional): string
  Miscellaneous 25
• misc26(optional): string
  Miscellaneous 26
• misc27(optional): string
  Miscellaneous 27
• misc28(optional): string
  Miscellaneous 28
• misc29(optional): string
  Miscellaneous 29
• misc3(optional): string
  Miscellaneous 3
• misc30(optional): string
  Miscellaneous 30
• misc4(optional): string
  Miscellaneous 4
• misc5(optional): string
  Miscellaneous 5
• misc6(optional): string
  Miscellaneous 6
• misc7(optional): string
  Miscellaneous 7
• misc8(optional): string
  Miscellaneous 8
• misc9(optional): string
  Miscellaneous 9
• noOfMiscFields(optional): number
  Number Of Miscellaneous Fields
• payableAtLocationCode(optional): string
  Payable At Location Code
• payableAtLocationDesc(optional): string
  Payable At Location Description
• payableAtLocClusterCode(optional): string
  Payable At Location Cluster Code
• payableAtLocClusterDesc(optional): string
  Payable At Location Cluster Description
• productCode(optional): string
  Product Code
• productDesc(optional): string
  Product Description
• referenceNum(optional): string
  Reference Num of the batch
• routingNumber(optional): number
  Routing Number

{
    "type":"object",
    "properties":{
        "referenceNum":{
            "description":"Reference Num of the batch",
            "type":"string"
        },
        "depositSlipRefNo":{
            "description":"Deposit Slip Ref No of the Instrument",
            "type":"string"
        },
        "depositSlipNo":{
            "description":"no of the DepositSlipNo",
            "type":"integer",
            "format":"int64"
        },
        "instrumentRefNo":{
            "description":"Instrument Ref No of the Instrument",
            "type":"string"
        },
        "instrumentNo":{
            "description":"no of the Instrument",
            "type":"integer",
            "format":"int64"
        },
        "instrumentDate":{
            "type":"string",
            "format":"date",
            "description":"Instrument Date"
        },
        "instrumentType":{
            "description":"Instrument Type",
            "type":"string"
        },
        "instrumentAmtCcy":{
            "description":"Instrument Amount Currency",
            "type":"string"
        },
        "instrumentAmt":{
            "description":"Instrument Amount",
            "type":"number"
        },
        "routingNumber":{
            "description":"Routing Number",
            "type":"number"
        },
        "drawnOnBankCode":{
            "description":"Drawn On Bank Code",
            "type":"string"
        },
        "drawnOnBankName":{
            "description":"Drawn On Bank Name",
            "type":"string"
        },
        "drawnOnBranchCode":{
            "description":"Drawn On Branch Code",
            "type":"string"
        },
        "drawnOnBranchName":{
            "description":"Drawn On Branch Name",
            "type":"string"
        },
        "payableAtLocationCode":{
            "description":"Payable At Location Code",
            "type":"string"
        },
        "payableAtLocationDesc":{
            "description":"Payable At Location Description",
            "type":"string"
        },
        "payableAtLocClusterCode":{
            "description":"Payable At Location Cluster Code",
            "type":"string"
        },
        "payableAtLocClusterDesc":{
            "description":"Payable At Location Cluster Description",
            "type":"string"
        },
        "drawerId":{
            "description":"Drawer Id",
            "type":"string"
        },
        "drawerName":{
            "description":"Drawer Name",
            "type":"string"
        },
        "drawerAcNo":{
            "description":"Drawer Account Number",
            "type":"number"
        },
        "drawerAcName":{
            "description":"Drawer Account Name",
            "type":"string"
        },
        "clearingNetworkCode":{
            "description":"Clearing Network Code",
            "type":"string"
        },
        "clearingNetworkDesc":{
            "description":"Clearing Network Description",
            "type":"string"
        },
        "corporateRefNo":{
            "description":"Corporate Reference Number",
            "type":"string"
        },
        "creditAccountNo":{
            "description":"Credit Account Number",
            "type":"number"
        },
        "productCode":{
            "description":"Product Code",
            "type":"string"
        },
        "productDesc":{
            "description":"Product Description",
            "type":"string"
        },
        "divisionCode":{
            "description":"Division Code",
            "type":"string"
        },
        "divisionCodeDesc":{
            "description":"Division Code Description",
            "type":"string"
        },
        "instrumentStatus":{
            "description":"Instrument Status",
            "type":"string"
        },
        "instrumentCount":{
            "description":"Instrument Count",
            "type":"number"
        },
        "instrumentAmountValue":{
            "description":"Instrument Amount Value",
            "type":"number"
        },
        "noOfMiscFields":{
            "description":"Number Of Miscellaneous Fields",
            "type":"number"
        },
        "misc1":{
            "description":"Miscellaneous 1",
            "type":"string"
        },
        "misc2":{
            "description":"Miscellaneous 2",
            "type":"string"
        },
        "misc3":{
            "description":"Miscellaneous 3",
            "type":"string"
        },
        "misc4":{
            "description":"Miscellaneous 4",
            "type":"string"
        },
        "misc5":{
            "description":"Miscellaneous 5",
            "type":"string"
        },
        "misc6":{
            "description":"Miscellaneous 6",
            "type":"string"
        },
        "misc7":{
            "description":"Miscellaneous 7",
            "type":"string"
        },
        "misc8":{
            "description":"Miscellaneous 8",
            "type":"string"
        },
        "misc9":{
            "description":"Miscellaneous 9",
            "type":"string"
        },
        "misc10":{
            "description":"Miscellaneous 10",
            "type":"string"
        },
        "misc11":{
            "description":"Miscellaneous 11",
            "type":"string"
        },
        "misc12":{
            "description":"Miscellaneous 12",
            "type":"string"
        },
        "misc13":{
            "description":"Miscellaneous 13",
            "type":"string"
        },
        "misc14":{
            "description":"Miscellaneous 14",
            "type":"string"
        },
        "misc15":{
            "description":"Miscellaneous 15",
            "type":"string"
        },
        "misc16":{
            "description":"Miscellaneous 16",
            "type":"string"
        },
        "misc17":{
            "description":"Miscellaneous 17",
            "type":"string"
        },
        "misc18":{
            "description":"Miscellaneous 18",
            "type":"string"
        },
        "misc19":{
            "description":"Miscellaneous 19",
            "type":"string"
        },
        "misc20":{
            "description":"Miscellaneous 20",
            "type":"string"
        },
        "misc21":{
            "description":"Miscellaneous 21",
            "type":"string"
        },
        "misc22":{
            "description":"Miscellaneous 22",
            "type":"string"
        },
        "misc23":{
            "description":"Miscellaneous 23",
            "type":"string"
        },
        "misc24":{
            "description":"Miscellaneous 24",
            "type":"string"
        },
        "misc25":{
            "description":"Miscellaneous 25",
            "type":"string"
        },
        "misc26":{
            "description":"Miscellaneous 26",
            "type":"string"
        },
        "misc27":{
            "description":"Miscellaneous 27",
            "type":"string"
        },
        "misc28":{
            "description":"Miscellaneous 28",
            "type":"string"
        },
        "misc29":{
            "description":"Miscellaneous 29",
            "type":"string"
        },
        "misc30":{
            "description":"Miscellaneous 30",
            "type":"string"
        }
    }
}

400 Response

Bad Request

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top