Enkash Developer Portal
Home
Home
Login
  1. Home
  • Back to home
  • Prepaid Card APIs
  • Encryption & Decryption Guide
  • Auth Token
    POST
  • Create Card Account
    POST
  • Create Gift Card
    POST
  • Create Prepaid Card
    POST
  • Set Card PIN
    POST
  • Load Card Balance
    POST
  • Get Card Account Details
    POST
  • Generate Card OTP
    POST
  • View Card Details
    POST
  • Card Usage Controls
    POST
  • Get Card Usage Limits
    POST
  • Request Card Replacement
    POST
  • Block Card
    POST
  • Order Physical Card
    POST
  • Get Card Details
    POST
  • Get Transaction Details
    POST
  • Get All Transaction details
    POST
  1. Home

Create Gift Card

POST
/api/v0/partner/enKashCard
📌
This API allows to create new gift cards under a specified card account. It supports issuing physical or virtual cards with customizable details such as cardholder name, account type, and limits

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.
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",
    "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",
    "physicalCard": true,
    "physicalDeliveryAddressFlag": true,
    "deliveryAddress": "string",
    "deliveryAddress2": "string",
    "deliveryCity": "string",
    "deliveryState": "string",
    "deliveryCountry": "string",
    "deliveryPincode": "string"
}'

Responses

🟢200OK
application/json
Body
code
integer 
required
message
string 
required
payload
object 
required
enKashCardId
string 
required
Enkash Card ID
userId
string 
required
Enkash User Id
cardAccountId
string 
required
Unique Card Account Id
maskedNumber
string 
required
Card Number masked
expiryMonth
string 
required
Expiry month of card
expiryYear
string 
required
Expiry year of card
email
string 
required
Email of user
mobile
string 
required
mobile of user
title
string 
required
Mr/Mrs/Ms
firstName
string 
required
First Name of user
lastName
string 
required
Last name of user
gender
string 
required
Gender of card holder
specialDate
string 
required
Date of Birth of Card Holder
address
string 
required
Address of card holder
address2
string 
required
Address 2 of card holder
city
string 
required
City of card holder residence
state
string 
required
state of card holder residence
country
string 
required
Country of card holder residence
pincode
string 
required
Pincode
otbBalance
integer 
required
Available Card Balance
primaryCard
boolean 
required
Flag which denotes if a card is a primary card
prepaidCard
boolean 
required
Flag for identifying if a card is prepaid
physicalCard
boolean 
required
Is physical card available for this enkash card (if yes, then true)
cardStatus
object 
required
L("Locked"), UL("UnLocked"), BL("Blocked"),AP("Activation InProgress");
kycStatus
object 
required
VERIFIED, PENDING, FAILED, UPLOADED, CKYC_IN_PROGRESS, CKYC_PENDING, LIVENESS_PENDING, NOT_UPLOADED, OSV_VERIFIED, PAPER_KYC_PENDING, MIN_KYC_VERIFIED, KYC_NOT_ALLOWED, DRAFTED, CREATED
pan
string 
required
PAN of card holder
physicalCardRequestDate
string 
required
Date on which physical card was requested by user
physicalDeliveryAddressFlag
boolean 
required
flag for identifying if physical delivery address is present
deliveryAddress
string 
required
Delivery address 1
deliveryAddress2
string 
required
Delivery address 2
deliveryCity
string 
required
Delivery City
deliveryState
string 
required
Delivery State
deliveryCountry
string 
required
Delivery Country
deliveryPincode
string 
required
Delivery Pincode
cardActivated
boolean 
required
flag for identifying if a card is activated
companyId
string 
required
Company Id
loadAmount
string 
required
denotes if any amount was loaded in the card
accountBalance
integer 
required
Current Account balance
physicalCardAllowed
boolean 
required
flag which denotes if physical card is allowed
panValidated
boolean 
required
flag for checking if pan is validated
posAllowed
boolean 
required
Pos Allowed flag
posAllowedAdmin
boolean 
required
If the admin has disabled the posAllowedAdmin flag, the POS will remain non-functional even if the user enables posAllowed, as the admin's settings take precedence.
atmAllowed
boolean 
required
Atm allowed on card
atmAllowedAdmin
boolean 
required
If the admin has disabled the atmAllowedAdmin flag, the ATM will remain non-functional even if the user enables atmAllowed, as the admin's settings take precedence.
onlineAllowed
boolean 
required
Online Transaction Allowed on card
onlineAllowedAdmin
boolean 
required
If the admin has disabled the onlineAllowedAdmin flag, the Online Txn will remain non-functional even if the user enables onlineAllowed, as the admin's settings take precedence.
unallocateFundAllowed
boolean 
required
flag which denotes if unallocate fund is allowed on card
companyName
string 
required
Company legal name
accountType
object 
required
RELOADABLE_GPR , GIFT, MEAL, FUEL, VIRTUAL_ACCOUNT, EMPLOYEE_REWARDS
lastAllocatedAmount
integer 
required
Last allocated amount
enkashCardTxnId
string 
required
Unique Enkash Transaction Id
Example
{
    "code": 0,
    "message": "Success",
    "payload": {
        "enKashCardId": "EKC94AEX89",
        "userId": "EK94JCMP",
        "cardAccountId": "CAA8W45",
        "token": "cf5295da683104b6580",
        "maskedNumber": "XXXX XXXX XXXX 3211",
        "expiryMonth": "01",
        "expiryYear": "2027",
        "email": "johnnydew@enkash.com",
        "mobile": "6876543211",
        "title": "Mr",
        "firstName": "Johnny",
        "lastName": "Dew",
        "gender": "M",
        "specialDate": "2000-02-14",
        "address": "123 Street Name",
        "address2": "Apt 456",
        "city": "Pune",
        "state": "Maharashtra",
        "country": "India",
        "pincode": "323908",
        "usedMtd": 0,
        "usedDtd": 0,
        "usedYtd": 0,
        "otbBalance": 500,
        "primaryCard": true,
        "prepaidCard": true,
        "physicalCard": false,
        "deleted": false,
        "closedLoopCard": false,
        "createdOn": "Jan 29, 2025 11:57:51 AM",
        "modifiedOn": "Jan 29, 2025 11:57:51 AM",
        "cardStatus": {
            "name": "UL",
            "label": "UnLocked"
        },
        "kycStatus": {
            "name": "NOT_UPLOADED",
            "label": "Not Uploaded"
        },
        "cardProgramme": "TRANSCORP",
        "useAccountFunds": false,
        "blockCode": "A",
        "remarks": "This is a test card",
        "partnerLogo": "https://imagesbox.enkash.in/IMAGES/EnkashLogo.png",
        "physicalDeliveryAddressFlag": true,
        "deliveryAddress": "789 Delivery St",
        "deliveryAddress2": "Suite 101",
        "deliveryCity": "Mumbai",
        "deliveryState": "Maharashtra",
        "deliveryCountry": "India",
        "deliveryPincode": "323307",
        "cardActivated": false,
        "binType": {
            "name": "GIFT_CARD",
            "label": "Gift Card"
        },
        "loadAmount": 500,
        "companyId": "CEKEP5GSGP",
        "cardKitMasterId": 2,
        "extEntityId": "EXT58EDZTA1U1",
        "switchProvider": "M2P_TRANSCORP",
        "accountBalance": 99500,
        "physicalCardAllowed": false,
        "kitType": {
            "name": "RUPAY",
            "label": "Rupay"
        },
        "surchargeAmt": 0,
        "panValidated": false,
        "usedLtd": 0,
        "latestTnCVersionAccepted": true,
        "latestKeyFactAccepted": false,
        "latestTnCVersionAcceptedForPrimaryCard": true,
        "latestKeyFactAcceptedCardForPrimaryCard": true,
        "tncVersionMasterId": "TVMLP1VK8X",
        "tncUrl": "https://ekpayout-uat.enkash.in/tu/0xl5b7ci",
        "virtualAccountNumber": "ENKASHEDTCEKC94AEX89",
        "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@enkash.com",
        "enKashSupportMobile": "1234567890",
        "companyName": "Anay Gift",
        "vKycAllowed": false,
        "accountType": {
            "name": "GIFT",
            "label": "Gift",
            "description": "Gift"
        },
        "lastAllocatedAmount": 0,
        "holdBalance": 0,
        "enkashCardTxnId": "ECTNY27ELILVP",
        "unAllocateHoldBalance": 0,
        "tncUnAllocateAllowed": false,
        "tncUnAllocateAccepted": false
    }
}
Modified at 2025-05-26 17:22:21
Previous
Create Card Account
Next
Create Prepaid Card
Built with