Jump to

• Request
• Response

Delete the unauthorized cashflow transactions

post

/service/v1/deleteUnAuthCashflowTxn

This endpoint is used to delete the unauthorized cashflow transactions.

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 deleting unauthorized cashflow Txn status

Root Schema : ObcmsUnAuthorizeCashflowTxnCollection

Type: object

Collection of Cashflow Transaction to be UnAuthorized.

Show Source

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

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

Nested Schema : data

Type: array

Collection of UnAuthorized Cashflow Transaction Request Data Model

Show Source

• Array of: object ObcmsUnAuthorizeCashflowTxnDTO
  UnAuthorized Cashfow Transaction Request Parameters model

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

Nested Schema : ObcmsUnAuthorizeCashflowTxnDTO

Type: object

UnAuthorized 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
• udfTxt4(optional): string
  User Defined Text 4

{
    "description":"UnAuthorized 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"
        }
    }
}

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

Type: object

UnAuthorized Cashflow Transaction Response Model

Show Source

• unAuthorizedCashflowResponse(optional): array unAuthorizedCashflowResponse
  Collection of UnAuthorized Cashflow Transaction Response

{
    "description":"UnAuthorized Cashflow Transaction Response Model",
    "type":"object",
    "properties":{
        "unAuthorizedCashflowResponse":{
            "description":"Collection of UnAuthorized Cashflow Transaction Response",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ObcmsUnAuthorizedCashflowTransactionRespDTO"
            }
        }
    }
}

Nested Schema : unAuthorizedCashflowResponse

Type: array

Collection of UnAuthorized Cashflow Transaction Response

Show Source

• Array of: object ObcmsUnAuthorizedCashflowTransactionRespDTO
  UnAuthorized Cashfow Transaction Response DTO model

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

Nested Schema : ObcmsUnAuthorizedCashflowTransactionRespDTO

Type: object

UnAuthorized Cashfow Transaction Response DTO model

Show Source

• applicationName(optional): string
  Application Name
• authStat(optional): string
  Auth status
• cashflowIndicator(optional): string
  Cashflow Indicator Flag
• code(optional): string
  Cashflow Code
• corporateId(optional): string
  Corporate Id
• errors(optional): object errors
  Error Details
• externalReferenceNo(optional): string
  External Reference No
• id(optional): string
  Id
• modNo(optional): integer
  Modification No
• responseCode(optional): string
  Response Code
• udfTxt4(optional): string
  User Defined Text 4

{
    "description":"UnAuthorized Cashfow Transaction Response DTO model",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "modNo":{
            "type":"integer",
            "description":"Modification No"
        },
        "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"
        },
        "authStat":{
            "type":"string",
            "description":"Auth status"
        },
        "responseCode":{
            "type":"string",
            "description":"Response Code"
        },
        "errors":{
            "type":"object",
            "description":"Error Details",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errors

Type: object

Error Details

Show Source

• Array of: object Error
  Error Model

{
    "type":"object",
    "description":"Error Details",
    "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