Enkash Developer Portal
Home
Home
Login
  1. UPI QR
  • Back to home
  • Payment Gateway APIs
  • Authorisation
    • Get Authorization Token
  • Order
    • Create Order
    • Get Order Status
    • Get Order By Merchant Order Id
    • Get BNPL Payment Methods
    • Get Dynamic UPI QR
    • UPI Intent Links
  • Payment
    • Submit Payment Request
    • Get Transaction Status
    • Validate OTP
    • Resend OTP
    • Payment Notify Request
    • Get UPI Transaction Status
    • Verify UPI VPA
  • Refund
    • Refund
  • Settlement
    • 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 Or Deferred Split Settlement
  • E-Commerce Plugins
  • UPI QR
    • Create UPI QR
      POST
    • Get UPI QR
      GET
    • Search UPI QR
      POST
    • Create Customer
      POST
    • Search Customer
      POST
    • Cancel UPI QR
      PATCH
  • UPI Autopay
    • Create UPI Mandate
    • Update UPI Mandate
    • Revoke UPI Mandate
    • Get UPI Mandate
    • UPI Mandate Callback
    • Mandate Pre-debit Notification
    • Execute Mandate Debit
    • Mandate Debit Callback
  • Payment Links
    • Payment Link APIs
    • Create Payment Link
    • Get Payment Link Details
    • Delete Payment Link
    • Webhook Request
  1. UPI QR

Search Customer

POST
/api/v0/customer/search
šŸ“Œ
Use this API to retrieve a list of customers based on filters such as name, email, phone number, or creation date. This helps you quickly find and manage customer profiles in your EnKash system.

Request

Query Params

Body Params application/json

Example
{
    "accountNumber": "string",
    "assignedAgent": "string",
    "balanceAmount": 0,
    "companyId": "string",
    "contactNumber": "string",
    "createdByName": "string",
    "createdOnFrom": "2019-08-24T14:15:22Z",
    "createdOnTo": "2019-08-24T14:15:22Z",
    "customerIds": [
        "string"
    ],
    "customerStatus": "ACTIVE",
    "dsoFrom": 0,
    "dsoTo": 0,
    "ifsc": "string",
    "legalName": "string",
    "level": "LEVEL_1",
    "modifiedByName": "string",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "panOrGstin": "string",
    "parentCompanyId": "string",
    "selectAll": true,
    "uniqueRefNo": "string"
}

Request Code 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/search?direction&limit&offset&orderBy' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountNumber": "string",
    "assignedAgent": "string",
    "balanceAmount": 0,
    "companyId": "string",
    "contactNumber": "string",
    "createdByName": "string",
    "createdOnFrom": "2019-08-24T14:15:22Z",
    "createdOnTo": "2019-08-24T14:15:22Z",
    "customerIds": [
        "string"
    ],
    "customerStatus": "ACTIVE",
    "dsoFrom": 0,
    "dsoTo": 0,
    "ifsc": "string",
    "legalName": "string",
    "level": "LEVEL_1",
    "modifiedByName": "string",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "panOrGstin": "string",
    "parentCompanyId": "string",
    "selectAll": true,
    "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": {
        "data": [
            {
                "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"
                ]
            }
        ],
        "recordsCount": 0
    },
    "response_code": 0,
    "response_message": "string"
}
šŸŸ 400Bad Request
šŸŸ 401Unauthorized
šŸŸ 403Forbidden
šŸŸ 404Not Found
šŸŸ 422Unprocessable Request
šŸ”“500Server Error
Modified atĀ 2025-07-05 12:21:56
Previous
Create Customer
Next
Cancel UPI QR
Built with