Retrieve sensitive details for a Card

v1.0.0

Input

{
  "type": "object",
  "properties": {
    "card_id": {
      "type": "string",
      "description": "The identifier of the Card to retrieve details for."
    }
  },
  "required": [
    "card_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "An object containing the sensitive details (card number, cvc, etc) for a Card.",
  "required": [
    "card_id",
    "expiration_month",
    "expiration_year",
    "primary_account_number",
    "type",
    "verification_code"
  ],
  "properties": {
    "card_id": {
      "type": "string",
      "description": "The identifier for the Card for which sensitive details have been returned."
    },
    "expiration_month": {
      "type": "integer",
      "description": "The month the card expires in M format (e.g., August is 8)."
    },
    "expiration_year": {
      "type": "integer",
      "description": "The year the card expires in YYYY format (e.g., 2025)."
    },
    "primary_account_number": {
      "type": "string",
      "description": "The card number."
    },
    "type": {
      "type": "string",
      "description": "A constant representing the object's type. For this resource it will always be `card_details`.",
      "enum": [
        "card_details"
      ]
    },
    "verification_code": {
      "type": "string",
      "description": "The three-digit verification code for the card. It's also known as the Card Verification Code (CVC), the Card Verification Value (CVV), or the Card Identification (CID)."
    }
  }
}