Enkash Developer Portal
Home
Home
Login
  1. Incentive Allocation
  • Back to home
  • Reward 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
      POST
    • Get Incentive Transaction details
      POST
    • Get User Details
      POST
  • 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
  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
partnerId
string 
required
Example:
CRMXWB3ZM
Authorization
string 
required
Example:
Bearer SuzhOaF6K64ztA4rSmDOgl9yMlI
Content-Type
string 
required
Example:
application/json
Cookie
string 
required
Example:
JSESSIONID=526FAFE391FEC276549D84FEF5FC5BE7; JSESSIONID=B01764303CD3DEFC3C0699B3EF351505
Body Params application/json
cardAccountId
string 
required
companyId
string 
required
enKashCardId
string 
required
Example
{
    "cardAccountId": "CAQL8YCV3",
    "companyId" : "CEK1PU9AOO",
    "enKashCardId": "EKC9MKS5RM"
}

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 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
code
integer 
required
message
string 
required
payload
object 
required
recordsCount
integer 
required
data
array [object {15}] 
required
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":"test@hrms.com","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