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

Card Details — Get by ID or Token

Returns one card’s full details when either cardId or token is provided. At least one must be present; providing both is allowed.

POST{gateway}/pcs/api/v1/cards/details

Payload

AttributeTypeRequiredDescription
cardIdIntegerConditionalUnique ID of the card. Required if token not provided.
tokenIntegerConditionalCard token (PAN surrogate). Required if cardId not provided.
Request Example
{
  "cardId": 17
}

Response

AttributeTypeDescription
data.idIntegerCard ID.
data.userIdIntegerOwner (user) ID.
data.cardIssuerConfigIdIntegerIssuer configuration reference.
data.userProfileObjectBasic profile of the cardholder.
data.userProfile.idIntegerProfile ID.
data.userProfile.pronounTitleStringTitle (e.g., Mr, Ms).
data.userProfile.firstNameStringFirst name.
data.userProfile.lastNameStringLast name.
data.userProfile.emailStringEmail address.
data.userProfile.countryCodeStringDial code (e.g., 92).
data.userProfile.phoneStringPhone number.
data.userProfile.languageStringPreferred language.
data._3dSecureObject3DS configuration for the card.
data._3dSecure.idInteger3DS record ID.
data._3dSecure.configIdInteger3DS config reference.
data._3dSecure.statusBooleanWhether 3DS is enabled.
data.accountObjectLinked funding account details.
data.account.idIntegerInternal record ID.
data.account.accountIdIntegerAccount ID.
data.account.userIdIntegerAccount owner user ID.
data.account.accountTypeStringAccount type (e.g., DIGITAL).
data.account.currencyCodeStringAccount currency (e.g., AED).
data.account.accountTitleStringAccount title/name.
data.account.accountNumberStringAccount number.
data.account.ibanStringIBAN of the account.
data.cardTierObjectCard tier (product) flags.
data.cardTier.idIntegerCard tier ID.
data.cardTier.enableFraudRulesBooleanFraud rules enabled.
data.cardTier.enableLimitsBooleanSpending limits enabled.
data.activationObjectActivation status details.
data.activation.idIntegerActivation record ID.
data.activation.activationModeStringActivation mode (e.g., APP_ACTIVATION).
data.activation.activationDateString (ISO 8601)Activation date-time.
data.activation.statusBooleanWhether card is active.
data.manufacturingObjectManufacturing lifecycle details.
data.manufacturing.idIntegerManufacturing record ID.
data.manufacturing.configIdIntegerManufacturer config ref.
data.manufacturing.estimatedManufacturingTimeString (ISO 8601)Estimated manufacturing time.
data.manufacturing.statusStringManufacturing status (e.g., MANUFACTURED).
data.deliveryObjectDelivery lifecycle details.
data.delivery.idIntegerDelivery record ID.
data.delivery.configIdIntegerDelivery partner config ref.
data.delivery.statusStringDelivery status (e.g., DELIVERED).
data.delivery.estimatedDeliveryTimeString (ISO 8601)Estimated delivery time.
data.delivery.addressObjectDelivery address.
data.paymentCardTypeStringDEBIT / CREDIT / PREPAID.
data.cardNetworkStringNetwork (e.g., MASTERCARD).
data.cardTypeStringPHYSICAL / VIRTUAL.
data.billingCurrencyStringBilling currency (e.g., AED).
data.embossNameStringEmbossed name on card.
data.lastFourDigitsStringLast four digits of PAN.
data.tokenIntegerCard token.
data.tokenFlagsStringToken flag bitmask.
data.pinSetBooleanWhether PIN is set.
data.statusStringCard status (e.g., ACTIVE).
data.cardTextStringHuman-readable status text.
data.maxPurchaseLimitNumberMax purchase limit.
data.remarksStringOperational remarks.
data.statusReasonStringStatus reason (if any).
data.cardCategoryStringCard category (e.g., STANDARD).
data.consumerTypeStringCONSUMER / CORPORATE.
data.reportedCardsArrayRelated reports (e.g., lost/stolen).
data.processedAtThirdPartyBooleanWhether processed at third party.
data.apiCallUniqueIdentifierString (UUID)API call trace identifier.
data.createdAtString (ISO 8601)Record creation timestamp.
data.updatedAtString (ISO 8601)Record update timestamp.
data.cardHolderNameStringFull name of cardholder.
data.cardTokensArrayAdditional tokens (if any).
200 — SUCCESS
{
  "data": {
    "id": 17,
    "userId": 640,
    "cardIssuerConfigId": 1,
    "userProfile": {
      "id": 17,
      "pronounTitle": "Mr",
      "firstName": "Gulraiz",
      "lastName": "Khalil",
      "email": "gulraiz.user@mailinator.com",
      "countryCode": "92",
      "phone": "3075061400",
      "language": "ENGLISH"
    },
    "_3dSecure": { "id": 18, "configId": 9, "status": false },
    "account": {
      "id": 17,
      "accountId": 43,
      "userId": 640,
      "accountType": "DIGITAL",
      "currencyCode": "AED",
      "accountTitle": "GULRAIZ KHALIL",
      "accountNumber": "1000648060000903",
      "iban": "AE470961000648060000903"
    },
    "cardTier": { "id": 1, "enableFraudRules": false, "enableLimits": true },
    "activation": {
      "id": 12,
      "activationMode": "APP_ACTIVATION",
      "activationDate": "2025-01-23T07:35:37.685+00:00",
      "status": true
    },
    "manufacturing": {
      "id": 8,
      "configId": 2,
      "estimatedManufacturingTime": "2025-01-23T12:00:00",
      "status": "MANUFACTURED"
    },
    "delivery": {
      "id": 8,
      "configId": 3,
      "status": "DELIVERED",
      "estimatedDeliveryTime": "2025-01-23T12:00:00",
      "address": {
        "id": 17,
        "country": "Afghanistan",
        "state": "Badakhshan",
        "city": "Ashkāsham",
        "addressLine1": "bjkasdhia",
        "addressLine2": "",
        "type": "MAILING",
        "postalCode": "45000"
      }
    },
    "paymentCardType": "DEBIT",
    "cardNetwork": "MASTERCARD",
    "cardType": "PHYSICAL",
    "billingCurrency": "AED",
    "embossName": "Saad",
    "lastFourDigits": "8595",
    "token": 757129776,
    "tokenFlags": "00010000000000000000000000000000",
    "pinSet": true,
    "status": "ACTIVE",
    "cardText": "Your card is active",
    "maxPurchaseLimit": 100,
    "remarks": "Accepted",
    "statusReason": "",
    "cardCategory": "STANDARD",
    "consumerType": "CONSUMER",
    "reportedCards": [],
    "processedAtThirdParty": true,
    "apiCallUniqueIdentifier": "f9757919-086d-491e-88cd-05fbb2932d07",
    "createdAt": "2025-01-23T07:19:30.147+00:00",
    "updatedAt": "2025-02-06T07:26:45.843+00:00",
    "cardHolderName": "Gulraiz Khalil",
    "cardTokens": []
  }
}
422 — FAILED
{
  "code": 1000,
  "message": "Invalid payload. Please check your request.",
  "type": "INVALID_PAYLOAD",
  "errors": [
    {
      "key": "cardId",
      "reason": "Invalid card ID or token provided."
    }
  ]
}