Enkash APIs
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Customer Apis
  • EnKash Developer Portal Overview
  • Payment Gateway
    • Payment Gateway Overview
    • Payment Gateway Sign Up
    • Payment Methods
    • Supported Integrations
    • Payment Gateway APIs
    • Web Integration
    • Server to Server Integration
    • Test Card Details
    • Authorization
      • About Authorization
      • Get Authorization Token
    • Orders
      • About Order
      • Create Order
      • Get Order Status
      • Get Order By Merchant Order Id
      • Get BNPL Payment Modes
      • Get Dynamic QR Code
      • UPI Intent Links
    • Payments
      • About Payment
      • Submit Payment Detail
      • Get Transaction Status
      • Validate OTP
      • Resend OTP
      • Payment Notify Request
      • Get UPI Transaction Status
    • Refunds
      • About Refund
      • Refund
    • Settlements
      • About Settlement
      • Settlement Reporting
      • Get Settlement Payout By ID
      • Search Settlement Payouts
    • Split Settlements
      • About Split Settlements
      • Create Split Settlement Account
      • Update Split Settlement Account
      • Get All Split Settlement Account
      • Deactivate Split Settlement Account
      • Activate Split Settlement Account
      • Submit Payment with Split Details
      • Edit/Deferred Split Settlement
    • E-Commerce Plugins
    • Payment Links
    • Payment Button
    • Qr Code
      • Create Qr Code
      • Get QR Code
      • Search QR Code
      • createCustomer
      • searchCustomer
      • Cancel QR Code
    • UPI Mandate
      • Create UPI Mandate
      • Update UPI Mandate
      • Revoke UPI Mandate
      • Get UPI Mandate
      • UPI mandate create callback
      • Mandate Pre-debit Notification
      • Execute mandate debit
      • Mandate Debit callback
  • Payment Links
    • Payment Links Overview
    • Payment Link APIs
    • Payment Link
      • Create Payment Link
      • Get Payment Link Details
      • Delete Payment Link
    • Payment Link Webhook
      • Payment Link Webhook Request
  • Bharat Connect (BBPS)
    • About Bharat Connect
    • B2B Invoicing
      • Invoice
        • Create Invoice
        • Confirm Invoice
        • Status Change Invoice
        • Edit Invoice
      • Payment
        • Pay Invoices
        • Payment Confirmation
      • Financing
        • Request Financing
        • Share Bid
        • Respond Bid
      • Onboarding
        • Register Check Entity
        • Search Entity
        • Register Entity
        • Registration Id
      • cdNote
        • Send CdNote Request
        • Confirm CdNote Request
        • Status Change CdNote Request
      • Purchase Order
        • Send Purchase Order Request
        • Confirm Purchase Order Request
        • Edit Purchase Order Request
        • Status Change Purchase Order Request
      • webhook-invoice
        • Webhook Create Invoice Request
        • Webhook Create Invoice Response
        • Webhook Confirm Invoice Request
        • Webhook Confirm Invoice Response
        • Webhook Status Change Invoice Request
        • Webhook Status Change Invoice Response
        • Webhook Edit Invoice Request
        • Webhook Edit Invoice Response
      • webhook-payments
        • Webhook Payment Request
        • Webhook Payment Confirmation Request
        • Webhook Payment Response
        • Webhook Payment Confirmation Response
      • webhook-business-onboarding
        • Webhook Check Entity Response
        • Webhook Register Entity Response
        • Webhook Search Entity Response
        • Webhook Registration Id Response
      • webhook-financing
        • Webhook Financing Response
        • Webhook Respond Bid Response
        • Webhook Share Bid Request
      • webhook-cdNote
        • Webhook Send CdNote Request
        • Webhook Send CdNote Response
        • Webhook Confirm CdNote Request
        • Webhook Confirm CdNote Response
        • Webhook Status Change CdNote Request
        • Webhook Status Change CdNote Response
      • Webhook Purchase Order
        • Webhook Send Purchase Order Request
        • Webhook Send Purchase Order Response
        • Webhook Confirm Purchase Order Request
        • Webhook Confirm Purchase Order Response
        • Webhook Edit Purchase Order Request
        • Webhook Edit Purchase Order Response
        • Webhook Status Change Purchase Order Request
        • Webhook Status Change Purchase Order Response
    • Bill Payments
      • Bill Payments Overview
      • Get Authentication Token
      • Get BillerTypes
      • Get Billers
      • Fetch Bill
      • Create Bill API
      • Create Bill Without Bill Fetch
      • Bill Payment
      • Utility Bill Approval API
      • Get Utility Bill Status
      • Get Utility Bill by Reference Id
      • Get Utility Bills Detail
      • Bill Payment Webhook
  • Payouts
    • Payouts Overview
    • Payouts Sign Up
    • Payout Methods
    • Payout API Response Codes
    • Payouts Integration Steps
    • Encrypting and Decrypting Payload
    • Payouts Status Codes
    • Get Authentication Token
      • Get Authentication Token
    • Beneficiary Apis
      • Create Beneficiary
      • Search Beneficiary
      • Delete Beneficiary
    • Transfer Apis
      • Create Payout
      • Search Payouts
      • Create Batch Payout
    • Payout Account Apis
      • Get Balance
      • Get Source Bank Account Details
      • Add Source Bank Account
      • Fetch Bank Statement
    • Webhook Data Apis
      • Get Webhook Data
      • Create Webhook Data
  • Accounts Payable Management Tool
    • About AP Management Tool
    • Vendor Management
      • Create Vendor
      • Create Bulk Vendors
      • Update Bulk Vendors
      • Get Beneficiaries (V1)
      • Get Beneficiaries
      • Change Vendor Status
      • Get Beneficiary
    • Invoice Management
      • Payout Apis
        • validateInvoices
        • initiate
        • Search Payouts V1
        • bulkCreatePayout
        • Create Payout
        • Update Payouts
        • Search Payouts
        • createBulkPayoutForPartnerIntegration
        • Update Bulk Payouts
        • Update Approval Status
        • Get Invoice Data
        • Delete Payout
    • Bharat Connect 2.0 AP
      • Confirm Invoice Request
      • Payment Request
    • Update Beneficiary
  • Account Receivable
    • Accounts Receivable Overview
    • Get Authentication Token Copy
      • Get Authentication Token
    • Customer Management
      • Customer Apis
        • Activate customer
          PUT
        • createBulkCustomer
          POST
        • bulkUpdate
          POST
        • Deactivate customer
          PUT
        • deleteCustomerByCustomerId
          DELETE
        • updateCustomer
          PATCH
    • Customer Contacts Management
      • Customer Apis
        • getCustomerContactDetails
    • Invoice Management
      • invoice-controller
        • createInvoice
        • invoiceBulkUpload
        • Dispatch Invoice Collection
        • Delete Invoice Collection
        • searchCollectionInvoices
        • getInvoice
        • updateInvoice
    • Payment Reminders
      • customer-reminder-controller
        • createCustomerReminder
        • getCustomerReminders
        • getCustomerReminder
        • deleteReminder
        • updateCustomerReminder
    • Bharat Connect 2.0 AR
      • Payment Confirmation Request
      • Change Invoice Status Request
      • Bulk Create Invoice
  • Expense Management
    • Expense Management Overview
    • Sign Up - Expense Management
    • Token Api
      • About Authorization
      • Token API
    • Expenses
    • Advance
  • Loyalty
    • Overview
    • Sign Up
    • Employee R&R
      • API Integration Guide
      • Common Fields passed in API requests
      • Token Api
        • Client Authentication
        • SSO LOGIN (Single Sign On)
      • Create And Allocate point
      • Bulk Create And Allocate Points
      • Get Card Account Details
      • Get Transaction details
      • List Users Details
      • Get User Card Details
    • Channel Incentives
      • Incentive Create And Allocate point
      • Reward Get Transaction details
      • Incentive Get User Details
    • Points Redemption
      • User Authentication
      • Get Cart for User
      • Search Catalog
      • Get Product Catalog Details
      • Get Product Configs (Denominations)
      • Add to cart
      • Update Cart
      • Create Order
      • Order Search
      • create order
      • Fetch Order Info by Partner order Reference id
    • Point Management APIs
      • Overview
      • Create Event
      • Get Event
      • Update Event
      • Allocate Coins
      • Get Balance
  • Card Management
    • EnKash Card Management Systems Overview
    • Cards We Issue
    • API Reference
    • VKYC
    • Developer Guide
    • Cards Integration Steps
    • Encryption / Decryption of API requests / Response
    • Encryption & Decryption Guide
    • Token Api
      • Partner auth Token
    • Gift Card
      • Create
      • Request Physical
      • Block
      • Replace
      • Get User Details
      • Get Transaction Details
      • Get All Transaction details
    • Meal Cards
      • Create
      • Load Balance
      • Replace
      • Block
      • Request Physical
      • Get User Card Details
      • Get Transaction Details
      • Get All Transaction details
    • Prepaid Cards
      • Create
      • Load Balance
      • Replace
      • Block
      • Request Physical
      • Get User Card Details
      • Get Transaction Details
      • Get All Transaction details
    • Fuel_cards
      • Create
      • Load Balance
      • Replace
      • Block
      • Physical
      • Get User Card Details
      • Get Transaction Details
      • Get All Transaction details
    • Advance Card Feature
      • Create Card Account
      • Set Pin
      • Get Card Account Details
      • Generate Otp Card
      • View Card
      • Update Card Velocity Rules
      • Get Card Velocity Rules
  • Verification Suite
    • Verification Suite Overview
    • Bank Account Verification
      • Bank Account Verification PennyLess/PennyDrop
    • GSTN Verification
      • Gstin Verification
    • PAN Verification
      • Pan Verification
    • UPI(VPA) Verification
      • Vpa Verification
  1. Customer Apis

updateCustomer

PATCH
/api/v0/customer/{customerId}
Customer Apis

Request

Path Params
customerId
string 
required
customerId
Match pattern:
^KC[A-Z0-9]{14}$
Query Params
parentCompanyId
string 
optional
parentCompanyId
Match pattern:
^CEK[A-Z0-9]{7}$
Body Params application/json
accountNumber
object (JsonNullable«string») 
optional
Unique account number for the customer
address
object (JsonNullable«string») 
optional
Physical address of the customer
assignedAgent
object (JsonNullable«string») 
optional
Name of the agent assigned to the customer
branchCodes
object (JsonNullable«List«string»») 
optional
Codes of branches associated with the customer
contactNumber
object (JsonNullable«string») 
optional
Contact number of the customer
customerId
object (JsonNullable«string») 
optional
Unique identifier for the customer
customerKeyContacts
object (JsonNullable«List«CustomerKeyContactCreateDTO»») 
optional
Key contact persons for the customer
customerReminders
object (JsonNullable«List«CustomerReminderCreateDTO»») 
optional
Reminders for the customer
ifsc
object (JsonNullable«string») 
optional
IFSC code for the customer's bank
legalName
object (JsonNullable«string») 
optional
Legal name of the customer
panOrGstin
object (JsonNullable«string») 
optional
PAN or GSTIN of the customer
pinCode
object (JsonNullable«string») 
optional
PIN code of the customer's address
state
object (JsonNullable«string») 
optional
State of the customer's address
uniqueRefNo
object (JsonNullable«string») 
optional
Unique reference number for the customer
Example
{
  "accountNumber": {},
  "address": {},
  "assignedAgent": {},
  "branchCodes": {},
  "contactNumber": {},
  "customerId": {},
  "customerKeyContacts": {},
  "customerReminders": {},
  "ifsc": {},
  "legalName": {},
  "panOrGstin": {},
  "pinCode": {},
  "state": {},
  "uniqueRefNo": {}
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://test.your-api-server.com/api/v0/customer/' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200OK
application/json
Body
errorResponse
object (ErrorResponse) 
optional
apiSubErrors
array[object (ApiSubError)] 
optional
errorMessage
string 
optional
errorType
enum<string> 
optional
Allowed values:
CLIENT_REQUEST_ABORTCLIENT_REQUEST_ERRORINVALID_ACCESSRECORD_NOT_FOUNDSYSTEM_ERRORUNAUTHORIZEDUNKNOWN_ERRORUNPROCESSABLE_REQUESTVALIDATION_ERROR
requestId
string 
optional
timestamp
string 
optional
Example:
yyyy-MM-dd HH:mm:ss
payload
object (CustomerResponse) 
optional
accountNumber
string 
optional
active
boolean 
optional
address
string 
optional
assignedAgent
string 
optional
bankName
string 
optional
branchCodes
array[string]
optional
companyId
string 
optional
contactEmail
string 
optional
contactNumber
string 
optional
createdBy
string 
optional
createdByName
string 
optional
createdOn
string <date-time>
optional
customerId
string 
optional
customerKeyContacts
array[object (CustomerKeyContactResponse) {14}] 
optional
customerLogo
string 
optional
customerReminders
array[object (CustomerReminderConfigResponse) {7}] 
optional
dsoMedian
integer <int64>
optional
id
integer <int64>
optional
ifsc
string 
optional
legalName
string 
optional
modifiedBy
string 
optional
modifiedByName
string 
optional
modifiedOn
string <date-time>
optional
netAmount
number 
optional
panOrGstin
string 
optional
parentCompanyId
string 
optional
parentLegalName
string 
optional
pinCode
string 
optional
state
string 
optional
uniqueRefNo
string 
optional
warnings
array[string]
optional
response_code
integer <int32>
optional
response_message
string 
optional
Example
{
  "errorResponse": {
    "apiSubErrors": [
      {}
    ],
    "errorMessage": "string",
    "errorType": "CLIENT_REQUEST_ABORT",
    "requestId": "string",
    "timestamp": "yyyy-MM-dd HH:mm:ss"
  },
  "payload": {
    "accountNumber": "string",
    "active": true,
    "address": "string",
    "assignedAgent": "string",
    "bankName": "string",
    "branchCodes": [
      "string"
    ],
    "companyId": "string",
    "contactEmail": "string",
    "contactNumber": "string",
    "createdBy": "string",
    "createdByName": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "customerId": "string",
    "customerKeyContacts": [
      {
        "createdBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "customerId": "string",
        "customerName": "string",
        "deleted": "string",
        "email": "string",
        "keyContactPersonId": "string",
        "mail_enabled": true,
        "mobile": "string",
        "modifiedBy": "string",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "name": "string",
        "sms_enabled": true,
        "whatsapp_enabled": true
      }
    ],
    "customerLogo": "string",
    "customerReminders": [
      {
        "customerId": "string",
        "customerReminderId": "string",
        "dueDateDifference": 0,
        "reminderInterval": 0,
        "reminderTime": "HH:mm",
        "reminderType": "ONCE",
        "stage": "string"
      }
    ],
    "dsoMedian": 0,
    "id": 0,
    "ifsc": "string",
    "legalName": "string",
    "modifiedBy": "string",
    "modifiedByName": "string",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "netAmount": 0,
    "panOrGstin": "string",
    "parentCompanyId": "string",
    "parentLegalName": "string",
    "pinCode": "string",
    "state": "string",
    "uniqueRefNo": "string",
    "warnings": [
      "string"
    ]
  },
  "response_code": 0,
  "response_message": "string"
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
🟠422Unprocessable Request
🔴500Server Error
Modified at 2024-10-10 08:34:46
Previous
deleteCustomerByCustomerId
Next
getCustomerContactDetails
Built with