View Card

POST/api/v0/partner/enKashCard/viewCard

This API provides information about a specific card, including the cardholder's details, card status and balance. Use this endpoint to retrieve comprehensive data for a particular card.

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

enKashCardId

string

required

Unique identifier for the EnKash card.

otpRequestId

string

optional

Unique identifier for the OTP request.

cardAccountId

string

optional

Unique identifier for the account under company.

otpMedium

enum<string>

required

Medium for OTP verification. Options are "MOBILE" for SMS and "MFA" for Authenticator code

Allowed values:

MOBILEMFA

otp

string

optional

One-Time Password for verification if otpMedium is MOBILE.

mfaCode

string

optional

Multi-Factor Authentication code if otpMedium is MFA

{
  "enKashCardId": "string",
  "otpRequestId": "string",
  "cardAccountId": "string",
  "otpMedium": "MOBILE",
  "otp": "string",
  "mfaCode": "string"
}

Request samples

Responses

OK(200)

HTTP Code: 200

Content Type : JSONapplication/json

enKashCardId

string

optional

userId

string

optional

cardAccountId

string

optional

token

string

optional

maskedNumber

string

optional

expiryMonth

string

optional

expiryYear

string

optional

string

optional

mobile

string

optional

title

string

optional

firstName

string

optional

lastName

string

optional

gender

string

optional

specialDate

string

optional

address

string

optional

address2

string

optional

city

string

optional

state

string

optional

country

string

optional

pincode

string

optional

mtd

number

optional

usedMtd

number

optional

dtd

number

optional

usedDtd

number

optional

ytd

number

optional

usedYtd

number

optional

otbBalance

number

optional

primaryCard

boolean

optional

prepaidCard

boolean

optional

physicalCard

boolean

optional

deleted

boolean

optional

closedLoopCard

boolean

optional

createdOn

string <date-time>

optional

modifiedOn

string <date-time>

optional

cardStatus

object (EnumModel)

optional

name

object

optional

label

string

optional

description

string

optional

subModels

array[object (SubModel)]

optional

minValue

number

optional

maxValue

number

optional

kycStatus

object (EnumModel)

optional

cardProgramme

enum<string>

optional

Allowed values:

FBENKASHSBMMAXIMUSTRANSCORPENKASHFINCARE

idProof

string

optional

addressProof

string

optional

pan

string

optional

useAccountFunds

boolean

optional

blockCode

enum<string>

optional

Allowed values:

AZCDBEFGHIJKLMNOPQRSTUVWXYCOWO

remarks

string

optional

partnerLogo

string

optional

cardKitNumber

string

optional

physicalCardRequestDate

string <date-time>

optional

physicalDeliveryAddressFlag

boolean

optional

deliveryAddress

string

optional

deliveryAddress2

string

optional

deliveryCity

string

optional

deliveryState

string

optional

deliveryCountry

string

optional

deliveryPincode

string

optional

cardActivated

boolean

optional

binType

object (EnumModel)

optional

shareCode

string

optional

kycReason

string

optional

loadAmount

number

optional

companyId

string

optional

middleName

string

optional

cardKitMasterId

integer <int64>

optional

extEntityId

string

optional

switchProvider

enum<string>

optional

Allowed values:

M2PMAXIMUSEK_CLOSEDLOOP_CREDITM2P_TRANSCORPM2P_FINCARE

kycSubmittedOn

string <date-time>

optional

kycType

object (EnumModel)

optional

accountBalance

number

optional

physicalCardAllowed

boolean

optional

kitType

object (EnumModel)

optional

surchargeAmt

number

optional

panValidated

boolean

optional

invoiceNumber

string

optional

usedLtd

number

optional

latestTnCVersionAccepted

boolean

optional

latestKeyFactAccepted

boolean

optional

latestTnCVersionAcceptedForPrimaryCard

boolean

optional

latestKeyFactAcceptedCardForPrimaryCard

boolean

optional

tncVersionMasterId

string

optional

tncVersion

string

optional

tncUrl

string

optional

keyFactSheetUrl

string

optional

acceptanceByDate

string <date-time>

optional

primaryEnKashCardId

string

optional

primaryEnKashCardUserId

string

optional

virtualAccountNumber

string

optional

limitAllocatedLtd

number

optional

posAllowed

boolean

optional

posAllowedAdmin

boolean

optional

atmAllowed

boolean

optional

atmAllowedAdmin

boolean

optional

onlineAllowed

boolean

optional

onlineAllowedAdmin

boolean

optional

ckycNumber

string

optional

liveImage

boolean

optional

livenessScore

number

optional

faceMatch

string

optional

faceMatchScore

number

optional

ckycAccountType

string

optional

unallocateFundAllowed

boolean

optional

useParentFundAllowed

boolean

optional

defaultCardImage

string

optional

vcipLink

string

optional

qrImageUrl

string

optional

vcipId

string

optional

minKycOtpVerified

boolean

optional

kycSubStatus

object (EnumModel)

optional

enKashSupportEmail

string

optional

enKashSupportMobile

string

optional

companyName

string

optional

accountType

object (EnumModel)

optional

lastAllocatedAmount

number

optional

holdBalance

number

optional

enableHoldAmount

boolean

optional

enkashCardTxnId

string

optional

unAllocateHoldBalance

number

optional

tncUnAllocateAllowed

boolean

optional

tncUnAllocateAccepted

boolean

optional

minTransactionAmount

number

optional

totalRewardsReceived

integer <int32>

optional

latestRewardType

enum<string>

optional

Allowed values:

OCCASIONPERFORMANCE

rewardPointsReceived

number

optional

vkycAllowed

boolean

optional

ckycEnabled

boolean

optional

Not configured

Last modified: 5 months ago