Update Card Velocity Rules

POST

/api/v0/partner/enKashCard/velocity/rule

Card Partner Apis

This API allows you to set or update velocity rules for cards to control transaction 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

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": "string",
    "cardAccountId": "string",
    "enKashCardIds": [
        "string"
    ],
    "posAllowed": true,
    "onlineAllowed": true,
    "perTxnLimit": {
        "present": true
    },
    "dtd": {
        "present": true
    },
    "mtd": {
        "present": true
    },
    "ytd": {
        "present": true
    },
    "mtdCount": {
        "present": true
    },
    "dtdCount": {
        "present": true
    },
    "ytdCount": {
        "present": true
    },
    "adminUser": true,
    "contactlessAllowed": true,
    "posDailyLimit": {
        "present": true
    },
    "posDailyLimitCount": {
        "present": true
    },
    "ecomDailyLimit": {
        "present": true
    },
    "ecomDailyLimitCount": {
        "present": true
    },
    "contactLessDailyLimit": {
        "present": true
    },
    "contactLessDailyLimitCount": {
        "present": true
    },
    "autoLoading": true,
    "excludeInBulkFunding": true,
    "overrideAutoLoading": true,
    "overriddenAutoLoadingAmount": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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": "string",
    "cardAccountId": "string",
    "enKashCardIds": [
        "string"
    ],
    "posAllowed": true,
    "onlineAllowed": true,
    "perTxnLimit": {
        "present": true
    },
    "dtd": {
        "present": true
    },
    "mtd": {
        "present": true
    },
    "ytd": {
        "present": true
    },
    "mtdCount": {
        "present": true
    },
    "dtdCount": {
        "present": true
    },
    "ytdCount": {
        "present": true
    },
    "adminUser": true,
    "contactlessAllowed": true,
    "posDailyLimit": {
        "present": true
    },
    "posDailyLimitCount": {
        "present": true
    },
    "ecomDailyLimit": {
        "present": true
    },
    "ecomDailyLimitCount": {
        "present": true
    },
    "contactLessDailyLimit": {
        "present": true
    },
    "contactLessDailyLimitCount": {
        "present": true
    },
    "autoLoading": true,
    "excludeInBulkFunding": true,
    "overrideAutoLoading": true,
    "overriddenAutoLoadingAmount": 0
}'

Responses

🟢200OK

application/json

Body

string

optional

Example

"string"

Update Card balance

Get Card Velocity Rules