Enkash APIs
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Fuel_cards
  • 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
      • Verify VPA
    • 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
      • Reward Get Transaction details
      • Incentive Get User Details
    • 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
        POST
      • Load Balance
        POST
      • Replace
        POST
      • Block
        POST
      • Physical
        POST
      • Get User Card Details
        POST
      • Get Transaction Details
        POST
      • Get All Transaction details
        POST
    • 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. Fuel_cards

Create

POST
/api/v0/partner/enKashCard
Card Partner Apis
This API facilitates the creation of new Fuel 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
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.
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
{
  "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",
  "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 '{
    "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",
    "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
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
{
  "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": {},
    "label": "string",
    "description": "string",
    "subModels": [
      {}
    ],
    "minValue": 0,
    "maxValue": 0
  },
  "kycStatus": {
    "name": {},
    "label": "string",
    "description": "string",
    "subModels": [
      {}
    ],
    "minValue": 0,
    "maxValue": 0
  },
  "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": {},
    "label": "string",
    "description": "string",
    "subModels": [
      {}
    ],
    "minValue": 0,
    "maxValue": 0
  },
  "shareCode": "string",
  "kycReason": "string",
  "loadAmount": 0,
  "companyId": "string",
  "middleName": "string",
  "cardKitMasterId": 0,
  "extEntityId": "string",
  "switchProvider": "M2P",
  "kycSubmittedOn": "2019-08-24T14:15:22Z",
  "kycType": {
    "name": {},
    "label": "string",
    "description": "string",
    "subModels": [
      {}
    ],
    "minValue": 0,
    "maxValue": 0
  },
  "accountBalance": 0,
  "physicalCardAllowed": true,
  "kitType": {
    "name": {},
    "label": "string",
    "description": "string",
    "subModels": [
      {}
    ],
    "minValue": 0,
    "maxValue": 0
  },
  "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": {},
    "label": "string",
    "description": "string",
    "subModels": [
      {}
    ],
    "minValue": 0,
    "maxValue": 0
  },
  "enKashSupportEmail": "string",
  "enKashSupportMobile": "string",
  "companyName": "string",
  "accountType": {
    "name": {},
    "label": "string",
    "description": "string",
    "subModels": [
      {}
    ],
    "minValue": 0,
    "maxValue": 0
  },
  "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
}
🟢200OK
Modified at 2025-01-30 10:05:55
Previous
Get All Transaction details
Next
Load Balance
Built with