Enkash APIs
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Loyalty
  2. Employee R&R
  • EnKash Developer Portal Overview
  • Payment Gateway
    • Payment Gateway Overview
    • Payment Gateway Sign Up
    • Payment Methods
    • Supported Integrations
    • Payment Gateway APIs
    • Web Integration
    • Server to Server Integration
    • Test Card Details
    • Authorization
      • About Authorization
      • Get Authorization Token
        POST
    • Orders
      • About Order
      • Create Order
        POST
      • Get Order Status
        GET
      • Get BNPL Payment Modes
        GET
      • Get Dynamic QR Code
        GET
      • UPI Intent Links
        GET
    • Payments
      • About Payment
      • Submit Payment Detail
        POST
      • Get Transaction Status
        GET
      • Validate OTP
        POST
      • Resend OTP
        GET
      • Payment Notify Request
        POST
    • Refunds
      • About Refund
      • Refund
        POST
    • Settlements
      • About Settlement
      • Settlement Reporting
      • Get Settlement Payout By ID
        GET
      • Search Settlement Payouts
        POST
    • Split Settlements
      • About Split Settlements
      • Create Split Settlement Account
        POST
      • Update Split Settlement Account
        POST
      • Get All Split Settlement Account
        GET
      • Deactivate Split Settlement Account
        PATCH
      • Activate Split Settlement Account
        PATCH
      • Submit Payment with Split Details
        POST
      • Edit/Deferred Split Settlement
        POST
    • E-Commerce Plugins
    • Payment Links
    • 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
        POST
      • Update UPI Mandate
        PATCH
      • Revoke UPI Mandate
        PATCH
      • Get UPI Mandate
        GET
      • UPI mandate create callback
        POST
      • Mandate Pre-debit Notification
        POST
      • Execute mandate debit
        POST
      • Mandate Debit callback
        POST
  • Payment Links
    • Payment Links Overview
    • Payment Link APIs
    • Payment Link
      • Create Payment Link
        POST
      • Get Payment Link Details
        GET
      • Delete Payment Link
        DELETE
    • Payment Link Webhook
      • Payment Link Webhook Request
        POST
  • Bharat Connect (BBPS)
    • About Bharat Connect
    • B2B Invoicing
      • Invoice
        • Create Invoice
          POST
        • Confirm Invoice
          POST
        • Status Change Invoice
          POST
        • Edit Invoice
          POST
      • Payment
        • Pay Invoices
          POST
        • Payment Confirmation
          POST
      • Financing
        • Request Financing
          POST
        • Share Bid
          POST
        • Respond Bid
          POST
      • Onboarding
        • Register Check Entity
          POST
        • Search Entity
          POST
        • Register Entity
          POST
        • Registration Id
          POST
      • cdNote
        • Send CdNote Request
          POST
        • Confirm CdNote Request
          POST
        • Status Change CdNote Request
          POST
      • Purchase Order
        • Send Purchase Order Request
          POST
        • Confirm Purchase Order Request
          POST
        • Edit Purchase Order Request
          POST
        • Status Change Purchase Order Request
          POST
      • webhook-invoice
        • Webhook Create Invoice Request
          POST
        • Webhook Create Invoice Response
          POST
        • Webhook Confirm Invoice Request
          POST
        • Webhook Confirm Invoice Response
          POST
        • Webhook Status Change Invoice Request
          POST
        • Webhook Status Change Invoice Response
          POST
        • Webhook Edit Invoice Request
          POST
        • Webhook Edit Invoice Response
          POST
      • webhook-payments
        • Webhook Payment Request
          POST
        • Webhook Payment Confirmation Request
          POST
        • Webhook Payment Response
          POST
        • Webhook Payment Confirmation Response
          POST
      • webhook-business-onboarding
        • Webhook Check Entity Response
          POST
        • Webhook Register Entity Response
          POST
        • Webhook Search Entity Response
          POST
        • Webhook Registration Id Response
          POST
      • webhook-financing
        • Webhook Financing Response
          POST
        • Webhook Respond Bid Response
          POST
        • Webhook Share Bid Request
          POST
      • webhook-cdNote
        • Webhook Send CdNote Request
          POST
        • Webhook Send CdNote Response
          POST
        • Webhook Confirm CdNote Request
          POST
        • Webhook Confirm CdNote Response
          POST
        • Webhook Status Change CdNote Request
          POST
        • Webhook Status Change CdNote Response
          POST
      • Webhook Purchase Order
        • Webhook Send Purchase Order Request
          POST
        • Webhook Send Purchase Order Response
          POST
        • Webhook Confirm Purchase Order Request
          POST
        • Webhook Confirm Purchase Order Response
          POST
        • Webhook Edit Purchase Order Request
          POST
        • Webhook Edit Purchase Order Response
          POST
        • Webhook Status Change Purchase Order Request
          POST
        • Webhook Status Change Purchase Order Response
          POST
    • Bill Payments
      • Bill Payments Overview
      • Get Authentication Token
        POST
      • Get BillerTypes
        GET
      • Get Billers
        GET
      • Fetch Bill
        POST
      • Create Bill API
        POST
      • Create Bill Without Bill Fetch
        POST
      • Bill Payment
        POST
      • Utility Bill Approval API
        PUT
      • Get Utility Bill Status
        GET
      • Get Utility Bill by Reference Id
        GET
      • Get Utility Bills Detail
        POST
      • Bill Payment Webhook
        POST
  • 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
        POST
    • Beneficiary Apis
      • Create Beneficiary
        POST
      • Search Beneficiary
        POST
      • Delete Beneficiary
        DELETE
    • Transfer Apis
      • Create Payout
        POST
      • Search Payouts
        POST
      • Create Batch Payout
        POST
    • Payout Account Apis
      • Get Balance
        GET
      • Get Source Bank Account Details
        GET
      • Add Source Bank Account
        POST
    • Webhook Data Apis
      • Get Webhook Data
        GET
      • Create Webhook Data
        POST
  • Accounts Payable Management Tool
    • About AP Management Tool
    • Vendor Management
      • Create Vendor
        POST
      • Create Bulk Vendors
        POST
      • Update Bulk Vendors
        PUT
      • Get Beneficiaries (V1)
        POST
      • Get Beneficiaries
        POST
      • Change Vendor Status
        PATCH
      • Get Beneficiary
        GET
    • Invoice Management
      • Payout Apis
        • validateInvoices
          POST
        • initiate
          POST
        • Search Payouts V1
          POST
        • bulkCreatePayout
          POST
        • Create Payout
          POST
        • Update Payouts
          PATCH
        • Search Payouts
          POST
        • createBulkPayoutForPartnerIntegration
          POST
        • Update Bulk Payouts
          PATCH
        • Update Approval Status
          PATCH
        • Get Invoice Data
          GET
        • Delete Payout
          DELETE
    • Bharat Connect 2.0 AP
      • Confirm Invoice Request
        POST
      • Payment Request
        POST
    • Update Beneficiary
      PUT
  • Account Receivable
    • Accounts Receivable Overview
    • Get Authentication Token Copy
      • Get Authentication Token
        POST
    • Customer Management
      • Customer Apis
        • Activate customer
          PUT
        • createBulkCustomer
          POST
        • bulkUpdate
          POST
        • Deactivate customer
          PUT
        • deleteCustomerByCustomerId
          DELETE
        • updateCustomer
          PATCH
    • Customer Contacts Management
      • Customer Apis
        • getCustomerContactDetails
          GET
    • Invoice Management
      • invoice-controller
        • createInvoice
          POST
        • invoiceBulkUpload
          POST
        • Dispatch Invoice Collection
          POST
        • Delete Invoice Collection
          POST
        • searchCollectionInvoices
          POST
        • getInvoice
          GET
        • updateInvoice
          PATCH
    • Payment Reminders
      • customer-reminder-controller
        • createCustomerReminder
          POST
        • getCustomerReminders
          POST
        • getCustomerReminder
          GET
        • deleteReminder
          DELETE
        • updateCustomerReminder
          PATCH
    • Bharat Connect 2.0 AR
      • Payment Confirmation Request
        POST
      • Change Invoice Status Request
        POST
      • Bulk Create Invoice
        POST
  • Expense Management
    • Expense Management Overview
    • Sign Up - Expense Management
    • Token Api
      • About Authorization
      • Token API
        POST
    • Expenses
      POST
    • Advance
      POST
  • Loyalty
    • Overview
    • Sign Up
    • Employee R&R
      • API Integration Guide
      • Common Fields passed in API requests
      • Token Api
        • Client Authentication
          POST
        • SSO LOGIN (Single Sign On)
          POST
      • Create And Allocate point
        POST
      • Bulk Create And Allocate Points
        POST
      • Get Card Account Details
        POST
      • Get Transaction details
        POST
      • List Users Details
        POST
      • Get User Card Details
        POST
    • Channel Incentives
      • Incentive Create And Allocate point
        POST
      • Reward Get Transaction details
        POST
      • Incentive Get User Details
        POST
    • Points Redemption
      • User Authentication
        POST
      • Get Cart for User
        GET
      • Search Catalog
        POST
      • Get Product Catalog Details
        GET
      • Get Product Configs (Denominations)
        GET
      • Add to cart
        POST
      • Update Cart
        PATCH
      • Create Order
        POST
      • Order Search
        POST
      • create order
        POST
      • Fetch Order Info by Partner order Reference id
        POST
    • Point Management APIs
      • Overview
      • Create Event
        POST
      • Get Event
        GET
      • Update Event
        PATCH
      • Allocate Coins
        POST
      • Get Balance
        GET
  • Card Management
    • EnKash Card Management Systems Overview
    • Cards We Issue
    • API Reference
    • VKYC
    • Developer Guide
    • Cards Integration Steps
    • Encryption / Decryption of API requests / Response
    • Encryption & Decryption Guide
    • Token Api
      • Partner auth Token
        POST
    • Gift Card
      • Create
        POST
      • Request Physical
        POST
      • Block
        POST
      • Replace
        POST
      • Get User Details
        POST
      • Get Transaction Details
        POST
      • Get All Transaction details
        POST
    • Meal Cards
      • Create
        POST
      • Load Balance
        POST
      • Replace
        POST
      • Block
        POST
      • Request Physical
        POST
      • Get User Card Details
        POST
      • Get Transaction Details
        POST
      • Get All Transaction details
        POST
    • Prepaid Cards
      • Create
        POST
      • Load Balance
        POST
      • Replace
        POST
      • Block
        POST
      • Request Physical
        POST
      • Get User Card Details
        POST
      • Get Transaction Details
        POST
      • Get All Transaction details
        POST
    • Fuel_cards
      • Create
        POST
      • Load Balance
        POST
      • Replace
        POST
      • Block
        POST
      • Physical
        POST
      • Get User Card Details
        POST
      • Get Transaction Details
        POST
      • Get All Transaction details
        POST
    • Advance Card Feature
      • Create Card Account
        POST
      • Set Pin
        POST
      • Get Card Account Details
        POST
      • Generate Otp Card
        POST
      • View Card
        POST
      • Update Card Velocity Rules
        POST
      • Get Card Velocity Rules
        POST
  • Verification Suite
    • Verification Suite Overview
    • Bank Account Verification
      • Bank Account Verification PennyLess/PennyDrop
        POST
    • GSTN Verification
      • Gstin Verification
        GET
    • PAN Verification
      • Pan Verification
        GET
    • UPI(VPA) Verification
      • Vpa Verification
        POST
  1. Loyalty
  2. Employee R&R

List Users Details

Developing
POST
/api/v0/partner/enKashCard/search

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379
Header Params
partnerId
string 
required
Example:
CRMXWB3ZM
Authorization
string 
required
Example:
Bearer gw_M-onAKOmhgP7E0sbsIFAovtA
Content-Type
string 
required
Example:
application/json
Cookie
string 
optional
Example:
JSESSIONID=526FAFE391FEC276549D84FEF5FC5BE7; _cfuvid=5Jz3eAXXWDfSx1meQ_VMUHcNL7S9Dh4PyjrAp3WYc4w-1723795476201-0.0.1.1-604800000
Body Params application/json
cardAccountId
string 
required
companyId
string 
required
Example
{
  "cardAccountId": "CAQL8YCV3",
  "companyId": "CEK1PU9AOO"
}

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 'https://test.your-api-server.com/api/v0/partner/enKashCard/search' \
--header 'partnerId: CRMXWB3ZM' \
--header 'Authorization: Bearer gw_M-onAKOmhgP7E0sbsIFAovtA' \
--header 'Cookie: JSESSIONID=526FAFE391FEC276549D84FEF5FC5BE7; _cfuvid=5Jz3eAXXWDfSx1meQ_VMUHcNL7S9Dh4PyjrAp3WYc4w-1723795476201-0.0.1.1-604800000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cardAccountId": "CAQL8YCV3",
    "companyId" : "CEK1PU9AOO"
}'

Responses

🟢200Success
application/json
Body
string 
optional
Example
{
  "response_code": 0,
  "response_message": "Success",
  "payload": {
    "enKashCardId": "EKCE54IDPE",
    "userId": "EKHCPB7W",
    "cardAccountId": "CAVBMRFE8",
    "token": "1cfc6f4d558064eb6a20",
    "maskedNumber": "XXXX XXXX XXXX 2209",
    "expiryMonth": "08",
    "expiryYear": "2026",
    "email": "testapi@gmail.com",
    "mobile": "6230912209",
    "title": "Mr",
    "firstName": "Api",
    "lastName": "Test",
    "gender": "M",
    "usedMtd": 0,
    "usedDtd": 0,
    "usedYtd": 0,
    "otbBalance": 0,
    "primaryCard": false,
    "prepaidCard": true,
    "physicalCard": false,
    "deleted": false,
    "closedLoopCard": false,
    "createdOn": "2024-08-05 16:51:36",
    "modifiedOn": "2024-08-05 16:51:36",
    "cardStatus": {
      "name": "UL",
      "label": "UnLocked"
    },
    "kycStatus": {
      "name": "VERIFIED",
      "label": "Verified"
    },
    "cardProgramme": "SBM",
    "useAccountFunds": false,
    "blockCode": "A",
    "partnerLogo": "https://image.enkash.in/IMAGES/sbm-logo.png",
    "physicalDeliveryAddressFlag": false,
    "cardActivated": true,
    "binType": {
      "name": "REWARD",
      "label": "Reward Card"
    },
    "loadAmount": 0,
    "companyId": "CEK7T1WMC6",
    "cardKitMasterId": 11,
    "extEntityId": "EXT3B40FKFZGJ",
    "switchProvider": "EK_CLOSEDLOOP_CREDIT",
    "accountBalance": 898138,
    "physicalCardAllowed": false,
    "kitType": {
      "name": "VISA",
      "label": "Visa"
    },
    "surchargeAmt": 0,
    "panValidated": false,
    "usedLtd": 0,
    "latestTnCVersionAccepted": true,
    "latestKeyFactAccepted": true,
    "latestTnCVersionAcceptedForPrimaryCard": true,
    "latestKeyFactAcceptedCardForPrimaryCard": true,
    "virtualAccountNumber": "ENKASHEDENKEKCE54IDPE",
    "limitAllocatedLtd": 0,
    "posAllowed": false,
    "posAllowedAdmin": false,
    "atmAllowed": false,
    "atmAllowedAdmin": false,
    "onlineAllowed": false,
    "onlineAllowedAdmin": false,
    "liveImage": false,
    "unallocateFundAllowed": true,
    "useParentFundAllowed": false,
    "minKycOtpVerified": false,
    "enKashSupportEmail": "support@enkash.com",
    "enKashSupportMobile": "1234567890",
    "companyName": "Vikram Singh",
    "accountType": {
      "name": "EMPLOYEE_REWARDS",
      "label": "Employee Rewards",
      "description": "Reward"
    },
    "lastAllocatedAmount": 0,
    "holdBalance": 0,
    "unAllocateHoldBalance": 0,
    "tncUnAllocateAllowed": false,
    "tncUnAllocateAccepted": false,
    "totalRewardsReceived": 0,
    "rewardPointsReceived": 0,
    "ckycEnabled": false,
    "vkycAllowed": false
  }
}
Modified at 2025-01-08 07:51:01
Previous
Get Transaction details
Next
Get User Card Details
Built with