EnKash API Document
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Channel Incentives
  • EnKash APIs
  • Payment Gateway
    • Payment Gateway Overview
    • Payment Gateway Sign Up
    • Payment Methods
    • Supported Integrations
    • Payment APIs
    • Test Card Details
    • Authorization
      • About Authorization
      • Get Authorization Token
    • Orders
      • Order Overview
      • About Order
      • Create Order
      • Get Order Status
      • Get BNPL Payment Modes
    • Payments
      • Payment Overview
      • About Payment
      • Get Transaction Status
      • Submit Payment Detail
    • Refunds
      • About Refund
      • Refund
    • Payment Links
      • Upi Intent Link Detail
    • Settlements
      • About Settlement
      • Get Settlement Payout By Id
      • Search Settlement Payouts
    • QR Generation API
      • Get Dynamic QR Code
    • Payment Button
    • Qr Code
      • Create QR
      • Create QR Customer
      • Search QR Code
      • Get QR Code
      • Cancel QR Code
  • Payouts
    • Payouts Overview
    • Payouts Sign Up
    • Payout Methods
    • Payouts Integration Steps
    • Ecrypting and Decrypting Payload
    • 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 Source Bank Account Details
      • Add Source Bank Account
      • Get Balance
  • Account Payables
    • Accounts Payable Overview
    • Vendor Management
      • Beneficiary Apis
        • Update Beneficiary
        • Create Beneficiary
        • Update Bulk Beneficiary
        • Create Bulk Beneficiary
        • Get Beneficiaries V1
        • Get Beneficiaries
        • Change beneficiary status
        • Get Beneficiary
    • Invoice Management
      • Payout Apis
        • Search Payouts V1
        • initiate
        • validateInvoices
        • bulkCreatePayout
        • Create Payout
        • Update Payouts
        • Search Payouts
        • createBulkPayoutForPartnerIntegration
        • Update Bulk Payouts
        • Update Approval Status
        • Get Invoice Data
        • Delete Payout
  • Account Receivable
    • Accounts Receivable Overview
    • Get Authentication Token Copy
      • Get Authentication Token
    • Customer Management
      • Customer Apis
        • createCustomer
        • Activate customer
        • createBulkCustomer
        • bulkUpdate
        • Deactivate customer
        • searchCustomer
        • 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
  • Loyalty
    • Loyalty Overview
    • Sign Up - Loyalty
    • Use Cases
    • Reward APIs
    • Authorization
      • SSO LOGIN
      • Client Authentication
    • Employee R&R
      • Create And Allocate point
      • Get Transaction details
      • Get User Details
    • Channel Incentives
      • Create And Allocate point
        POST
      • Get Transaction details
        POST
      • Get User Details
        POST
    • brand loyalty
      • Get Coin Event
      • Create Coin Event Configuration
      • Update Coin Event Configuration
      • Allocate Coins to User
    • Voucher Processing
      • Get Cart for User
      • Add to cart
      • Update Cart
      • Order Search
      • Get Order Details
      • Create Order
    • Voucher Catalog
      • Search Catalog
      • Get Product Catalog Details
      • Get Product Configs (Denominations)
  • Expense Management
    • Expense Management Overview
    • Sign Up - Expense Management
  • Corporate Cards
    • Corporate Cards Overview
    • Sign Up - Corporate Cards
    • Corporate Cards Integration Steps
    • Authorization
      • Get Authorization Token
    • Meal Cards
      • Card APIs
        • Create Card
        • View Card
        • Set Pin Card
        • Search Cards
        • Replace Card
        • Physical Card
        • Block Card
        • Update Card balance
      • CardControls
        • Update Card Velocity Rules
        • Get Card Velocity Rules
      • Transactions
        • Get Card Transactions
      • Account
        • Get Card Account
        • Create Card Account
      • Generate Otp Card
    • Fuel Cards
      • Card APIs
        • Create Card
        • Search Cards
        • View Card
        • Block Card
        • Physical Card
        • Set Pin Card
        • Replace Card
        • Update Card balance
      • CardControls
        • Update Card Velocity Rules
        • Get Card Velocity Rules
      • Transactions
        • Get Card Transactions
      • Account
        • Get Card Account
        • Create Card Account
      • Generate Otp Card
  • Verification Suite
    • Verification Suite Overview
    • Bank Account Verification
    • GSTN Verification
    • PAN Verification
    • UPI(VPA) Verification
  • Payout Data Apis
  • Beneficiary Apis
  • tiny-url-controller
  • test-controller
  • company-category-limits-controller
  • bank-holiday-controller
  • Authentication Apis
  • utility-payment-controller-v-1
  • user-controller-v-1
  • Payout Apis
  • gst-payment-controller
  • biller-controller-v-1
  • Virtual Account Apis
  • Vendor Payment Entry Controller
  • Utm Based Config Apis
  • User Apis
  • User Group Apis
  • axis-nodal-controller-v-1
  • icici-nodal-controller
  • axis-nodal-controller
  • subscription-controller
  • Sign Up API's
  • sftp-detail-controller
  • sanction-screening-controller
  • risk-check-controller
  • Reward Page Notification Apis
  • refund-transaction-controller
  • purchase-order-controller
  • Pricing Plan
  • Pre Qualification Apis
  • Pg Balance Apis
  • Payout Transaction Apis
  • payment-request-controller
  • Payment Gateway Apis
  • pay-by-link-controller
  • Partner Integration Apis
  • outstanding-amount-controller
  • otp-controller
  • OnBoarding Config Apis
  • Nudge Apis
  • Multi Factor Auth Apis
  • mail-callback-controller
  • M2P Apis
  • anchor-partner-api-controller
  • amazon-sn-s-notification-controller
  • Karza Controller
  • Instant Payout Apis
  • ICICI Connected Banking Apis
  • gstin-data-controller
  • Generate Pdf APIs
  • fin-bit-controller
  • File Store Apis
  • file-transfer-controller
  • feedback-controller
  • Fd Payment Histories
  • Favorite Api
  • Expense Product Apis
  • equifax-controller
  • Encryption Apis
  • early-payment-offer-controller
  • Document
  • digital-signature-controller
  • digital-locker-controller
  • Credit Provider Risk Check API
  • credit-provider-detail-controller
  • Config Apis
  • company-pg-controller
  • company-branch-code-controller
  • communication-controller
  • Chat Bot Apis
  • card-token-controller
  • Card Product Master Apis
  • card-product-controller
  • Card Application Memo Apis
  • Card Application Apis
  • CardAccountTenant Apis
  • Card Account Addition Mapping Apis
  • Cam Automation Apis
  • bulk-file-detail-controller
  • bulk-file-data-controller
  • Bill Payment Apis
  • Company Biller Apis
  • Beneficiary Detail Apis
  • Bbps Complaint Management Apis
  • Bank IFSC
  • Bank Detail Apis
  • Bank Card Controller
  • AWS Secret Manager Properties Apis
  • Authority Apis
  • Anchor Detail Apis
  • penny-drop-controller
  • Mobile Otp Apis
  • Mobile Authentication Apis
  • oauth-client-detail-controller
  • url-generator-controller
  • Health Check Apis
  • Single Sign On Apis
  • Bulk Upload Sample File Apis
  • credit-policy-controller
  • Payout Logs
  • Help Apis
  • Geo Location Controller
  1. Channel Incentives

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 '/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}]}}
Previous
Get Transaction details
Next
Get Coin Event
Built with