SumUp · Schema

Card

__Required when payment type is `card`.__ Details of the payment card.

PaymentsPOSPoint of SaleCard ReadersCheckoutFintechMobile PaymentsOnline Payments

Properties

Name	Type	Description
name	string	Name of the cardholder as it appears on the payment card.
number	string	Number of the payment card (without spaces).
expiry_year	string	Year from the expiration time of the payment card. Accepted formats are `YY` and `YYYY`.
expiry_month	string	Month from the expiration time of the payment card. Accepted format is `MM`.
cvv	string	Three or four-digit card verification value (security code) of the payment card.
zip_code	string	Required five-digit ZIP code. Applicable only to merchant users in the USA.
type	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Card",
  "description": "__Required when payment type is `card`.__ Details of the payment card.",
  "type": "object",
  "properties": {
    "name": {
      "description": "Name of the cardholder as it appears on the payment card.",
      "type": "string",
      "example": "FIRSTNAME LASTNAME",
      "writeOnly": true
    },
    "number": {
      "description": "Number of the payment card (without spaces).",
      "type": "string",
      "example": "1234567890123456",
      "writeOnly": true
    },
    "expiry_year": {
      "description": "Year from the expiration time of the payment card. Accepted formats are `YY` and `YYYY`.",
      "type": "string",
      "example": "2023",
      "maxLength": 4,
      "minLength": 2,
      "writeOnly": true
    },
    "expiry_month": {
      "description": "Month from the expiration time of the payment card. Accepted format is `MM`.",
      "type": "string",
      "enum": [
        "01",
        "02",
        "03",
        "04",
        "05",
        "06",
        "07",
        "08",
        "09",
        "10",
        "11",
        "12"
      ],
      "writeOnly": true
    },
    "cvv": {
      "description": "Three or four-digit card verification value (security code) of the payment card.",
      "type": "string",
      "example": "123",
      "maxLength": 4,
      "minLength": 3,
      "writeOnly": true
    },
    "zip_code": {
      "description": "Required five-digit ZIP code. Applicable only to merchant users in the USA.",
      "type": "string",
      "example": "12345",
      "maxLength": 5,
      "minLength": 5,
      "writeOnly": true
    },
    "type": {
      "$ref": "#/components/schemas/CardType"
    }
  },
  "required": [
    "name",
    "number",
    "expiry_month",
    "expiry_year",
    "cvv",
    "type"
  ]
}