Block

This API is used to block the card, preventing any further transactions from being processed. Use this endpoint to ensure the security of the card in case of loss, theft, or suspicious activity.

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.

enKashCardId

string

required

Unique identifier for the EnKash card.

blockCode

enum<string>

required

Card status after card is blocked. Possible values are L - Locked, UL - Unlocked, BL - Blocked, AP - Activation InProgress.

Allowed values:

LULBLAP

reason

string

optional

Reason for blocking the card.

otpMedium

enum<string>

required

Medium for OTP. Allowed values are MOBILE and MFA.

Allowed values:

MOBILEMFA

otpRequestId

string

optional

Indicates if OTP is required for this operation.

otp

string

optional

OTP received by the user.

createdBy

string

optional

Identifier of the user who created the request.

mfaCode

string

optional

Authenticator code when otpMedium is MFA.

otpRequired

boolean

required

to be passed as false

Example

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Body

code

integer

required

message

string

required

payload

string

required

Example

{
  "code": 0,
  "message": "Success",
  "payload": "Success"
}

Request

Request samples

Responses