Enkash Developer Portal
Home
Home
Login
  1. Reward Allocation
  • Back to home
  • Reward APIs
  • Token APIs
    • Authentication
    • Single Sign On (SSO)
  • 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
    • 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
  1. Reward 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

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
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": "[email protected]",
        "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": "[email protected]",
        "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-05-24 09:06:20
Previous
Get Reward Transaction Details
Next
Get User Card Details
Built with