Jump to

• Request
• Response

Close the core banks by given ID

patch

/service/corebanks/{bankCode}/close

This endpoint is used to close the core banks identified by given ID.

Request

Supported Media Types

• application/json

Path Parameters

• bankCode: string
  bankCode of the corebranchs Maintenance

Header Parameters

• sourceCode: string
  Source from which request is initiated

Body ()

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

Root Schema : CloseDto

Type: object

Show Source

• remarks(optional): string

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : CoreBankResponseDtoWrapper

Type: object

Show Source

• data(optional): object CoreBankDTO
• messages(optional): object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/CoreBankDTO"
        }
    }
}

Nested Schema : CoreBankDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object CoreBankDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "daysToForgetCustomer":{
                    "type":"number",
                    "description":"Number of days after which the data of customer will be deleted from the database.",
                    "maxLength":4
                },
                "hoBranch":{
                    "type":"string",
                    "description":"head Office Branch."
                },
                "bankName":{
                    "type":"string",
                    "description":"Name of the Bank.",
                    "minLength":0,
                    "maxLength":35,
                    "pattern":"^[a-zA-Z0-9\\s]+$"
                },
                "bankCode":{
                    "type":"string",
                    "description":"Bank Code",
                    "minLength":3,
                    "maxLength":4,
                    "pattern":"^[a-zA-Z0-9]+$"
                }
            },
            "required":[
                "hoBranch",
                "bankCode"
            ]
        }
    ]
}

Nested Schema : ResponseDto

Type: object

Show Source

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

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

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : CoreBankDTO-allOf[1]

Type: object

Show Source

• bankCode: string
  Minimum Length: 3

  Maximum Length: 4

  Pattern: ^[a-zA-Z0-9]+$

  Bank Code
• bankName(optional): string
  Minimum Length: 0

  Maximum Length: 35

  Pattern: ^[a-zA-Z0-9\s]+$

  Name of the Bank.
• daysToForgetCustomer(optional): number
  Maximum Length: 4

  Number of days after which the data of customer will be deleted from the database.
• hoBranch: string
  head Office Branch.

{
    "type":"object",
    "properties":{
        "daysToForgetCustomer":{
            "type":"number",
            "description":"Number of days after which the data of customer will be deleted from the database.",
            "maxLength":4
        },
        "hoBranch":{
            "type":"string",
            "description":"head Office Branch."
        },
        "bankName":{
            "type":"string",
            "description":"Name of the Bank.",
            "minLength":0,
            "maxLength":35,
            "pattern":"^[a-zA-Z0-9\\s]+$"
        },
        "bankCode":{
            "type":"string",
            "description":"Bank Code",
            "minLength":3,
            "maxLength":4,
            "pattern":"^[a-zA-Z0-9]+$"
        }
    },
    "required":[
        "hoBranch",
        "bankCode"
    ]
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode

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

Nested Schema : ResponseCode

Type: object

Show Source

• arg(optional): string
• args(optional): array args
• 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"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

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