- 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
userId
stringÂ
optional
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
documents
array[object (DocumentsDTO) {3}]Â
optional
docType
stringÂ
required
docNo
stringÂ
required
docExpDate
stringÂ
optional
physicalCard
booleanÂ
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": "CABFIPS",
"email": "anay.soni12@enkash.com",
"mobile": "6001098801",
"title": "Mr",
"firstName": "johny",
"lastName": "bateman",
"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": "CPNPN9977R"
}
],
"specialDate": "02-09-2001"
}
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": "CABFIPS",
"email": "anay.soni12@enkash.com",
"mobile": "6001098801",
"title": "Mr",
"firstName": "johny",
"lastName": "bateman",
"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": "CPNPN9977R" }
],
"specialDate" : "02-09-2001"
}'
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": "EKCMB7KAEW",
"userId": "EKSGAY08",
"cardAccountId": "CABFIPS",
"token": "131a73dc83713e010467",
"maskedNumber": "XXXX XXXX XXXX 8801",
"expiryMonth": "01",
"expiryYear": "2027",
"email": "anay.soni12@enkash.com",
"mobile": "6001098801",
"title": "Mr",
"firstName": "Johny",
"lastName": "Bateman",
"gender": "M",
"specialDate": "02-09-2001",
"address": "cda block",
"address2": "ab colony",
"city": "kota",
"state": "Rajasthan",
"country": "India",
"pincode": "323307",
"usedMtd": 0,
"usedDtd": 0,
"usedYtd": 0,
"otbBalance": 0,
"primaryCard": true,
"prepaidCard": true,
"physicalCard": true,
"deleted": false,
"closedLoopCard": false,
"createdOn": "Jan 29, 2025 1:50:28 PM",
"modifiedOn": "Jan 29, 2025 1:50:28 PM",
"cardStatus": {
"name": "UL",
"label": "UnLocked"
},
"kycStatus": {
"name": "NOT_UPLOADED",
"label": "Not Uploaded"
},
"cardProgramme": "ENKASH",
"pan": "CPNPN9977R",
"useAccountFunds": false,
"blockCode": "A",
"remarks": "string",
"partnerLogo": "https://imagesbox.enkash.in/IMAGES/EnkashLogo.png",
"cardKitNumber": "card_0da321f7-b89d-44d6-b8f7-988c02f44d75",
"physicalCardRequestDate": "Jan 29, 2025 1:50:28 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": "EXTG5PGLLJOER",
"switchProvider": "PAY_NEXT",
"accountBalance": 0,
"physicalCardAllowed": false,
"kitType": {
"name": "RUPAY",
"label": "Rupay"
},
"surchargeAmt": 0,
"panValidated": false,
"usedLtd": 0,
"latestTnCVersionAccepted": true,
"latestKeyFactAccepted": true,
"latestTnCVersionAcceptedForPrimaryCard": true,
"latestKeyFactAcceptedCardForPrimaryCard": true,
"tncVersionMasterId": "TVMWVTUADW",
"tncUrl": "imagesbox.enkash.in/IMAGES/PPI_T&C.pdf",
"acceptanceByDate": {
"date": {
"year": 2023,
"month": 1,
"day": 5
},
"time": {
"hour": 6,
"minute": 55,
"second": 56,
"nano": 884000000
}
},
"virtualAccountNumber": "ENKASHEDENEKCMB7KAEW",
"limitAllocatedLtd": 0,
"posAllowed": false,
"posAllowedAdmin": false,
"atmAllowed": false,
"atmAllowedAdmin": false,
"onlineAllowed": false,
"onlineAllowedAdmin": false,
"liveImage": false,
"cKycEnabled": false,
"unallocateFundAllowed": true,
"useParentFundAllowed": true,
"defaultCardImage": "https://imagesbox.enkash.in/IMAGES/enkash_ppi.png",
"minKycOtpVerified": false,
"enKashSupportEmail": "support@enkash.com",
"enKashSupportMobile": "1234567890",
"companyName": "Anay Prepaid",
"vKycAllowed": true,
"accountType": {
"name": "RELOADABLE_GPR",
"label": "Reloadable GPR",
"description": "Prepaid"
},
"lastAllocatedAmount": 0,
"holdBalance": 0,
"enkashCardTxnId": "ECT1LDDPS37CJ",
"unAllocateHoldBalance": 0,
"tncUnAllocateAllowed": false,
"tncUnAllocateAccepted": false
}
}
🟢200OK
Modified at 2025-01-30 10:05:44