Enkash APIs
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. APIs
  • Explore Our Product Suite
  • Payment Gateway
    • Payment Gateway Overview
    • Getting Started
    • Payment Methods
    • Integration
    • API Endpoints
    • APIs
      • Authorisation
        • Get Authorization Token
      • Order
        • Create Order
        • Get Order Status
        • Get Order By Merchant Order Id
        • Get BNPL Payment Modes
        • Get Dynamic QR Code
        • UPI Intent Links
      • Payment
        • Submit Payment Detail
        • Get Transaction Status
        • Validate OTP
        • Resend OTP
        • Payment Notify Request
        • Get UPI Transaction Status
        • Verify VPA
      • Refund
        • Refund
      • Settlement
        • Settlement Reporting
        • Get Settlement Payout By ID
        • Search Settlement Payouts
      • Split Settlement
        • 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 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
  • 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
  • Prepaid Cards
    • About Prepaid Card
    • Key Capabilities
    • Getting Started
    • APIs
      • API Access & Authorization
      • 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
  • Bharat Connect (BBPS)
    • About Bharat Connect
    • Invoice Payments
      • 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
      • Utility API Response Handling
      • 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
  • Accounts Payable
    • 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
    • About Authorization
    • Expenses
    • Advance
    • Token API
  • Rewards & Incentives
    • About Rewards
    • Getting Started
    • Encryption & Decryption Guide
    • Reward Allocation
    • Incentive Allocation
    • APIs
      • Token APIs
        • Authentication
        • Single Sign On (SSO)
      • Reward Allocation
        • Create And Allocate Points
        • Bulk Create And Allocate Rewards
        • Get Reward Account Details
        • Get Reward Transaction Details
        • Get User Details
        • Get User Card Details
      • Incentive Allocation
        • Incentive Create And Allocation
        • Get Incentive Transaction details
        • Get User Details
      • 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
        • Overview
        • Create Event
        • Get Event
        • Update Event
        • Allocate Coins
        • Get Balance
  • 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. APIs

Card Usage Controls

POST
/api/v0/partner/enKashCard/velocity/rule
📌
This API enables to set or update limits and checks for a specific card. These controls help manage spending by defining thresholds on the number or value of transactions over a specified time period (e.g., per day, week, or month). This enhances fraud prevention, budget control, and policy enforcement

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 
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.
enKashCardIds
array[string]
required
List of unique identifiers for enKash cards.
>= 1 items<= 100 items
posAllowed
boolean 
optional
Point of sale transaction allowed
onlineAllowed
boolean 
optional
Online transaction allowed.
perTxnLimit
object (JsonNullableBigDecimal) 
optional
Per transaction limit.
present
boolean 
optional
dtd
object (JsonNullableBigDecimal) 
optional
Daily transaction limit.
mtd
object (JsonNullableBigDecimal) 
optional
Monthly transaction limit.
ytd
object (JsonNullableBigDecimal) 
optional
Yearly transaction limit.
mtdCount
object (JsonNullableInteger) 
optional
Monthly transaction count limit.
present
boolean 
optional
dtdCount
object (JsonNullableInteger) 
optional
Daily transaction count limit.
ytdCount
object (JsonNullableInteger) 
optional
Yearly transaction count limit.
adminUser
boolean 
optional
If admin is modifying these limits then this flag should be true, system checks if the user is admin only then it will allow changes.
contactlessAllowed
boolean 
optional
Contactless or tap and pay transactions are allowed or not.
posDailyLimit
object (JsonNullableBigDecimal) 
optional
POS transactions daily limit.
posDailyLimitCount
object (JsonNullableInteger) 
optional
POS daily transaction count limit.
ecomDailyLimit
object (JsonNullableBigDecimal) 
optional
E-commerce transactions daily limit.
ecomDailyLimitCount
object (JsonNullableInteger) 
optional
E-commerce daily transaction count limit.
contactLessDailyLimit
object (JsonNullableBigDecimal) 
optional
Contactless transactions daily limit.
contactLessDailyLimitCount
object (JsonNullableInteger) 
optional
Contactless daily transaction count limit.
autoLoading
boolean 
optional
Auto fund loading on cards enabled or not.
excludeInBulkFunding
boolean 
optional
If this card needs to be excluded in bulk card loading sample file.
overrideAutoLoading
boolean 
optional
If this card needs to have a different amount than the auto-loading amount set at the account level.
overriddenAutoLoadingAmount
number 
optional
Amount which overrides the auto-loading amount set at the account level.
>= 0
Example
{
  "companyId": "CEKEP5GSGP",
  "cardAccountId": "CAA8W45",
  "enKashCardIds" : ["EKC94AEX89"],
  "internationalAllowed": false,
  "posAllowed": true,
  "atmAllowed": false,
  "onlineAllowed": true
}

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/velocity/rule' \
--header 'authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379' \
--header 'partnerId: CRXXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{
  "companyId": "CEKEP5GSGP",
  "cardAccountId": "CAA8W45",
  "enKashCardIds" : ["EKC94AEX89"],
  "internationalAllowed": false,
  "posAllowed": true,
  "atmAllowed": false,
  "onlineAllowed": true
}'

Responses

🟢200OK
application/json
Body
code
integer 
required
message
string 
required
payload
string 
required
Example
{
    "code": 0,
    "message": "Success",
    "payload": "Card settings updated successfully"
}
Previous
View Card Details
Next
Get Card Usage Limits
Built with