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 Card Details

Developing
POST
/api/v0/partner/enKashCard/search
📌
This API retrieves details of either all cards or a specific card associated with a given company and/or card account. The optional enkashCardId parameter can be used to fetch details for a specific card

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
Card Account Id
companyId
string 
required
Company Id
enKashCardId
string 
optional
Enkash Card Unique identifier Id
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 '/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 {12}] 
required
Example
{
    "code": 0,
    "message": "Success",
    "payload": {
        "recordsCount": 1,
        "data": [
            {
                "enKashCardId": "EKC9MKS5RM",
                "userId": "EKPDC37K",
                "cardAccountId": "CAQL8YCV3",
                "expiryMonth": "",
                "expiryYear": "",
                "email": "[email protected]",
                "mobile": "6667778889",
                "title": "Mr",
                "firstName": "Test",
                "lastName": "Company",
                "otbBalance": 321.00,
               
                "companyId": "CEK1PU9AOO"
            }
        ]
    }
}
Modified at 2025-05-24 09:08:42
Previous
Get User Details
Next
Incentive Create And Allocation
Built with