Get Card Account

POST/api/v0/partner/enKashCard/cardAccount/get

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

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

{
  "companyId": "string",
  "companyName": "string",
  "cardAccountId": "string",
  "cardAccountIds": [
    "string"
  ],
  "companyIds": [
    "string"
  ],
  "userGroupIds": [
    "string"
  ],
  "filter": "string",
  "closedLoopCard": true,
  "binType": "PREPAID",
  "createdOnFrom": "2019-08-24T14:15:22.123Z",
  "createdOnTo": "2019-08-24T14:15:22.123Z",
  "creditProviderId": "string"
}

Request samples

Responses

OK(200)

HTTP Code: 200

Content Type : JSONapplication/json

cardAccountId

string

optional

companyId

string

optional

companyName

string

optional

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:

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

object

optional

label

string

optional

description

string

optional

subModels

array[object (SubModel)]

optional

minValue

number

optional

maxValue

number

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

Match pattern:

^R[0-9]{9}$

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

Not configured

Last modified: 5 months ago