Update Branch
Updates an existing branch record with the provided details. Only the branchId is mandatory to identify which branch to update. All other fields are optional and will be updated only if provided in the request body. The changer field can be used to record who performed the update for audit purposes.
Authorization
tenantAuth The DCMS tenant name for multi-tenant isolation. Every API call must include this header to identify the client organization.
In: header
Header Parameters
The DCMS client or tenant name for multi-tenant isolation.
Request Body
application/json
Unique identifier of the branch to update. This field is mandatory and used to locate the branch record.
Unique code assigned to the branch for identification purposes across systems.
Human-readable display name of the branch.
Primary street address of the branch location.
Secondary address line such as landmark or building name.
Tertiary address line such as area or locality name.
City where the branch is located.
State or province where the branch is located.
Country where the branch is located.
District within the state where the branch is located.
Postal or ZIP code of the branch location.
Contact phone number of the branch including country code.
Contact email address of the branch for correspondence.
emailIdentifier of the user or system making the change, used for audit trail.
List of point of contact details for the branch. Each entry represents a contact person with their role and escalation level.
Response Body
application/json
application/json
application/json
curl -X PUT "https://api.dcms.example.com/v1/branch" \ -H "tenant: ACME_BANK" \ -H "Content-Type: application/json" \ -d '{ "branchId": "789001", "branchCode": "BR001", "branchName": "Main Branch", "address": "123 Main Street", "address2": "Near City Center", "address3": "MG Road", "city": "Bangalore", "state": "Karnataka", "country": "India", "district": "Bangalore Urban", "zipCode": "560001", "branchPhoneNumber": "+919876543210", "branchEmailId": "mainbranch@example.com", "changer": "ADMIN001", "pocDetails": [ { "pocName": "John Doe", "pocRole": "Branch Manager", "pocEmailId": "john.doe@example.com", "pocLevel": "L1" }, { "pocName": "Jane Smith", "pocRole": "Operations Manager", "pocEmailId": "jane.smith@example.com", "pocLevel": "L2" } ] }'{
"result": true,
"exception": null,
"pagination": null
}{
"result": null,
"exception": {
"errorCode": "BR001",
"shortMessage": "Branch not found",
"detailMessage": "No branch exists with the given branchId",
"httpStatus": "BAD_REQUEST",
"fieldError": [
"Invalid branchId"
],
"languageCode": "en",
"cause": null,
"localizedMessage": null,
"message": null,
"suppressed": []
},
"pagination": null
}{
"result": null,
"exception": {
"errorCode": "SYS001",
"shortMessage": "Internal server error",
"detailMessage": "An unexpected error occurred while updating the branch",
"httpStatus": "INTERNAL_SERVER_ERROR",
"fieldError": [],
"languageCode": "en"
},
"pagination": null
}Get Branch Details POST
Retrieves branch details using various filter criteria. Supports filtering by branchId, branchCode, branchName, creation date range, modification date range, pagination, and sorting. All filter fields are optional. When isAudit is set to true, the response includes audit trail information showing who created or modified the branch and when. The sortFields parameter accepts field names as keys with ASC or DESC direction values.
Apply For A Card POST
Applies for a new physical card when no card is available for the customer, or converts an existing virtual card to a physical card. When a kitNo is provided, the existing virtual card is converted to physical. When only entityId is provided without kitNo, a fresh physical card is issued. The deliveryAddress field specifies which address type (PERMANENT or COMMUNICATION) to use for card delivery.