EnKash API Document
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Customer Apis
  • EnKash APIs
  • Payment Gateway
    • Payment Gateway Overview
    • Payment Gateway Sign Up
    • Payment Methods
    • Supported Integrations
    • Payment APIs
    • Test Card Details
    • Authorization
      • About Authorization
      • Get Authorization Token
    • Orders
      • Order Overview
      • About Order
      • Create Order
      • Get Order Status
      • Get BNPL Payment Modes
    • Payments
      • Payment Overview
      • About Payment
      • Get Transaction Status
      • Submit Payment Detail
    • Refunds
      • About Refund
      • Refund
    • Payment Links
      • Upi Intent Link Detail
    • Settlements
      • About Settlement
      • Get Settlement Payout By Id
      • Search Settlement Payouts
    • QR Generation API
      • Get Dynamic QR Code
    • Payment Button
    • Qr Code
      • Create QR
      • Create QR Customer
      • Search QR Code
      • Get QR Code
      • Cancel QR Code
  • Payouts
    • Payouts Overview
    • Payouts Sign Up
    • Payout Methods
    • Payouts Integration Steps
    • Ecrypting and Decrypting Payload
    • 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 Source Bank Account Details
      • Add Source Bank Account
      • Get Balance
  • Account Payables
    • Accounts Payable Overview
    • Vendor Management
      • Beneficiary Apis
        • Update Beneficiary
        • Create Beneficiary
        • Update Bulk Beneficiary
        • Create Bulk Beneficiary
        • Get Beneficiaries V1
        • Get Beneficiaries
        • Change beneficiary status
        • Get Beneficiary
    • Invoice Management
      • Payout Apis
        • Search Payouts V1
        • initiate
        • validateInvoices
        • bulkCreatePayout
        • Create Payout
        • Update Payouts
        • Search Payouts
        • createBulkPayoutForPartnerIntegration
        • Update Bulk Payouts
        • Update Approval Status
        • Get Invoice Data
        • Delete Payout
  • Account Receivable
    • Accounts Receivable Overview
    • Get Authentication Token Copy
      • Get Authentication Token
    • Customer Management
      • Customer Apis
        • createCustomer
          POST
        • Activate customer
          PUT
        • createBulkCustomer
          POST
        • bulkUpdate
          POST
        • Deactivate customer
          PUT
        • searchCustomer
          POST
        • 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
  • Loyalty
    • Loyalty Overview
    • Sign Up - Loyalty
    • Use Cases
    • Reward APIs
    • Authorization
      • SSO LOGIN
      • Client Authentication
    • Employee R&R
      • Create And Allocate point
      • Get Transaction details
      • Get User Details
    • Channel Incentives
      • Create And Allocate point
      • Get Transaction details
      • Get User Details
    • brand loyalty
      • Get Coin Event
      • Create Coin Event Configuration
      • Update Coin Event Configuration
      • Allocate Coins to User
    • Voucher Processing
      • Get Cart for User
      • Add to cart
      • Update Cart
      • Order Search
      • Get Order Details
      • Create Order
    • Voucher Catalog
      • Search Catalog
      • Get Product Catalog Details
      • Get Product Configs (Denominations)
  • Expense Management
    • Expense Management Overview
    • Sign Up - Expense Management
  • Corporate Cards
    • Corporate Cards Overview
    • Sign Up - Corporate Cards
    • Corporate Cards Integration Steps
    • Authorization
      • Get Authorization Token
    • Meal Cards
      • Card APIs
        • Create Card
        • View Card
        • Set Pin Card
        • Search Cards
        • Replace Card
        • Physical Card
        • Block Card
        • Update Card balance
      • CardControls
        • Update Card Velocity Rules
        • Get Card Velocity Rules
      • Transactions
        • Get Card Transactions
      • Account
        • Get Card Account
        • Create Card Account
      • Generate Otp Card
    • Fuel Cards
      • Card APIs
        • Create Card
        • Search Cards
        • View Card
        • Block Card
        • Physical Card
        • Set Pin Card
        • Replace Card
        • Update Card balance
      • CardControls
        • Update Card Velocity Rules
        • Get Card Velocity Rules
      • Transactions
        • Get Card Transactions
      • Account
        • Get Card Account
        • Create Card Account
      • Generate Otp Card
  • Verification Suite
    • Verification Suite Overview
    • Bank Account Verification
    • GSTN Verification
    • PAN Verification
    • UPI(VPA) Verification
  • Payout Data Apis
  • Beneficiary Apis
  • tiny-url-controller
  • test-controller
  • company-category-limits-controller
  • bank-holiday-controller
  • Authentication Apis
  • utility-payment-controller-v-1
  • user-controller-v-1
  • Payout Apis
  • gst-payment-controller
  • biller-controller-v-1
  • Virtual Account Apis
  • Vendor Payment Entry Controller
  • Utm Based Config Apis
  • User Apis
  • User Group Apis
  • axis-nodal-controller-v-1
  • icici-nodal-controller
  • axis-nodal-controller
  • subscription-controller
  • Sign Up API's
  • sftp-detail-controller
  • sanction-screening-controller
  • risk-check-controller
  • Reward Page Notification Apis
  • refund-transaction-controller
  • purchase-order-controller
  • Pricing Plan
  • Pre Qualification Apis
  • Pg Balance Apis
  • Payout Transaction Apis
  • payment-request-controller
  • Payment Gateway Apis
  • pay-by-link-controller
  • Partner Integration Apis
  • outstanding-amount-controller
  • otp-controller
  • OnBoarding Config Apis
  • Nudge Apis
  • Multi Factor Auth Apis
  • mail-callback-controller
  • M2P Apis
  • anchor-partner-api-controller
  • amazon-sn-s-notification-controller
  • Karza Controller
  • Instant Payout Apis
  • ICICI Connected Banking Apis
  • gstin-data-controller
  • Generate Pdf APIs
  • fin-bit-controller
  • File Store Apis
  • file-transfer-controller
  • feedback-controller
  • Fd Payment Histories
  • Favorite Api
  • Expense Product Apis
  • equifax-controller
  • Encryption Apis
  • early-payment-offer-controller
  • Document
  • digital-signature-controller
  • digital-locker-controller
  • Credit Provider Risk Check API
  • credit-provider-detail-controller
  • Config Apis
  • company-pg-controller
  • company-branch-code-controller
  • communication-controller
  • Chat Bot Apis
  • card-token-controller
  • Card Product Master Apis
  • card-product-controller
  • Card Application Memo Apis
  • Card Application Apis
  • CardAccountTenant Apis
  • Card Account Addition Mapping Apis
  • Cam Automation Apis
  • bulk-file-detail-controller
  • bulk-file-data-controller
  • Bill Payment Apis
  • Company Biller Apis
  • Beneficiary Detail Apis
  • Bbps Complaint Management Apis
  • Bank IFSC
  • Bank Detail Apis
  • Bank Card Controller
  • AWS Secret Manager Properties Apis
  • Authority Apis
  • Anchor Detail Apis
  • penny-drop-controller
  • Mobile Otp Apis
  • Mobile Authentication Apis
  • oauth-client-detail-controller
  • url-generator-controller
  • Health Check Apis
  • Single Sign On Apis
  • Bulk Upload Sample File Apis
  • credit-policy-controller
  • Payout Logs
  • Help Apis
  • Geo Location Controller
  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 '/api/v0/customer/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountNumber": {},
    "address": {},
    "assignedAgent": {},
    "branchCodes": {},
    "contactNumber": {},
    "customerId": {},
    "customerKeyContacts": {},
    "customerReminders": {},
    "ifsc": {},
    "legalName": {},
    "panOrGstin": {},
    "pinCode": {},
    "state": {},
    "uniqueRefNo": {}
}'

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
Previous
deleteCustomerByCustomerId
Next
getCustomerContactDetails
Built with