Jump to

• Request
• Response

Close the transaction code maintainance by given transaction code

patch

/service/txncodemaint/{txnCode}/close

This endpoint is used to close the transaction code maintainance identified by given transaction code.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• txnCode: string
  Key of the txnCode maintenance

Header Parameters

• sourceCode: string
  Source from which request is initiated

Body ()

Request body contain transaction Code and Modification no of transaction Code maintenance which need to be closed"

Root Schema : TxnCodeDto

Type: object

Show Source

• remarks(optional): string

{
    "type":"object",
    "properties":{
        "remarks":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml
• text/csv

200 Response

Successful operation.

Body ()

Root Schema : TxnCodeMaintServiceResponseWrapperDTO

Type: object

Show Source

• data(optional): object TxnCodeMaintServiceDTO
• messages(optional): object TxnCodeMaintServiceResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/TxnCodeMaintServiceResponseDto"
        },
        "data":{
            "$ref":"#/definitions/TxnCodeMaintServiceDTO"
        }
    }
}

Nested Schema : TxnCodeMaintServiceDTO

Type: object

Match All

Show Source

• object TxnCodeMaintServiceDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "txnCode":{
                    "type":"string",
                    "description":"Txn Code"
                },
                "txnDesc":{
                    "type":"string",
                    "description":"Txn Code Description"
                },
                "days":{
                    "type":"number",
                    "description":"Total No. of Days"
                },
                "availablity":{
                    "type":"string",
                    "description":"Uncollected Funds Availability Information"
                },
                "autoRelease":{
                    "type":"string",
                    "description":"Auto-Release of the uncollected Funds True/False"
                }
            }
        }
    ]
}

Nested Schema : TxnCodeMaintServiceResponseDto

Type: object

Show Source

• codes(optional): array codes
• status(optional): string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TxnCodeMaintServiceResponseCode"
            }
        }
    }
}

Nested Schema : TxnCodeMaintServiceDTO-allOf[0]

Type: object

Show Source

• autoRelease(optional): string
  Auto-Release of the uncollected Funds True/False
• availablity(optional): string
  Uncollected Funds Availability Information
• days(optional): number
  Total No. of Days
• txnCode(optional): string
  Txn Code
• txnDesc(optional): string
  Txn Code Description

{
    "type":"object",
    "properties":{
        "txnCode":{
            "type":"string",
            "description":"Txn Code"
        },
        "txnDesc":{
            "type":"string",
            "description":"Txn Code Description"
        },
        "days":{
            "type":"number",
            "description":"Total No. of Days"
        },
        "availablity":{
            "type":"string",
            "description":"Uncollected Funds Availability Information"
        },
        "autoRelease":{
            "type":"string",
            "description":"Auto-Release of the uncollected Funds True/False"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object TxnCodeMaintServiceResponseCode

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

Nested Schema : TxnCodeMaintServiceResponseCode

Type: object

Show Source

• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top