---
title: "ProcessCheckoutSchema"
description: "Request body for attempting payment on an existing checkout. The required companion fields depend on the selected `payment_type`, for example card details, saved-card data, or payer information required by a specific payment method."
image: "https://developer.sumup.com/og/index.png"
---

> Documentation Index
> Fetch the complete documentation index at: https://developer.sumup.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: SumUp REST API

Request body for attempting payment on an existing checkout. The required companion fields depend on the selected `payment_type`, for example card details, saved-card data, or payer information required by a specific payment method.

## Fields

- `payment_type` (`ProcessCheckoutSchema.payment_type`; string, required) — Payment method used for this processing attempt. It determines which additional request fields are required.
  - one of `"card"`, `"boleto"`, `"ideal"`, `"blik"`, `"bancontact"`, `"google_pay"`, `"apple_pay"`; example `"card"`
- `installments` (`ProcessCheckoutSchema.installments`; integer, optional) — Number of installments for deferred payments. Available only to merchant users in Brazil.
  - min 1; max 12; example `1`
- `mandate` (`ProcessCheckoutSchema.mandate`; object, optional) — Mandate details used when a checkout should create a reusable card token for future recurring or merchant-initiated payments.
  - example `{"type":"recurrent","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.104 Safari/537.36","user_ip":"172.217.169.174"}`
  - `type` (`ProcessCheckoutSchema.mandate.type`; string, required) — Type of mandate to create for the saved payment instrument.
    - one of `"recurrent"`; example `"recurrent"`
  - `user_agent` (`ProcessCheckoutSchema.mandate.user_agent`; string, required) — Browser or client user agent observed when consent was collected.
    - example `"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.104 Safari/537.36"`
  - `user_ip` (`ProcessCheckoutSchema.mandate.user_ip`; string, optional) — IP address of the payer when the mandate was accepted.
    - example `"172.217.169.174"`
- `card` (`ProcessCheckoutSchema.card`; object, optional) — __Required when payment type is `card`.__ Details of the payment card.
  - `name` (`ProcessCheckoutSchema.card.name`; string, required) — Name of the cardholder as it appears on the payment card.
    - example `"FIRSTNAME LASTNAME"`
  - `number` (`ProcessCheckoutSchema.card.number`; string, required) — Number of the payment card (without spaces).
    - example `"1234567890123456"`
  - `expiry_year` (`ProcessCheckoutSchema.card.expiry_year`; string, required) — Two- or four-digit expiration year in `YY` or `YYYY` format.
    - pattern `^[0-9]{2}([0-9]{2})?$`; example `"2030"`
  - `expiry_month` (`ProcessCheckoutSchema.card.expiry_month`; string, required) — Two-digit expiration month, from `01` through `12`.
    - minLength 2; maxLength 2; pattern `^(0[1-9]|1[0-2])$`; example `"12"`
  - `cvv` (`ProcessCheckoutSchema.card.cvv`; string, required) — Three or four-digit card verification value (security code) of the payment card.
    - minLength 3; maxLength 4; example `"123"`
  - `type` (`ProcessCheckoutSchema.card.type`; string, required) — Issuing card network of the payment card used for the transaction.
    - one of `"ALELO"`, `"AMEX"`, `"BANCOMAT"`, `"CONECS"`, `"CUP"`, `"DINERS"`, `"DISCOVER"`, `"EFTPOS"`, `"ELO"`, `"ELV"`, `"GIROCARD"`, `"HIPERCARD"`, `"INTERAC"`, `"JCB"`, `"MAESTRO"`, `"MASTERCARD"`, `"PLUXEE"`, `"SUMUP"`, `"SWILE"`, `"TICKET"`, `"VISA"`, `"VISA_ELECTRON"`, `"VISA_VPAY"`, `"VPAY"`, `"VR"`, `"UNKNOWN"`; example `"VISA"`
  - `zip_code` (`ProcessCheckoutSchema.card.zip_code`; string, optional) — Required five-digit ZIP code. Applicable only to merchant users in the USA.
    - minLength 5; maxLength 5; example `"12345"`
- `google_pay` (`ProcessCheckoutSchema.google_pay`; object, optional) — Raw `PaymentData` object received from Google Pay. Send the Google Pay response payload as-is.
  - example `{"apiVersionMinor":0,"apiVersion":2,"paymentMethodData":{"description":"Visa •••• 1111","tokenizationData":{"type":"PAYMENT_GATEWAY","token":"token-data"},"type":"CARD","info":{"cardNetwork":"VISA","cardDetails":"1111"}}}`
- `apple_pay` (`ProcessCheckoutSchema.apple_pay`; object, optional) — Raw payment token object received from Apple Pay. Send the Apple Pay response payload as-is.
  - example `{"token":{"paymentData":{"data":"si2xuT2ArQo689SfE-long-token","signature":"MIAGCSqGSIb3DQEHA-long-signature","header":{"publicKeyHash":"PWfjDi3TSwgZ20TY/A7f3V6J/1rhHyRDCspbeljM0io=","ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEaBtz7UN2MNV0qInJVEEhXy10PU0KfO6KxFjXm93oKWL6lCsxZZGDl/EKioUHVSlKgpsKGin0xvgldfxeJVgy0g==","transactionId":"62e0568bc9258e9d0e059d745650fc8211d05ef7a7a1589a6411bf9b12cdfd04"},"version":"EC_v1"},"paymentMethod":{"displayName":"MasterCard 8837","network":"MasterCard","type":"debit"},"transactionIdentifier":"62E0568BC9258E9D0E059D745650FC8211D05EF7A7A1589A6411BF9B12CDFD04"}}`
- `token` (`ProcessCheckoutSchema.token`; string, optional) — Token of a saved payment instrument returned by checkout processing or the customer's payment-instruments endpoint. To charge a saved card, set `payment_type` to `card` and provide both this `token` and the associated `customer_id` instead of raw card details.
  - example `"ba85dfee-c3cf-48a6-84f5-d7d761fbba50"`
- `customer_id` (`ProcessCheckoutSchema.customer_id`; string, optional) — Customer identifier associated with the saved payment instrument. Required when `token` is provided.
  - example `"MEDKHDTI"`
- `personal_details` (`ProcessCheckoutSchema.personal_details`; object, optional) — Personal details for the customer.
  - `first_name` (`ProcessCheckoutSchema.personal_details.first_name`; string, optional) — First name of the customer.
    - example `"John"`
  - `last_name` (`ProcessCheckoutSchema.personal_details.last_name`; string, optional) — Last name of the customer.
    - example `"Doe"`
  - `email` (`ProcessCheckoutSchema.personal_details.email`; string, optional) — Email address of the customer.
    - example `"user@example.com"`
  - `phone` (`ProcessCheckoutSchema.personal_details.phone`; string, optional) — Phone number of the customer.
    - example `"+491635559723"`
  - `birth_date` (`ProcessCheckoutSchema.personal_details.birth_date`; string, optional) — Date of birth of the customer in `YYYY-MM-DD` format, without a time or timezone.
    - format `date`; example `"1993-12-31"`
  - `tax_id` (`ProcessCheckoutSchema.personal_details.tax_id`; string, optional) — Identification number used for tax purposes, such as a CPF in Brazil.
    - maxLength 255; example `"423.378.593-47"`
  - `address` (`ProcessCheckoutSchema.personal_details.address`; object, optional) — Profile's personal address information.
    - `city` (`ProcessCheckoutSchema.personal_details.address.city`; string, optional) — City name from the address.
      - example `"Berlin"`
    - `country` (`ProcessCheckoutSchema.personal_details.address.country`; string, optional) — Two letter country code formatted according to [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
      - example `"DE"`
    - `line_1` (`ProcessCheckoutSchema.personal_details.address.line_1`; string, optional) — First line of the address with details of the street name and number.
      - example `"Sample street"`
    - `line_2` (`ProcessCheckoutSchema.personal_details.address.line_2`; string, optional) — Second line of the address with details of the building, unit, apartment, and floor numbers.
      - example `"ap. 5"`
    - `postal_code` (`ProcessCheckoutSchema.personal_details.address.postal_code`; string, optional) — Postal code from the address.
      - example `"10115"`
    - `state` (`ProcessCheckoutSchema.personal_details.address.state`; string, optional) — State name or abbreviation from the address.
      - example `"Berlin"`


Source: https://developer.sumup.com/api/schemas/ProcessCheckoutSchema/index.md
