🚀 VaultsPay API v1 is live. See what's new →
Payment CardsCard Tier Listing

Card Tier Listing — Configured Card Products

This API returns all Card Products (Card Tiers) configured for the requesting VaultsPay Admin account as per the agreed contract terms. Each Card Tier represents a product configuration defining its network, currency, type, and operational limits.

You may request to configure additional Card Tiers based on evolving business or customer requirements, subject to contractual terms and approval.

Limitations: The data is read-only and reflects the configurations already approved and active in the system.

GET{gateway}/pcs/api/v1/card-tiers

Payload

This endpoint does not require a payload or query parameters.

Response

AttributeTypeDescription
dataArray<Object>List of configured card tiers.
data[].idIntegerUnique ID of the card tier.
data[].cardCategoryStringCategory of the card (e.g., STANDARD, PREMIUM).
data[].consumerTypeStringDefines whether the card is for CONSUMER or CORPORATE users.
data[].titleStringDisplay title or name of the card tier.
data[].descriptionStringMarketing or informational description of the card product.
data[].userIdIntegerID of the admin user who configured the card tier.
data[].cardNetworkStringNetwork provider (e.g., VISA, MASTERCARD).
data[].paymentCardTypeStringCard type, e.g., CREDIT, DEBIT, or PREPAID.
data[].cardTypesStringAvailable card formats (PHYSICAL, VIRTUAL, or both).
data[].billingCurrencyCodeStringBilling currency code (e.g., AED).
data[].settlementCurrencyCodeStringSettlement currency code.
data[].expiryPeriodIntegerExpiry period in months or years (as configured).
data[].cardStackSizeIntegerTotal card stack size per batch.
data[].cardLimitIntegerMaximum number of cards allowed under this tier.
data[].cardStockMinimumThresholdIntegerThreshold for card stock reordering.
data[].enableAutoRenewalCardBooleanEnables automatic card renewal.
data[].is3DSBooleanIndicates whether 3D Secure is enabled.
data[].isEnableLimitsBooleanEnables spending limits for this tier.
data[].isEnableFraudRulesBooleanEnables fraud detection rules.
data[].blockCardPinRetriesIntegerNumber of allowed PIN retries before blocking.
data[].cardIssuerConfigIdIntegerReference to card issuer configuration.
data[].cardManufacturerConfigIdIntegerReference to card manufacturer configuration.
data[].deliveryPartnerConfigIdIntegerReference to delivery partner configuration.
data[].threeDimensionSecureConfigIdIntegerReference to 3DS configuration.
data[].cardTierBillingMethodStringBilling method for the card tier (e.g., ACCOUNT).
data[].cardLanguageStringLanguage used on card materials.
data[].statusBooleanIndicates if the card tier is active.
data[].cardMaterialTypeStringCard material type (e.g., PLASTIC, METAL).
data[].binRangeObjectBIN range details (if configured).
data[].binRange.idIntegerBIN configuration ID.
data[].binRange.minRangeIntegerMinimum BIN number in range.
data[].binRange.maxRangeIntegerMaximum BIN number in range.
data[].binRange.productTypeStringProduct type linked to BIN (e.g., DEBIT).
data[].binRange.providerStringBIN provider type (e.g., BANK).
data[].binRange.schemeStringBIN scheme or network (e.g., MASTERCARD).
data[].binRange.currencyCodeStringCurrency of BIN configuration.
data[].binRange.countryIdIntegerCountry ID linked to BIN.
paginationObjectPagination details of the response.
pagination.currentPageIntegerCurrent page number.
pagination.perPageIntegerNumber of records per page.
pagination.totalPagesIntegerTotal pages available.
pagination.totalCountIntegerTotal number of configured card tiers.
pagination.sortStringSorting order applied.
200 — SUCCESS
{
  "data": [
    {
      "id": 535,
      "cardCategory": "STANDARD",
      "consumerType": "CONSUMER",
      "title": "abcd",
      "description": "Unlock premium privileges with VaultsPay Executive by Mastercard...",
      "userId": 2390,
      "cardNetwork": "VISA",
      "paymentCardType": "CREDIT",
      "cardTypes": "PHYSICAL",
      "billingCurrencyCode": "AED",
      "settlementCurrencyCode": "AED",
      "expiryPeriod": 10,
      "cardStackSize": 60,
      "cardLimit": 50,
      "cardStockMinimumThreshold": 5,
      "enableAutoRenewalCard": false,
      "is3DS": false,
      "isEnableLimits": false,
      "isEnableFraudRules": false,
      "blockCardPinRetries": 0,
      "cardIssuerConfigId": 32,
      "cardManufacturerConfigId": 38,
      "deliveryPartnerConfigId": 3,
      "threeDimensionSecureConfigId": 8,
      "cardTierBillingMethod": "ACCOUNT",
      "cardLanguage": "ENGLISH",
      "status": true,
      "cardMaterialType": "PLASTIC"
    },
    {
      "id": 534,
      "cardCategory": "STANDARD",
      "consumerType": "CONSUMER",
      "title": "VaultsPay Executive Credit -1",
      "description": "Unlock premium privileges with VaultsPay Executive by Mastercard...",
      "userId": 4,
      "cardNetwork": "MASTERCARD",
      "paymentCardType": "CREDIT",
      "cardTypes": "PHYSICAL,VIRTUAL",
      "billingCurrencyCode": "AED",
      "settlementCurrencyCode": "AED",
      "expiryPeriod": 40,
      "cardStackSize": 100,
      "cardLimit": 50,
      "cardStockMinimumThreshold": 5,
      "enableAutoRenewalCard": true,
      "is3DS": true,
      "isEnableLimits": true,
      "isEnableFraudRules": true,
      "blockCardPinRetries": 0,
      "cardIssuerConfigId": 32,
      "cardManufacturerConfigId": 44,
      "deliveryPartnerConfigId": 3,
      "threeDimensionSecureConfigId": 8,
      "cardTierBillingMethod": "ACCOUNT",
      "cardLanguage": "ENGLISH",
      "status": true,
      "binRange": {
        "id": 3,
        "minRange": 100000,
        "maxRange": 200000,
        "productType": "DEBIT",
        "provider": "BANK",
        "scheme": "MASTERCARD",
        "currencyCode": "AED",
        "countryId": 231
      },
      "minRange": 100000,
      "maxRange": 200000,
      "cardMaterialType": "PLASTIC"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "perPage": 20,
    "totalPages": 26,
    "totalCount": 506,
    "sort": "id: DESC"
  }
}