Jump to

• Request
• Response

Close the core customers by given ID

patch

/service/corecustomers/{customerNo}/close

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

Request

Supported Media Types

• application/json

Path Parameters

• customerNo: string
  Key of the corecustomers maintenance

Header Parameters

• sourceCode: string
  includecloseandunauth need to be set to fetch summary record, defult value is false

Body ()

Request body contain corecustomers and Modification no of corecustomers 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 : CoreCustomerServiceResponseDtoWrapper

Type: object

Show Source

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

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

Nested Schema : CoreCustomerDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object CoreCustomerDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "country":{
                    "type":"string",
                    "description":"Country code of the customer?s address",
                    "pattern":"([a-zA-Z0-9]+)?"
                },
                "language":{
                    "type":"string",
                    "description":"Customer's preferred language of communication"
                },
                "nationality":{
                    "type":"string",
                    "description":"Nationality of the customer"
                },
                "deceased":{
                    "type":"string",
                    "description":"Identifies that customer is deceased"
                },
                "frozen":{
                    "type":"string",
                    "description":"Identifies that the customer's account is frozen",
                    "pattern":"[Y,N]"
                },
                "whereaboutsUnknown":{
                    "type":"string",
                    "description":"Identifies that the customer's whareabouts not known",
                    "pattern":"[Y,N]"
                },
                "rmId":{
                    "type":"string",
                    "description":"Relational Manager's Id",
                    "minLength":0,
                    "maxLength":12,
                    "pattern":"([a-zA-Z0-9]+)?"
                },
                "sanctionsChecksRequired":{
                    "type":"string",
                    "description":"Indicates that the sanction check should be done or not",
                    "pattern":"[Y,N]"
                },
                "walkinCustomer":{
                    "type":"string",
                    "description":"Walkin Customer"
                },
                "sourceSystem":{
                    "type":"string",
                    "description":"Name of the source system"
                },
                "sourceSystemCustNo":{
                    "type":"string",
                    "description":"Customer identification details as per the source system.",
                    "minLength":1,
                    "maxLength":35,
                    "pattern":"[a-zA-Z0-9]+"
                },
                "customerNo":{
                    "type":"string",
                    "description":"Customer Number of the external customer",
                    "minLength":1,
                    "maxLength":20,
                    "pattern":"[a-zA-Z0-9]+"
                },
                "hostCode":{
                    "type":"string",
                    "description":"Displays the host code that is linked to the transaction branch of the customer"
                },
                "customerType":{
                    "type":"string",
                    "description":"Customer type can be Individual,Corporate or Bank",
                    "pattern":"[I,C,B]"
                },
                "customerCategory":{
                    "type":"string",
                    "description":"Category to which the customer belongs to"
                },
                "customerName1":{
                    "type":"string",
                    "description":"Name of the external customer",
                    "minLength":0,
                    "maxLength":35,
                    "pattern":"([a-zA-Z0-9\\s]+)?"
                },
                "shortName":{
                    "type":"string",
                    "description":"Short name of the custome",
                    "minLength":0,
                    "maxLength":20,
                    "pattern":"([a-zA-Z0-9\\s]+)?"
                },
                "addressLine1":{
                    "type":"string",
                    "description":"First line of the customer?s address",
                    "minLength":0,
                    "maxLength":35
                },
                "addressLine2":{
                    "type":"string",
                    "description":"Second line of the customer?s address",
                    "minLength":0,
                    "maxLength":35
                },
                "addressLine3":{
                    "type":"string",
                    "description":"Third line of the customer?s address",
                    "minLength":0,
                    "maxLength":35
                },
                "addressLine4":{
                    "type":"string",
                    "description":"Fourth line of the customer?s address",
                    "minLength":0,
                    "maxLength":35
                },
                "pincode":{
                    "type":"string",
                    "description":"Pincode of the customer?s address",
                    "minLength":0,
                    "maxLength":15,
                    "pattern":"([a-zA-Z0-9]+)?"
                }
            },
            "required":[
                "sourceSystem",
                "sourceSystemCustNo",
                "customerNo",
                "customerType",
                "customerName1"
            ]
        }
    ]
}

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 : CoreCustomerDTO-allOf[1]

Type: object

Show Source

• addressLine1(optional): string
  Minimum Length: 0

  Maximum Length: 35

  First line of the customer?s address
• addressLine2(optional): string
  Minimum Length: 0

  Maximum Length: 35

  Second line of the customer?s address
• addressLine3(optional): string
  Minimum Length: 0

  Maximum Length: 35

  Third line of the customer?s address
• addressLine4(optional): string
  Minimum Length: 0

  Maximum Length: 35

  Fourth line of the customer?s address
• country(optional): string
  Pattern: ([a-zA-Z0-9]+)?

  Country code of the customer?s address
• customerCategory(optional): string
  Category to which the customer belongs to
• customerName1: string
  Minimum Length: 0

  Maximum Length: 35

  Pattern: ([a-zA-Z0-9\s]+)?

  Name of the external customer
• customerNo: string
  Minimum Length: 1

  Maximum Length: 20

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

  Customer Number of the external customer
• customerType: string
  Pattern: [I,C,B]

  Customer type can be Individual,Corporate or Bank
• deceased(optional): string
  Identifies that customer is deceased
• frozen(optional): string
  Pattern: [Y,N]

  Identifies that the customer's account is frozen
• hostCode(optional): string
  Displays the host code that is linked to the transaction branch of the customer
• language(optional): string
  Customer's preferred language of communication
• nationality(optional): string
  Nationality of the customer
• pincode(optional): string
  Minimum Length: 0

  Maximum Length: 15

  Pattern: ([a-zA-Z0-9]+)?

  Pincode of the customer?s address
• rmId(optional): string
  Minimum Length: 0

  Maximum Length: 12

  Pattern: ([a-zA-Z0-9]+)?

  Relational Manager's Id
• sanctionsChecksRequired(optional): string
  Pattern: [Y,N]

  Indicates that the sanction check should be done or not
• shortName(optional): string
  Minimum Length: 0

  Maximum Length: 20

  Pattern: ([a-zA-Z0-9\s]+)?

  Short name of the custome
• sourceSystem: string
  Name of the source system
• sourceSystemCustNo: string
  Minimum Length: 1

  Maximum Length: 35

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

  Customer identification details as per the source system.
• walkinCustomer(optional): string
  Walkin Customer
• whereaboutsUnknown(optional): string
  Pattern: [Y,N]

  Identifies that the customer's whareabouts not known

{
    "type":"object",
    "properties":{
        "country":{
            "type":"string",
            "description":"Country code of the customer?s address",
            "pattern":"([a-zA-Z0-9]+)?"
        },
        "language":{
            "type":"string",
            "description":"Customer's preferred language of communication"
        },
        "nationality":{
            "type":"string",
            "description":"Nationality of the customer"
        },
        "deceased":{
            "type":"string",
            "description":"Identifies that customer is deceased"
        },
        "frozen":{
            "type":"string",
            "description":"Identifies that the customer's account is frozen",
            "pattern":"[Y,N]"
        },
        "whereaboutsUnknown":{
            "type":"string",
            "description":"Identifies that the customer's whareabouts not known",
            "pattern":"[Y,N]"
        },
        "rmId":{
            "type":"string",
            "description":"Relational Manager's Id",
            "minLength":0,
            "maxLength":12,
            "pattern":"([a-zA-Z0-9]+)?"
        },
        "sanctionsChecksRequired":{
            "type":"string",
            "description":"Indicates that the sanction check should be done or not",
            "pattern":"[Y,N]"
        },
        "walkinCustomer":{
            "type":"string",
            "description":"Walkin Customer"
        },
        "sourceSystem":{
            "type":"string",
            "description":"Name of the source system"
        },
        "sourceSystemCustNo":{
            "type":"string",
            "description":"Customer identification details as per the source system.",
            "minLength":1,
            "maxLength":35,
            "pattern":"[a-zA-Z0-9]+"
        },
        "customerNo":{
            "type":"string",
            "description":"Customer Number of the external customer",
            "minLength":1,
            "maxLength":20,
            "pattern":"[a-zA-Z0-9]+"
        },
        "hostCode":{
            "type":"string",
            "description":"Displays the host code that is linked to the transaction branch of the customer"
        },
        "customerType":{
            "type":"string",
            "description":"Customer type can be Individual,Corporate or Bank",
            "pattern":"[I,C,B]"
        },
        "customerCategory":{
            "type":"string",
            "description":"Category to which the customer belongs to"
        },
        "customerName1":{
            "type":"string",
            "description":"Name of the external customer",
            "minLength":0,
            "maxLength":35,
            "pattern":"([a-zA-Z0-9\\s]+)?"
        },
        "shortName":{
            "type":"string",
            "description":"Short name of the custome",
            "minLength":0,
            "maxLength":20,
            "pattern":"([a-zA-Z0-9\\s]+)?"
        },
        "addressLine1":{
            "type":"string",
            "description":"First line of the customer?s address",
            "minLength":0,
            "maxLength":35
        },
        "addressLine2":{
            "type":"string",
            "description":"Second line of the customer?s address",
            "minLength":0,
            "maxLength":35
        },
        "addressLine3":{
            "type":"string",
            "description":"Third line of the customer?s address",
            "minLength":0,
            "maxLength":35
        },
        "addressLine4":{
            "type":"string",
            "description":"Fourth line of the customer?s address",
            "minLength":0,
            "maxLength":35
        },
        "pincode":{
            "type":"string",
            "description":"Pincode of the customer?s address",
            "minLength":0,
            "maxLength":15,
            "pattern":"([a-zA-Z0-9]+)?"
        }
    },
    "required":[
        "sourceSystem",
        "sourceSystemCustNo",
        "customerNo",
        "customerType",
        "customerName1"
    ]
}

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