Create Customer

POST

/api/v0/customer

📌

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

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

curl --location --request POST '/api/v0/customer' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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"
}'

Responses

🟢200OK

application/json

Body

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 2025-07-05 12:21:15

Search UPI QR

Search Customer