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

Incentive Get User Details

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

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,
        "usedDtd": 0,
        "usedYtd": 0,
        "otbBalance": 321,
        "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,
        "companyId": "CEK1PU9AOO",
        "middleName": "",
        "extEntityId": "EXTBP0IBHV0H2",
        "physicalCardAllowed": false,
        "surchargeAmt": 0,
        "panValidated": false,
        "usedLtd": 0,
        "latestTnCVersionAccepted": true,
        "latestKeyFactAccepted": true,
        "latestTnCVersionAcceptedForPrimaryCard": true,
        "latestKeyFactAcceptedCardForPrimaryCard": true,
        "primaryEnKashCardId": "EKC9MKS5RM",
        "primaryEnKashCardUserId": "EKPDC37K",
        "limitAllocatedLtd": 311,
        "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,
        "holdBalance": 0,
        "enableHoldAmount": false,
        "unAllocateHoldBalance": 0,
        "tncUnAllocateAllowed": false,
        "tncUnAllocateAccepted": false,
        "minTransactionAmount": 10,
        "totalRewardsReceived": 3,
        "rewardPointsReceived": 321
      }
    ]
  }
}
Modified at 2024-09-02 11:58:39
Previous
Reward Get Transaction details
Next
User Authentication
Built with