Jump to

• Request
• Response

Authorizes cashflow transaction

post

/service/v1/authorizeCashflowTxn

This endpoint is used to authorize the cashflow transaction.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
  Application Id
• branchCode: string
  Branch Code
• userId: string
  User Id

Body ()

Request Body that contains data required for creating a new cashflow TM Txn

Root Schema : ObcmsAuthorizeCashflowTxnCollection

Type: object

Collection of Cashflow Transaction to be authorized.

Show Source

• data(optional): array data
  Collection of Authorized Cashflow Transaction Request Data Model

{
    "description":"Collection of Cashflow Transaction to be authorized.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "description":"Collection of Authorized Cashflow Transaction Request Data Model",
            "items":{
                "$ref":"#/definitions/ObcmsAuthorizeCashflowTxnDTO"
            }
        }
    }
}

Nested Schema : data

Type: array

Collection of Authorized Cashflow Transaction Request Data Model

Show Source

• Array of: object ObcmsAuthorizeCashflowTxnDTO
  Authorized Cashfow Transaction Request Parameters model

{
    "type":"array",
    "description":"Collection of Authorized Cashflow Transaction Request Data Model",
    "items":{
        "$ref":"#/definitions/ObcmsAuthorizeCashflowTxnDTO"
    }
}

Nested Schema : ObcmsAuthorizeCashflowTxnDTO

Type: object

Authorized Cashfow Transaction Request Parameters model

Show Source

• applicationName(optional): string
  Application Name
• cashflowIndicator(optional): string
  Cashflow Indicator Flag
• code(optional): string
  Cashflow Code
• corporateId(optional): string
  Corporate Id
• externalReferenceNo(optional): string
  External Reference No
• lastActionPerformed(optional): string
  Last Action Performed
• transactionStatus(optional): string
  Transaction Status
• udfTxt4(optional): string
  User Defined Text 4

{
    "description":"Authorized Cashfow Transaction Request Parameters model",
    "type":"object",
    "properties":{
        "externalReferenceNo":{
            "type":"string",
            "description":"External Reference No"
        },
        "cashflowIndicator":{
            "type":"string",
            "description":"Cashflow Indicator Flag"
        },
        "corporateId":{
            "type":"string",
            "description":"Corporate Id"
        },
        "code":{
            "type":"string",
            "description":"Cashflow Code"
        },
        "applicationName":{
            "type":"string",
            "description":"Application Name"
        },
        "udfTxt4":{
            "type":"string",
            "description":"User Defined Text 4"
        },
        "transactionStatus":{
            "type":"string",
            "description":"Transaction Status"
        },
        "lastActionPerformed":{
            "type":"string",
            "description":"Last Action Performed"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string
  URL of newly created fsgbu

Body ()

Root Schema : ObcmsAuthorizeCashflowTxnResponse

Type: object

Authorized Cashflow Transaction Response Data Model

Show Source

• cashflowResponse(optional): array cashflowResponse
  Collection of Cashflow Transaction Response

{
    "description":"Authorized Cashflow Transaction Response Data Model",
    "type":"object",
    "properties":{
        "cashflowResponse":{
            "description":"Collection of Cashflow Transaction Response",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ObcmsCashflowTransactionRespDTO"
            }
        }
    }
}

Nested Schema : cashflowResponse

Type: array

Collection of Cashflow Transaction Response

Show Source

• Array of: object ObcmsCashflowTransactionRespDTO
  Scf Filter Parameters model

{
    "description":"Collection of Cashflow Transaction Response",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ObcmsCashflowTransactionRespDTO"
    }
}

Nested Schema : ObcmsCashflowTransactionRespDTO

Type: object

Scf Filter Parameters model

Show Source

• actualCashflowAmt(optional): string
  Actual Cashflow Amount
• actualDate(optional): string
  Actual Date
• amount(optional): string
  Amount
• applicationName(optional): string
  Application Name
• authStatus(optional): string
  Authorization Status
• bankAccountNumber(optional): string
  Bank Account Number
• cashflowIndicator(optional): string
  Cashflow Indicator
• ccy(optional): string
  Currency
• channel(optional): string
  Channel
• code(optional): string
  Code
• corporateId(optional): string
  Corporate Id
• description(optional): string
  Description
• errorDesc(optional): string
  Error Description
• errors(optional): array errors
• errorStatus(optional): string
  Error status
• expectedDate(optional): string
  Expected Date
• externalReferenceNo(optional): string
  External Reference Number
• modNo(optional): integer
  Mod No
• narration(optional): string
  Narration
• partyId(optional): string
  Party Id
• partyName(optional): string
  Party Name
• reconStatus(optional): string
  recon status
• responseCode(optional): string
  response Code
• revisedExpectedDate(optional): string
  Revised Expected Date
• status(optional): string
  Status
• transaction Id(optional): string
  Transaction Id
• udfTxt1(optional): string
  Udf Text1
• udfTxt10(optional): string
  Udf Text10
• udfTxt2(optional): string
  Udf Text2
• udfTxt3(optional): string
  Udf Text3
• udfTxt4(optional): string
  Udf Text4
• udfTxt5(optional): string
  Udf Text5
• udfTxt6(optional): string
  Udf Text6
• udfTxt7(optional): string
  Udf Text7
• udfTxt8(optional): string
  Udf Text8
• udfTxt9(optional): string
  Udf Text9
• virtualAcctNo(optional): string
  Virtual Account Number

{
    "description":"Scf Filter Parameters model",
    "properties":{
        "externalReferenceNo":{
            "type":"string",
            "description":"External Reference Number"
        },
        "cashflowIndicator":{
            "type":"string",
            "description":"Cashflow Indicator"
        },
        "corporateId":{
            "type":"string",
            "description":"Corporate Id"
        },
        "code":{
            "type":"string",
            "description":"Code"
        },
        "description":{
            "type":"string",
            "description":"Description"
        },
        "bankAccountNumber":{
            "type":"string",
            "description":"Bank Account Number"
        },
        "amount":{
            "type":"string",
            "description":"Amount"
        },
        "ccy":{
            "type":"string",
            "description":"Currency"
        },
        "expectedDate":{
            "type":"string",
            "description":"Expected Date"
        },
        "actualDate":{
            "type":"string",
            "description":"Actual Date"
        },
        "revisedExpectedDate":{
            "type":"string",
            "description":"Revised Expected Date"
        },
        "channel":{
            "type":"string",
            "description":"Channel"
        },
        "applicationName":{
            "type":"string",
            "description":"Application Name"
        },
        "partyName":{
            "type":"string",
            "description":"Party Name"
        },
        "partyId":{
            "type":"string",
            "description":"Party Id"
        },
        "virtualAcctNo":{
            "type":"string",
            "description":"Virtual Account Number"
        },
        "actualCashflowAmt":{
            "type":"string",
            "description":"Actual Cashflow Amount"
        },
        "narration":{
            "type":"string",
            "description":"Narration"
        },
        "status":{
            "type":"string",
            "description":"Status"
        },
        "udfTxt1":{
            "type":"string",
            "description":"Udf Text1"
        },
        "udfTxt2":{
            "type":"string",
            "description":"Udf Text2"
        },
        "udfTxt3":{
            "type":"string",
            "description":"Udf Text3"
        },
        "udfTxt4":{
            "type":"string",
            "description":"Udf Text4"
        },
        "udfTxt5":{
            "type":"string",
            "description":"Udf Text5"
        },
        "udfTxt6":{
            "type":"string",
            "description":"Udf Text6"
        },
        "udfTxt7":{
            "type":"string",
            "description":"Udf Text7"
        },
        "udfTxt8":{
            "type":"string",
            "description":"Udf Text8"
        },
        "udfTxt9":{
            "type":"string",
            "description":"Udf Text9"
        },
        "udfTxt10":{
            "type":"string",
            "description":"Udf Text10"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Description"
        },
        "errorStatus":{
            "type":"string",
            "description":"Error status"
        },
        "transaction Id":{
            "description":"Transaction Id",
            "type":"string"
        },
        "authStatus":{
            "type":"string",
            "description":"Authorization Status"
        },
        "responseCode":{
            "type":"string",
            "description":"response Code"
        },
        "modNo":{
            "type":"integer",
            "description":"Mod No"
        },
        "reconStatus":{
            "type":"string",
            "description":"recon status"
        },
        "errors":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errors

Type: array

Show Source

• Array of: object Error
  Error Model

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

Nested Schema : Error

Type: object

Error Model

Show Source

• errorCode(optional): string
  Error Code
• errorDescription(optional): string
  Error Description
• errorStatus(optional): string
  Error Status

{
    "type":"object",
    "description":"Error Model",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDescription":{
            "type":"string",
            "description":"Error Description"
        },
        "errorStatus":{
            "type":"string",
            "description":"Error Status"
        }
    }
}

400 Response

Malformed syntax.

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