Create Customer - Enkash Developer Portal

📌

Use this API to create a customer profile in your EnKash system. This allows you to securely store customer details for repeat transactions, faster checkouts, and easier payment tracking.

Request

Body Params application/json

accountNumber

string

optional

Unique account number for the customer

Match pattern:

^$|^[A-Za-z0-9]{9,36}$

address

string

optional

Physical address of the customer

companyId

string

optional

Unique identifier for the company

Match pattern:

^CEK[A-Z0-9]{7}$

contactNumber

string

optional

Contact number of the customer

Match pattern:

^$|^((\+|00)(\d{1,3})[\s-]?)?(\d{10})$

customerCompanyId

string

optional

Unique identifier for the customer's company

customerKeyContacts

array[object (CustomerKeyContactCreateDTO) {10}]

required

Key contact persons for the customer

deleted

boolean

required

string

optional

Match pattern:

(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)])

keyContactPersonId

string

optional

legalName

string

required

mail_enabled

boolean

optional

mobile

string

required

Match pattern:

^$|^((\+|00)(\d{1,3})[\s-]?)?(\d{10})$

name

string

required

sms_enabled

boolean

optional

via

string

optional

whatsapp_enabled

boolean

optional

customerReminders

array[object (CustomerReminderCreateDTO) {6}]

optional

Reminders for the customer

customerReminderId

string

optional

dueDateDifference

integer <int32>

optional

reminderInterval

integer <int32>

optional

reminderTime

object

optional

LocalTime

Example:

HH:mm

reminderType

enum<string>

optional

Allowed values:

ONCERECURRING

stage

string

optional

externalSource

boolean

optional

Indicates if the customer is from an external source

ifsc

string

optional

IFSC code for the customer's bank

Match pattern:

^$|^[A-Za-z]{4}0[A-Z0-9a-z]{6}$

legalName

string

required

Legal name of the customer

panOrGstin

string

optional

PAN or GSTIN of the customer

Match pattern:

^$|^(([0][1-9]|[1-2][0-9]|[3][0-7])[A-Za-z]{3}[ABCFGHLJPTKabcfghljptk][A-Za-z]\d{4}[A-Za-z][A-Za-z0-9][Zz][A-Za-z0-9])?|([A-Za-z]{3}[ABCFGHLJPTKEabcfghljptke][A-Za-z]\d{4}[A-Za-z])$

pinCode

string

optional

PIN code of the customer's address

Match pattern:

^$|^[0-9]{6}$

source

enum<string>

optional

Source of the customer information

Allowed values:

ENKASHTALLY

state

string

optional

State of the customer's address

uniqueRefNo

string

optional

Unique reference number for the customer

Example

{
    "accountNumber": "string",
    "address": "string",
    "companyId": "string",
    "contactNumber": "string",
    "customerCompanyId": "string",
    "customerKeyContacts": [
        {
            "deleted": true,
            "email": "string",
            "keyContactPersonId": "string",
            "legalName": "string",
            "mail_enabled": true,
            "mobile": "string",
            "name": "string",
            "sms_enabled": true,
            "via": "string",
            "whatsapp_enabled": true
        }
    ],
    "customerReminders": [
        {
            "customerReminderId": "string",
            "dueDateDifference": 0,
            "reminderInterval": 0,
            "reminderTime": "HH:mm",
            "reminderType": "ONCE",
            "stage": "string"
        }
    ],
    "externalSource": true,
    "ifsc": "string",
    "legalName": "string",
    "panOrGstin": "string",
    "pinCode": "string",
    "source": "ENKASH",
    "state": "string",
    "uniqueRefNo": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

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