EnKash API Document
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Card APIs
  • 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
      • Get Transaction details
      • Get User Details
    • 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
          POST
        • View Card
          POST
        • Set Pin Card
          POST
        • Search Cards
          POST
        • Replace Card
          POST
        • Physical Card
          POST
        • Block Card
          POST
        • Update Card balance
          POST
      • CardControls
        • Update Card Velocity Rules
        • Get Card Velocity Rules
      • Transactions
        • Get Card Transactions
      • Account
        • Get Card Account
        • Create Card Account
      • Generate Otp Card
        POST
    • 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. Card APIs

Create Card

POST
/api/v0/partner/enKashCard
Card Partner Apis
This API facilitates the creation of new Meal cards.

Request

Header Params
authorization
string 
required
Provide your bearer token in the Authorization header when making requests to protected resources.
Example:
Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379
partnerId
string 
required
PartnerID shared during sign-up
Example:
CRXXXXXXX
Body Params application/json
Encrypted request payload string
userId
string 
optional
Unique EnKash User ID. This is the ID assigned to a user created in a company.
companyId
string 
required
Unique EnKash Company ID. This is the ID assigned to a company onboarded on the EnKash platform.
cardAccountId
string 
required
Unique EnKash Account ID. This is the ID assigned to the account created under the company.
email
string 
optional
Email address of the user.
Match pattern:
^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$
mobile
string 
optional
10-digit mobile number of the user.
>= 10 characters<= 10 characters
Match pattern:
^\d{10}$
title
string 
optional
Title of the user (e.g., Mr., Ms.).
firstName
string 
optional
First name of the user.
middleName
string 
optional
Middle name of the user.
lastName
string 
optional
Last name of the user.
gender
string 
optional
Gender of the user.
specialDate
string 
optional
Special date associated with the user (birthday date).
address
string 
optional
Primary address of the user.
address2
string 
optional
Address second line
city
string 
optional
City of the user's address.
state
string 
optional
State of the user's address.
country
string 
optional
Country of the user's address.
pincode
string 
optional
Postal code of the user's address.
documents
array[object (DocumentsDTO) {3}] 
optional
List of documents associated with the user.
docType
string 
required
Type of the document (e.g., PAN, AADHAAR).
docNo
string 
required
Document number.
docExpDate
string 
optional
Document expiration date.
physicalCard
boolean 
optional
Indicates if a physical card is required while card issuance.
physicalDeliveryAddressFlag
boolean 
optional
Indicates if the delivery address is different from the primary address
deliveryAddress
string 
optional
Primary delivery address
deliveryAddress2
string 
optional
Second line of delivery address
deliveryCity
string 
optional
City of the delivery address.
deliveryState
string 
optional
State of the delivery address.
deliveryCountry
string 
optional
Country of the delivery address.
deliveryPincode
string 
optional
Postal code of the delivery address.
Example
{
    "userId": "string",
    "companyId": "string",
    "cardAccountId": "string",
    "email": "string",
    "mobile": "stringstri",
    "title": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "gender": "string",
    "specialDate": "string",
    "address": "string",
    "address2": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "pincode": "string",
    "documents": [
        {
            "docType": "string",
            "docNo": "string",
            "docExpDate": "string"
        }
    ],
    "physicalCard": true,
    "physicalDeliveryAddressFlag": true,
    "deliveryAddress": "string",
    "deliveryAddress2": "string",
    "deliveryCity": "string",
    "deliveryState": "string",
    "deliveryCountry": "string",
    "deliveryPincode": "string"
}

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 '{
    "userId": "string",
    "companyId": "string",
    "cardAccountId": "string",
    "email": "string",
    "mobile": "stringstri",
    "title": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "gender": "string",
    "specialDate": "string",
    "address": "string",
    "address2": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "pincode": "string",
    "documents": [
        {
            "docType": "string",
            "docNo": "string",
            "docExpDate": "string"
        }
    ],
    "physicalCard": true,
    "physicalDeliveryAddressFlag": true,
    "deliveryAddress": "string",
    "deliveryAddress2": "string",
    "deliveryCity": "string",
    "deliveryState": "string",
    "deliveryCountry": "string",
    "deliveryPincode": "string"
}'

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
string 
optional
label
string 
optional
description
string 
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
{
    "enKashCardId": "string",
    "userId": "string",
    "cardAccountId": "string",
    "token": "string",
    "maskedNumber": "string",
    "expiryMonth": "string",
    "expiryYear": "string",
    "email": "string",
    "mobile": "string",
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "gender": "string",
    "specialDate": "string",
    "address": "string",
    "address2": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "pincode": "string",
    "mtd": 0,
    "usedMtd": 0,
    "dtd": 0,
    "usedDtd": 0,
    "ytd": 0,
    "usedYtd": 0,
    "otbBalance": 0,
    "primaryCard": true,
    "prepaidCard": true,
    "physicalCard": true,
    "deleted": true,
    "closedLoopCard": true,
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "cardStatus": {
        "name": "string",
        "label": "string",
        "description": "string"
    },
    "kycStatus": {
        "name": "string",
        "label": "string",
        "description": "string"
    },
    "cardProgramme": "FBENKASH",
    "idProof": "string",
    "addressProof": "string",
    "pan": "string",
    "useAccountFunds": true,
    "blockCode": "A",
    "remarks": "string",
    "partnerLogo": "string",
    "cardKitNumber": "string",
    "physicalCardRequestDate": "2019-08-24T14:15:22Z",
    "physicalDeliveryAddressFlag": true,
    "deliveryAddress": "string",
    "deliveryAddress2": "string",
    "deliveryCity": "string",
    "deliveryState": "string",
    "deliveryCountry": "string",
    "deliveryPincode": "string",
    "cardActivated": true,
    "binType": {
        "name": "string",
        "label": "string",
        "description": "string"
    },
    "shareCode": "string",
    "kycReason": "string",
    "loadAmount": 0,
    "companyId": "string",
    "middleName": "string",
    "cardKitMasterId": 0,
    "extEntityId": "string",
    "switchProvider": "M2P",
    "kycSubmittedOn": "2019-08-24T14:15:22Z",
    "kycType": {
        "name": "string",
        "label": "string",
        "description": "string"
    },
    "accountBalance": 0,
    "physicalCardAllowed": true,
    "kitType": {
        "name": "string",
        "label": "string",
        "description": "string"
    },
    "surchargeAmt": 0,
    "panValidated": true,
    "invoiceNumber": "string",
    "usedLtd": 0,
    "latestTnCVersionAccepted": true,
    "latestKeyFactAccepted": true,
    "latestTnCVersionAcceptedForPrimaryCard": true,
    "latestKeyFactAcceptedCardForPrimaryCard": true,
    "tncVersionMasterId": "string",
    "tncVersion": "string",
    "tncUrl": "string",
    "keyFactSheetUrl": "string",
    "acceptanceByDate": "2019-08-24T14:15:22Z",
    "primaryEnKashCardId": "string",
    "primaryEnKashCardUserId": "string",
    "virtualAccountNumber": "string",
    "limitAllocatedLtd": 0,
    "posAllowed": true,
    "posAllowedAdmin": true,
    "atmAllowed": true,
    "atmAllowedAdmin": true,
    "onlineAllowed": true,
    "onlineAllowedAdmin": true,
    "ckycNumber": "string",
    "liveImage": true,
    "livenessScore": 0,
    "faceMatch": "string",
    "faceMatchScore": 0,
    "ckycAccountType": "string",
    "unallocateFundAllowed": true,
    "useParentFundAllowed": true,
    "defaultCardImage": "string",
    "vcipLink": "string",
    "qrImageUrl": "string",
    "vcipId": "string",
    "minKycOtpVerified": true,
    "kycSubStatus": {
        "name": "string",
        "label": "string",
        "description": "string"
    },
    "enKashSupportEmail": "string",
    "enKashSupportMobile": "string",
    "companyName": "string",
    "accountType": {
        "name": "string",
        "label": "string",
        "description": "string"
    },
    "lastAllocatedAmount": 0,
    "holdBalance": 0,
    "enableHoldAmount": true,
    "enkashCardTxnId": "string",
    "unAllocateHoldBalance": 0,
    "tncUnAllocateAllowed": true,
    "tncUnAllocateAccepted": true,
    "minTransactionAmount": 0,
    "totalRewardsReceived": 0,
    "latestRewardType": "OCCASION",
    "rewardPointsReceived": 0,
    "vkycAllowed": true,
    "ckycEnabled": true
}
Previous
Get Authorization Token
Next
View Card
Built with