EnKash API Document
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Account
  • 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
        • View Card
        • Set Pin Card
        • Search Cards
        • Replace Card
        • Physical Card
        • Block 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
    • 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
          POST
        • Create Card Account
          POST
      • Generate Otp Card
        POST
  • 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. Account

Get Card Account

POST
/api/v0/partner/enKashCard/cardAccount/get
Card Partner Apis
This API retrieves detailed information about the Card account, including card details, account balances, card program and plan information.

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
companyId
string 
optional
companyName
string 
optional
cardAccountId
string 
optional
cardAccountIds
array[string]
optional
companyIds
array[string]
optional
userGroupIds
array[string]
optional
filter
string 
optional
closedLoopCard
boolean 
optional
binType
enum<string> 
optional
Allowed values:
PREPAIDCREDITGIFT_CARDREWARDHANDLE
createdOnFrom
string <date-time>
optional
createdOnTo
string <date-time>
optional
creditProviderId
string 
optional
Example
{
    "companyId": "string",
    "companyName": "string",
    "cardAccountId": "string",
    "cardAccountIds": [
        "string"
    ],
    "companyIds": [
        "string"
    ],
    "userGroupIds": [
        "string"
    ],
    "filter": "string",
    "closedLoopCard": true,
    "binType": "PREPAID",
    "createdOnFrom": "2019-08-24T14:15:22Z",
    "createdOnTo": "2019-08-24T14:15:22Z",
    "creditProviderId": "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/cardAccount/get' \
--header 'authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379' \
--header 'partnerId:  CRXXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{
    "companyId": "string",
    "companyName": "string",
    "cardAccountId": "string",
    "cardAccountIds": [
        "string"
    ],
    "companyIds": [
        "string"
    ],
    "userGroupIds": [
        "string"
    ],
    "filter": "string",
    "closedLoopCard": true,
    "binType": "PREPAID",
    "createdOnFrom": "2019-08-24T14:15:22Z",
    "createdOnTo": "2019-08-24T14:15:22Z",
    "creditProviderId": "string"
}'

Responses

🟢200OK
application/json
Body
cardAccountId
string 
optional
companyId
string 
optional
companyName
string 
optional
email
string 
optional
mobile
string 
optional
creditLimit
number 
optional
dynamicLimit
number 
optional
usedCreditLimit
number 
optional
availableBalance
number 
optional
availableCardBalance
number 
optional
prepaidCard
boolean 
optional
blockCode
enum<string> 
optional
Allowed values:
AZCDBEFGHIJKLMNOPQRSTUVWXYCOWO
createdOn
string <date-time>
optional
modifiedOn
string <date-time>
optional
totalCards
integer <int64>
optional
activeCards
integer <int64>
optional
nextBillingDate
string <date-time>
optional
lastBillingDate
string <date-time>
optional
ctdDebit
number 
optional
ctdCredit
number 
optional
lastBilledAmount
number 
optional
previousAmountDue
number 
optional
amountDue
number 
optional
minAmountDue
number 
optional
madIndicator
enum<string> 
optional
Allowed values:
MT
planMasterId
string 
optional
totalDebits
number 
optional
totalCredits
number 
optional
currentMonthDebits
number 
optional
currentMonthCredits
number 
optional
partnerLogo
string 
optional
cardProgramme
enum<string> 
optional
Allowed values:
FBENKASHSBMMAXIMUSTRANSCORPENKASHFINCARE
binType
enum<string> 
optional
Allowed values:
PREPAIDCREDITGIFT_CARDREWARDHANDLE
fxMarkup
number 
optional
minTxnValue
number 
optional
gstNumber
string 
optional
autoAllocateCardKit
boolean 
optional
kitType
object (EnumModel) 
optional
name
string 
optional
label
string 
optional
description
string 
optional
accountType
object (EnumModel) 
optional
accountTitle
string 
optional
closedLoopCard
boolean 
optional
usedMtd
number 
optional
usedDtd
number 
optional
usedMtdCount
integer <int32>
optional
usedDtdCount
integer <int32>
optional
showBulkUpload
boolean 
optional
physicalCardAllowed
boolean 
optional
autoFundingDisabled
boolean 
optional
perTxnLimitCard
number 
optional
dtdCard
number 
optional
mtdCard
number 
optional
ytdCard
number 
optional
ltdCard
number 
optional
ifscCode
string 
optional
bankName
string 
optional
virtualAccountNumber
string 
optional
userGroupIds
array[string]
optional
udyamNumber
string 
optional
nachStatus
enum<string> 
optional
Allowed values:
ACTIVE_MANDATORYACTIVE_OPTIONALINACTIVE
creditProviderId
string 
optional
tenantSync
boolean 
optional
subAssetClassCode
string 
optional
npaDate
string <date-time>
optional
provision
number 
optional
newCreditLimit
number 
optional
makerApprovalFile
string 
optional
requestedRemark
string 
optional
entityUpdateRequestStatus
enum<string> 
optional
Allowed values:
APPROVEDREJECTEDPENDINGREVERSAL_REQUESTEDFAILED
lastApprovedDate
string <date-time>
optional
makerName
string 
optional
corporateCif
string 
optional
authorisedSignatories
array[object (AuthorisedSignatoryModel) {2}] 
optional
name
string 
optional
cifNumber
string 
optional
plan
string 
optional
program
string 
optional
programFunding
string 
optional
billingFrequency
object (EnumModel) 
optional
slab
string 
optional
latestFinancialYear
string 
optional
cardRelationShipId
string 
optional
nachRestrictionOverridden
boolean 
optional
nachRestrictionStatus
enum<string> 
optional
Allowed values:
RESTRICTION_NOT_APPLICABLEREGISTRATION_MANDATORYREGISTRATION_OPTIONALREGISTRATION_IN_PROGRESSREGISTRATION_FAILED
cashbackPlanName
string 
optional
cashbackPlanId
string 
optional
totalAllocationPoint
number 
optional
totalRedemptionPoint
number 
optional
currentMonthAllocationPoint
number 
optional
currentMonthRedemptionPoint
number 
optional
suspendedDate
string <date-time>
optional
autoLoadingAvailableFrequency
array[string]
optional
Allowed values:
DAILYWEEKLYMONTHLYQUARTERLYYEARLY
planAutoLoadingEnabled
boolean 
optional
blockCodeDate
string <date-time>
optional
autoAllocateFunds
boolean 
optional
planEnableHoldAmount
boolean 
optional
enableHoldAmount
boolean 
optional
downloadCardData
boolean 
optional
bulkAllocateAllowed
boolean 
optional
virtualAccountHolderName
string 
optional
refundToSource
boolean 
optional
totalRewards
number 
optional
totalOccasionRewards
number 
optional
totalPerformanceRewards
number 
optional
creditLimitUpdate
boolean 
optional
dpd
string 
optional
Example
{
    "cardAccountId": "string",
    "companyId": "string",
    "companyName": "string",
    "email": "string",
    "mobile": "string",
    "creditLimit": 0,
    "dynamicLimit": 0,
    "usedCreditLimit": 0,
    "availableBalance": 0,
    "availableCardBalance": 0,
    "prepaidCard": true,
    "blockCode": "A",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "totalCards": 0,
    "activeCards": 0,
    "nextBillingDate": "2019-08-24T14:15:22Z",
    "lastBillingDate": "2019-08-24T14:15:22Z",
    "ctdDebit": 0,
    "ctdCredit": 0,
    "lastBilledAmount": 0,
    "previousAmountDue": 0,
    "amountDue": 0,
    "minAmountDue": 0,
    "madIndicator": "M",
    "planMasterId": "string",
    "totalDebits": 0,
    "totalCredits": 0,
    "currentMonthDebits": 0,
    "currentMonthCredits": 0,
    "partnerLogo": "string",
    "cardProgramme": "FBENKASH",
    "binType": "PREPAID",
    "fxMarkup": 0,
    "minTxnValue": 0,
    "gstNumber": "string",
    "autoAllocateCardKit": true,
    "kitType": {
        "name": "string",
        "label": "string",
        "description": "string"
    },
    "accountType": {
        "name": "string",
        "label": "string",
        "description": "string"
    },
    "accountTitle": "string",
    "closedLoopCard": true,
    "usedMtd": 0,
    "usedDtd": 0,
    "usedMtdCount": 0,
    "usedDtdCount": 0,
    "showBulkUpload": true,
    "physicalCardAllowed": true,
    "autoFundingDisabled": true,
    "perTxnLimitCard": 0,
    "dtdCard": 0,
    "mtdCard": 0,
    "ytdCard": 0,
    "ltdCard": 0,
    "ifscCode": "string",
    "bankName": "string",
    "virtualAccountNumber": "string",
    "userGroupIds": [
        "string"
    ],
    "udyamNumber": "string",
    "nachStatus": "ACTIVE_MANDATORY",
    "creditProviderId": "string",
    "tenantSync": true,
    "subAssetClassCode": "string",
    "npaDate": "2019-08-24T14:15:22Z",
    "provision": 0,
    "newCreditLimit": 0,
    "makerApprovalFile": "string",
    "requestedRemark": "string",
    "entityUpdateRequestStatus": "APPROVED",
    "lastApprovedDate": "2019-08-24T14:15:22Z",
    "makerName": "string",
    "corporateCif": "string",
    "authorisedSignatories": [
        {
            "name": "string",
            "cifNumber": "string"
        }
    ],
    "plan": "string",
    "program": "string",
    "programFunding": "string",
    "billingFrequency": {
        "name": "string",
        "label": "string",
        "description": "string"
    },
    "slab": "string",
    "latestFinancialYear": "string",
    "cardRelationShipId": "string",
    "nachRestrictionOverridden": true,
    "nachRestrictionStatus": "RESTRICTION_NOT_APPLICABLE",
    "cashbackPlanName": "string",
    "cashbackPlanId": "string",
    "totalAllocationPoint": 0,
    "totalRedemptionPoint": 0,
    "currentMonthAllocationPoint": 0,
    "currentMonthRedemptionPoint": 0,
    "suspendedDate": "2019-08-24T14:15:22Z",
    "autoLoadingAvailableFrequency": [
        "DAILY"
    ],
    "planAutoLoadingEnabled": true,
    "blockCodeDate": "2019-08-24T14:15:22Z",
    "autoAllocateFunds": true,
    "planEnableHoldAmount": true,
    "enableHoldAmount": true,
    "downloadCardData": true,
    "bulkAllocateAllowed": true,
    "virtualAccountHolderName": "string",
    "refundToSource": true,
    "totalRewards": 0,
    "totalOccasionRewards": 0,
    "totalPerformanceRewards": 0,
    "creditLimitUpdate": true,
    "dpd": "string"
}
Previous
Get Card Transactions
Next
Create Card Account
Built with