Enkash Developer Portal
Home
Home
Login
  1. Incentive Allocation
  • Back to home
  • Reward APIs
  • Token APIs
    • Authentication
      POST
    • Single Sign On (SSO)
      POST
  • Reward Allocation
    • Create And Allocate Points
      POST
    • Bulk Create And Allocate Rewards
      POST
    • Get Reward Account Details
      POST
    • Get Reward Transaction Details
      POST
    • Get User Details
      POST
    • Get User Card Details
      POST
  • Incentive Allocation
    • Incentive Create And Allocation
      POST
    • Get Incentive Transaction details
      POST
    • Get User Details
      POST
  • 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
    • Overview
    • Create Event
      POST
    • Get Event
      GET
    • Update Event
      PATCH
    • Allocate Coins
      POST
    • Get Balance
      GET
  1. Incentive Allocation

Get User Details

Developing
POST
/api/v0/partner/enKashCard/search
📌
This API retrieves a list of users associated with a specific organization, platform, or system. It returns key user profile information, optionally filtered by user role, status, or other criteria. Useful for admin dashboards, user management modules, or reporting interfaces

Request

Header Params

Body Params application/json

Example
{
    "cardAccountId": "CAQL8YCV3",
    "companyId" : "CEK1PU9AOO",
    "enKashCardId": "EKC9MKS5RM"
}

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

Responses

🟢200Success
application/json
Body

Example
{"code":0,"message":"Success","payload":{"recordsCount":1,"data":[{"enKashCardId":"EKC9MKS5RM","userId":"EKPDC37K","cardAccountId":"CAQL8YCV3","token":"152aaef7e91c6abfc7fb","maskedNumber":"2004 00XX XXXX XX89","expiryMonth":"","expiryYear":"","email":"[email protected]","mobile":"6667778889","title":"Mr","firstName":"Test","lastName":"Company","gender":"M","usedMtd":0.00,"usedDtd":0.00,"usedYtd":0.00,"otbBalance":321.00,"primaryCard":true,"prepaidCard":true,"physicalCard":false,"deleted":false,"closedLoopCard":false,"createdOn":"Feb 1, 2024 2:28:18 PM","modifiedOn":"Mar 14, 2024 3:07:11 PM","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":10.00,"companyId":"CEK1PU9AOO","middleName":"","extEntityId":"EXTBP0IBHV0H2","physicalCardAllowed":false,"surchargeAmt":0.000,"panValidated":false,"usedLtd":0.00,"latestTnCVersionAccepted":true,"latestKeyFactAccepted":true,"latestTnCVersionAcceptedForPrimaryCard":true,"latestKeyFactAcceptedCardForPrimaryCard":true,"primaryEnKashCardId":"EKC9MKS5RM","primaryEnKashCardUserId":"EKPDC37K","limitAllocatedLtd":311.00,"posAllowed":true,"posAllowedAdmin":true,"atmAllowed":false,"atmAllowedAdmin":false,"onlineAllowed":true,"onlineAllowedAdmin":true,"liveImage":false,"cKycEnabled":false,"unallocateFundAllowed":false,"useParentFundAllowed":false,"minKycOtpVerified":false,"vKycAllowed":false,"accountType":{"name":"EMPLOYEE_REWARDS","label":"Employee Rewards","description":"Reward"},"lastAllocatedAmount":188.00,"holdBalance":0.00,"enableHoldAmount":false,"unAllocateHoldBalance":0.00,"tncUnAllocateAllowed":false,"tncUnAllocateAccepted":false,"minTransactionAmount":10,"totalRewardsReceived":3,"rewardPointsReceived":321.00}]}}
Modified at 2025-05-24 09:50:44
Previous
Get Incentive Transaction details
Next
User Authentication
Built with