- 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
- Orders
- Payments
- Refunds
- Settlements
- Split Settlements
- E-Commerce Plugins
- Payment Links
- Payment Button
- Qr Code
- UPI Mandate
- Payment Links
- Bharat Connect (BBPS)
- About Bharat Connect
- B2B Invoicing
- Invoice
- Payment
- Financing
- Onboarding
- cdNote
- Purchase Order
- webhook-invoice
- webhook-payments
- webhook-business-onboarding
- webhook-financing
- webhook-cdNote
- Webhook Purchase Order
- Webhook Send Purchase Order RequestPOST
- Webhook Send Purchase Order ResponsePOST
- Webhook Confirm Purchase Order RequestPOST
- Webhook Confirm Purchase Order ResponsePOST
- Webhook Edit Purchase Order RequestPOST
- Webhook Edit Purchase Order ResponsePOST
- Webhook Status Change Purchase Order RequestPOST
- Webhook Status Change Purchase Order ResponsePOST
- Bill Payments
- Bill Payments Overview
- Get Authentication TokenPOST
- Get BillerTypesGET
- Get BillersGET
- Fetch BillPOST
- Create Bill APIPOST
- Create Bill Without Bill FetchPOST
- Bill PaymentPOST
- Utility Bill Approval APIPUT
- Get Utility Bill StatusGET
- Get Utility Bill by Reference IdGET
- Get Utility Bills DetailPOST
- Bill Payment WebhookPOST
- 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
- Beneficiary Apis
- Transfer Apis
- Payout Account Apis
- Webhook Data Apis
- Accounts Payable Management Tool
- About AP Management Tool
- Vendor Management
- Invoice Management
- Bharat Connect 2.0 AP
- Update BeneficiaryPUT
- Account Receivable
- Accounts Receivable Overview
- Get Authentication Token Copy
- Customer Management
- Customer Contacts Management
- Customer Apis
- Invoice Management
- Payment Reminders
- Bharat Connect 2.0 AR
- Expense Management
- Loyalty
- 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
- Gift Card
- Meal Cards
- Prepaid Cards
- Fuel_cards
- Advance Card Feature
- Verification Suite
- Verification Suite Overview
- Bank Account Verification
- GSTN Verification
- PAN Verification
- UPI(VPA) Verification
Create
POST
/api/v0/partner/enKashCard
Card Partner Apis
Request
Header Params
authorization
string
required
Example:
Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379
partnerId
string
required
Example:
CRXXXXXXX
Body Params application/json
companyId
string
required
cardAccountId
string
required
email
string
optional
Match pattern:
^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$
mobile
string
optional
>= 10 characters<= 10 characters
Match pattern:
^\d{10}$
title
string
optional
firstName
string
optional
middleName
string
optional
lastName
string
optional
gender
string
optional
specialDate
string
optional
address
string
optional
address2
string
optional
city
string
optional
state
string
optional
country
string
optional
pincode
string
optional
physicalDeliveryAddressFlag
boolean
optional
deliveryAddress
string
optional
deliveryAddress2
string
optional
deliveryCity
string
optional
deliveryState
string
optional
deliveryCountry
string
optional
deliveryPincode
string
optional
Example
{
"companyId": "CEKEP5GSGP",
"cardAccountId": "CAW4SFC",
"email": "anay.test12345@enkash.com",
"mobile": "6001098878",
"title": "Mr",
"firstName": "nay",
"lastName": "doe",
"gender": "M",
"address": "cda block",
"address2": "ab colony",
"city": "kota",
"state": "Rajasthan",
"country": "India",
"pincode": "323307",
"primaryEnKashCard": false,
"physicalCard": true,
"loadAmount": 10,
"remarks": "string",
"physicalDeliveryAddressFlag": true,
"deliveryAddress": "test",
"deliveryAddress2": "test",
"deliveryCity": "test",
"deliveryState": "test",
"deliveryCountry": "test",
"deliveryPincode": "323309",
"documents": [
{
"docType": "PAN",
"docNo": "CPNPN9777R"
}
],
"specialDate": "02-09-2002"
}
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' \
--header 'authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379 ' \
--header 'partnerId: CRXXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{
"companyId": "CEKEP5GSGP",
"cardAccountId": "CAW4SFC",
"email": "anay.test12345@enkash.com",
"mobile": "6001098878",
"title": "Mr",
"firstName": "nay",
"lastName": "doe",
"gender": "M",
"address": "cda block",
"address2": "ab colony",
"city": "kota",
"state": "Rajasthan",
"country": "India",
"pincode": "323307",
"primaryEnKashCard": false,
"physicalCard": true,
"loadAmount": 10,
"remarks": "string",
"physicalDeliveryAddressFlag": true,
"deliveryAddress": "test",
"deliveryAddress2": "test",
"deliveryCity": "test",
"deliveryState": "test",
"deliveryCountry": "test",
"deliveryPincode": "323309",
"documents": [
{
"docType": "PAN",
"docNo": "CPNPN9777R" }
],
"specialDate" : "02-09-2002"
}'
Responses
🟢200OK
application/json
Body
enKashCardId
string
optional
userId
string
optional
cardAccountId
string
optional
token
string
optional
maskedNumber
string
optional
expiryMonth
string
optional
expiryYear
string
optional
email
string
optional
mobile
string
optional
title
string
optional
firstName
string
optional
lastName
string
optional
gender
string
optional
specialDate
string
optional
address
string
optional
address2
string
optional
city
string
optional
state
string
optional
country
string
optional
pincode
string
optional
mtd
number
optional
usedMtd
number
optional
dtd
number
optional
usedDtd
number
optional
ytd
number
optional
usedYtd
number
optional
otbBalance
number
optional
primaryCard
boolean
optional
prepaidCard
boolean
optional
physicalCard
boolean
optional
deleted
boolean
optional
closedLoopCard
boolean
optional
createdOn
string <date-time>
optional
modifiedOn
string <date-time>
optional
cardStatus
object (EnumModel)
optional
name
object
optional
label
string
optional
description
string
optional
subModels
array[object (SubModel)]
optional
minValue
number
optional
maxValue
number
optional
kycStatus
object (EnumModel)
optional
cardProgramme
enum<string>
optional
Allowed values:
FBENKASHSBMMAXIMUSTRANSCORPENKASHFINCARE
idProof
string
optional
addressProof
string
optional
pan
string
optional
useAccountFunds
boolean
optional
blockCode
enum<string>
optional
Allowed values:
AZCDBEFGHIJKLMNOPQRSTUVWXYCOWO
remarks
string
optional
partnerLogo
string
optional
cardKitNumber
string
optional
physicalCardRequestDate
string <date-time>
optional
physicalDeliveryAddressFlag
boolean
optional
deliveryAddress
string
optional
deliveryAddress2
string
optional
deliveryCity
string
optional
deliveryState
string
optional
deliveryCountry
string
optional
deliveryPincode
string
optional
cardActivated
boolean
optional
binType
object (EnumModel)
optional
shareCode
string
optional
kycReason
string
optional
loadAmount
number
optional
companyId
string
optional
middleName
string
optional
cardKitMasterId
integer <int64>
optional
extEntityId
string
optional
switchProvider
enum<string>
optional
Allowed values:
M2PMAXIMUSEK_CLOSEDLOOP_CREDITM2P_TRANSCORPM2P_FINCARE
kycSubmittedOn
string <date-time>
optional
kycType
object (EnumModel)
optional
accountBalance
number
optional
physicalCardAllowed
boolean
optional
kitType
object (EnumModel)
optional
surchargeAmt
number
optional
panValidated
boolean
optional
invoiceNumber
string
optional
usedLtd
number
optional
latestTnCVersionAccepted
boolean
optional
latestKeyFactAccepted
boolean
optional
latestTnCVersionAcceptedForPrimaryCard
boolean
optional
latestKeyFactAcceptedCardForPrimaryCard
boolean
optional
tncVersionMasterId
string
optional
tncVersion
string
optional
tncUrl
string
optional
keyFactSheetUrl
string
optional
acceptanceByDate
string <date-time>
optional
primaryEnKashCardId
string
optional
primaryEnKashCardUserId
string
optional
virtualAccountNumber
string
optional
limitAllocatedLtd
number
optional
posAllowed
boolean
optional
posAllowedAdmin
boolean
optional
atmAllowed
boolean
optional
atmAllowedAdmin
boolean
optional
onlineAllowed
boolean
optional
onlineAllowedAdmin
boolean
optional
ckycNumber
string
optional
liveImage
boolean
optional
livenessScore
number
optional
faceMatch
string
optional
faceMatchScore
number
optional
ckycAccountType
string
optional
unallocateFundAllowed
boolean
optional
useParentFundAllowed
boolean
optional
defaultCardImage
string
optional
vcipLink
string
optional
qrImageUrl
string
optional
vcipId
string
optional
minKycOtpVerified
boolean
optional
kycSubStatus
object (EnumModel)
optional
enKashSupportEmail
string
optional
enKashSupportMobile
string
optional
companyName
string
optional
accountType
object (EnumModel)
optional
lastAllocatedAmount
number
optional
holdBalance
number
optional
enableHoldAmount
boolean
optional
enkashCardTxnId
string
optional
unAllocateHoldBalance
number
optional
tncUnAllocateAllowed
boolean
optional
tncUnAllocateAccepted
boolean
optional
minTransactionAmount
number
optional
totalRewardsReceived
integer <int32>
optional
latestRewardType
enum<string>
optional
Allowed values:
OCCASIONPERFORMANCE
rewardPointsReceived
number
optional
vkycAllowed
boolean
optional
ckycEnabled
boolean
optional
Example
{
"code": 0,
"message": "Success",
"payload": {
"enKashCardId": "EKC1S511BV",
"userId": "EKSPB35L",
"cardAccountId": "CAW4SFC",
"token": "1c4764287c4ff5299f4",
"maskedNumber": "XXXX XXXX XXXX 8878",
"expiryMonth": "01",
"expiryYear": "2027",
"email": "anay.test12345@enkash.com",
"mobile": "6001098878",
"title": "Mr",
"firstName": "Nay",
"lastName": "Doe",
"gender": "M",
"specialDate": "02-09-2002",
"address": "cda block",
"address2": "ab colony",
"city": "kota",
"state": "Rajasthan",
"country": "India",
"pincode": "323307",
"usedMtd": 0,
"usedDtd": 0,
"usedYtd": 0,
"otbBalance": 0,
"primaryCard": false,
"prepaidCard": true,
"physicalCard": true,
"deleted": false,
"closedLoopCard": false,
"createdOn": "Jan 23, 2025 4:38:37 PM",
"modifiedOn": "Jan 23, 2025 4:38:37 PM",
"cardStatus": {
"name": "UL",
"label": "UnLocked"
},
"kycStatus": {
"name": "NOT_UPLOADED",
"label": "Not Uploaded"
},
"cardProgramme": "TRANSCORP",
"pan": "CPNPN9777R",
"useAccountFunds": false,
"blockCode": "A",
"remarks": "string",
"partnerLogo": "https://imagesbox.enkash.in/IMAGES/EnkashLogo.png",
"physicalCardRequestDate": "Jan 23, 2025 4:38:36 PM",
"physicalDeliveryAddressFlag": true,
"deliveryAddress": "test",
"deliveryAddress2": "test",
"deliveryCity": "test",
"deliveryState": "test",
"deliveryCountry": "test",
"deliveryPincode": "323309",
"cardActivated": false,
"binType": {
"name": "PREPAID",
"label": "Prepaid Card"
},
"loadAmount": 10,
"companyId": "CEKEP5GSGP",
"cardKitMasterId": 1,
"extEntityId": "EXT5KW80THN1B",
"switchProvider": "M2P_TRANSCORP",
"accountBalance": 100000,
"physicalCardAllowed": false,
"kitType": {
"name": "RUPAY",
"label": "Rupay"
},
"surchargeAmt": 0,
"panValidated": false,
"usedLtd": 0,
"latestTnCVersionAccepted": true,
"latestKeyFactAccepted": false,
"latestTnCVersionAcceptedForPrimaryCard": true,
"latestKeyFactAcceptedCardForPrimaryCard": true,
"tncVersionMasterId": "TVMMTI9OGJ",
"tncUrl": "https://ekpayout-uat.enkash.in/tu/0xl5b7ci",
"virtualAccountNumber": "ENKASHEDTCEKC1S511BV",
"limitAllocatedLtd": 0,
"posAllowed": false,
"posAllowedAdmin": false,
"atmAllowed": false,
"atmAllowedAdmin": false,
"onlineAllowed": false,
"onlineAllowedAdmin": false,
"liveImage": false,
"cKycEnabled": false,
"unallocateFundAllowed": false,
"useParentFundAllowed": false,
"defaultCardImage": "https://imagesbox.enkash.in/IMAGES/enkash_ppi.png",
"minKycOtpVerified": false,
"enKashSupportEmail": "support@freedom.io",
"enKashSupportMobile": "8530490475",
"companyName": "Anay Meal",
"vKycAllowed": true,
"accountType": {
"name": "MEAL",
"label": "Meal",
"description": "Meal"
},
"lastAllocatedAmount": 0,
"holdBalance": 0,
"enkashCardTxnId": "ECTIGQRF282DS",
"unAllocateHoldBalance": 0,
"tncUnAllocateAllowed": false,
"tncUnAllocateAccepted": false
}
}
🟢200OK
Modified at 2025-01-29 18:10:22