PayPal · Schema

Card

The payment card to use to fund a payment. Can be a credit or debit card.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name Type Description
id string The PayPal-generated ID for the card.
name string The card holder's name as it appears on the card.
number string The primary account number (PAN) for the payment card.
expiry object The card expiration year and month, in [Internet date format](https://tools.ietf.org/html/rfc3339#section-5.6).
security_code string The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID. This parameter cannot be present in the request when `payment_initiator=MERCHANT`.
last_digits string The last digits of the payment card.
card_type object The card brand or network. Typically used in the response.
billing_address object The billing address for this card. Supports only the `address_line_1`, `address_line_2`, `admin_area_1`, `admin_area_2`, `postal_code`, and `country_code` properties.
View JSON Schema on GitHub

JSON Schema

paypal-card-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/card",
  "title": "Card",
  "type": "object",
  "description": "The payment card to use to fund a payment. Can be a credit or debit card.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The PayPal-generated ID for the card.",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "description": "The card holder's name as it appears on the card.",
      "maxLength": 300
    },
    "number": {
      "type": "string",
      "description": "The primary account number (PAN) for the payment card.",
      "minLength": 13,
      "maxLength": 19
    },
    "expiry": {
      "description": "The card expiration year and month, in [Internet date format](https://tools.ietf.org/html/rfc3339#section-5.6).",
      "$ref": "#/components/schemas/date_year_month"
    },
    "security_code": {
      "type": "string",
      "description": "The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID. This parameter cannot be present in the request when `payment_initiator=MERCHANT`.",
      "pattern": "[0-9]{3,4}"
    },
    "last_digits": {
      "type": "string",
      "description": "The last digits of the payment card.",
      "pattern": "[0-9]{2,}",
      "readOnly": true
    },
    "card_type": {
      "description": "The card brand or network. Typically used in the response.",
      "readOnly": true,
      "$ref": "#/components/schemas/card_brand"
    },
    "billing_address": {
      "description": "The billing address for this card. Supports only the `address_line_1`, `address_line_2`, `admin_area_1`, `admin_area_2`, `postal_code`, and `country_code` properties.",
      "$ref": "#/components/schemas/address_portable"
    }
  },
  "required": [
    "number",
    "expiry"
  ]
}