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
| Attribute | Type | Description |
|---|---|---|
| data | Array<Object> | List of configured card tiers. |
| data[].id | Integer | Unique ID of the card tier. |
| data[].cardCategory | String | Category of the card (e.g., STANDARD, PREMIUM). |
| data[].consumerType | String | Defines whether the card is for CONSUMER or CORPORATE users. |
| data[].title | String | Display title or name of the card tier. |
| data[].description | String | Marketing or informational description of the card product. |
| data[].userId | Integer | ID of the admin user who configured the card tier. |
| data[].cardNetwork | String | Network provider (e.g., VISA, MASTERCARD). |
| data[].paymentCardType | String | Card type, e.g., CREDIT, DEBIT, or PREPAID. |
| data[].cardTypes | String | Available card formats (PHYSICAL, VIRTUAL, or both). |
| data[].billingCurrencyCode | String | Billing currency code (e.g., AED). |
| data[].settlementCurrencyCode | String | Settlement currency code. |
| data[].expiryPeriod | Integer | Expiry period in months or years (as configured). |
| data[].cardStackSize | Integer | Total card stack size per batch. |
| data[].cardLimit | Integer | Maximum number of cards allowed under this tier. |
| data[].cardStockMinimumThreshold | Integer | Threshold for card stock reordering. |
| data[].enableAutoRenewalCard | Boolean | Enables automatic card renewal. |
| data[].is3DS | Boolean | Indicates whether 3D Secure is enabled. |
| data[].isEnableLimits | Boolean | Enables spending limits for this tier. |
| data[].isEnableFraudRules | Boolean | Enables fraud detection rules. |
| data[].blockCardPinRetries | Integer | Number of allowed PIN retries before blocking. |
| data[].cardIssuerConfigId | Integer | Reference to card issuer configuration. |
| data[].cardManufacturerConfigId | Integer | Reference to card manufacturer configuration. |
| data[].deliveryPartnerConfigId | Integer | Reference to delivery partner configuration. |
| data[].threeDimensionSecureConfigId | Integer | Reference to 3DS configuration. |
| data[].cardTierBillingMethod | String | Billing method for the card tier (e.g., ACCOUNT). |
| data[].cardLanguage | String | Language used on card materials. |
| data[].status | Boolean | Indicates if the card tier is active. |
| data[].cardMaterialType | String | Card material type (e.g., PLASTIC, METAL). |
| data[].binRange | Object | BIN range details (if configured). |
| data[].binRange.id | Integer | BIN configuration ID. |
| data[].binRange.minRange | Integer | Minimum BIN number in range. |
| data[].binRange.maxRange | Integer | Maximum BIN number in range. |
| data[].binRange.productType | String | Product type linked to BIN (e.g., DEBIT). |
| data[].binRange.provider | String | BIN provider type (e.g., BANK). |
| data[].binRange.scheme | String | BIN scheme or network (e.g., MASTERCARD). |
| data[].binRange.currencyCode | String | Currency of BIN configuration. |
| data[].binRange.countryId | Integer | Country ID linked to BIN. |
| pagination | Object | Pagination details of the response. |
| pagination.currentPage | Integer | Current page number. |
| pagination.perPage | Integer | Number of records per page. |
| pagination.totalPages | Integer | Total pages available. |
| pagination.totalCount | Integer | Total number of configured card tiers. |
| pagination.sort | String | Sorting 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"
}
}