Enkash APIs
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Qr Code
  • Explore Our Product Suite
  • Payment Gateway
    • Payment Gateway Overview
    • Getting Started
    • Payment Methods
    • Integration
    • API Endpoints
    • APIs
      • Authorisation
        • Get Authorization Token
      • Order
        • Create Order
        • Get Order Status
        • Get Order By Merchant Order Id
        • Get BNPL Payment Modes
        • Get Dynamic QR Code
        • UPI Intent Links
      • Payment
        • Submit Payment Detail
        • Get Transaction Status
        • Validate OTP
        • Resend OTP
        • Payment Notify Request
        • Get UPI Transaction Status
        • Verify VPA
      • Refund
        • Refund
      • Settlement
        • Settlement Reporting
        • Get Settlement Payout By ID
        • Search Settlement Payouts
      • Split Settlement
        • 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 Button
      • Qr Code
        • Create Qr Code
          POST
        • Get QR Code
          GET
        • Search QR Code
          POST
        • createCustomer
          POST
        • searchCustomer
          POST
        • Cancel QR Code
          PATCH
      • 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
  • 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
  • Prepaid Cards
    • About Prepaid Card
    • Key Capabilities
    • Getting Started
    • APIs
      • API Access & Authorization
      • Encryption & Decryption Guide
      • Auth Token
      • Create Card Account
      • Create Gift Card
      • Create Prepaid Card
      • Set Card PIN
      • Load Card Balance
      • Get Card Account Details
      • Generate Card OTP
      • View Card Details
      • Card Usage Controls
      • Get Card Usage Limits
      • Request Card Replacement
      • Block Card
      • Order Physical Card
      • Get Card Details
      • Get Transaction Details
      • Get All Transaction details
  • Bharat Connect (BBPS)
    • About Bharat Connect
    • Invoice Payments
      • 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
      • Utility API Response Handling
      • 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
  • Accounts Payable
    • 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
        • createBulkCustomer
        • bulkUpdate
        • Deactivate customer
        • deleteCustomerByCustomerId
        • updateCustomer
    • 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
    • About Authorization
    • Expenses
    • Advance
    • Token API
  • Rewards & Incentives
    • About Rewards
    • Getting Started
    • Encryption & Decryption Guide
    • Reward Allocation
    • Incentive Allocation
    • APIs
      • Token APIs
        • Authentication
        • Single Sign On (SSO)
      • Reward Allocation
        • Create And Allocate Points
        • Bulk Create And Allocate Rewards
        • Get Reward Account Details
        • Get Reward Transaction Details
        • Get User Details
        • Get User Card Details
      • Incentive Allocation
        • Incentive Create And Allocation
        • Get Incentive Transaction details
        • Get User Details
      • 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
        • Overview
        • Create Event
        • Get Event
        • Update Event
        • Allocate Coins
        • Get Balance
  • 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. Qr Code

createCustomer

POST
/api/v0/customer
Customer Apis

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
email
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
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
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
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
Search QR Code
Next
searchCustomer
Built with