---
title: "CreateReaderCheckoutRequest"
description: "Payment details for a Reader Checkout.\n"
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

Payment details for a Reader Checkout.

## Fields

- `total_amount` (`CreateReaderCheckoutRequest.total_amount`; object, required) — Amount structure. The amount is represented as an integer value altogether with the currency and the minor unit. For example, EUR 1.00 is represented as value 100 with minor unit of 2.
  - example `{"currency":"EUR","minor_unit":2,"value":1000}`
  - `currency` (`CreateReaderCheckoutRequest.total_amount.currency`; string, required) — Currency ISO 4217 code
    - example `"EUR"`
  - `minor_unit` (`CreateReaderCheckoutRequest.total_amount.minor_unit`; integer, required) — The minor units of the currency. It represents the number of decimals of the currency. For the currencies CLP, COP and HUF, the minor unit is 0.
    - min 0; example `2`
  - `value` (`CreateReaderCheckoutRequest.total_amount.value`; integer, required) — Integer value of the amount.
    - min 0; example `1000`
- `aade` (`CreateReaderCheckoutRequest.aade`; object, optional) — Optional object containing data for transactions from ERP integrators in Greece that comply with the AADE 1155 protocol. When such regulatory/business requirements apply, this object must be provided and contains the data needed to validate the transaction with the AADE signature provider.
  - `provider_id` (`CreateReaderCheckoutRequest.aade.provider_id`; string, required) — The identifier of the AADE signature provider.
    - example `"123"`
  - `signature` (`CreateReaderCheckoutRequest.aade.signature`; string, required) — The base64 encoded signature of the transaction data.
    - example `"QjcxRDdBNTU1MDcyRTNFRTREMkZEM0Y0NTdBMjkxMTU4MzBFNkNCQTs7MjAyNTExMTIyMTQ3MTM7Nzk2OzEwNDs5MDA7OTAwOzU0ODg5MDM5"`
  - `signature_data` (`CreateReaderCheckoutRequest.aade.signature_data`; string, required) — The string containing the signed transaction data.
    - example `"B71D7A555072E3EE4D2FD3F457A29115830E6CBA;;20251112214713;796;104;900;900;54889039"`
- `affiliate` (`CreateReaderCheckoutRequest.affiliate`; object, optional, nullable) — Optional affiliate metadata associated with the checkout's payment. Provide both `app_id` and `key` when including this object.
  - `app_id` (`CreateReaderCheckoutRequest.affiliate.app_id`; string, required) — Integrator application identifier from the [Affiliate Keys](https://developer.sumup.com/affiliate-keys) page. Required when the affiliate object is provided.
    - example `"com.example.app"`
  - `key` (`CreateReaderCheckoutRequest.affiliate.key`; string, required) — Affiliate key generated in the [Affiliate Keys](https://developer.sumup.com/affiliate-keys) page. Required when the affiliate object is provided.
    - example `"123e4567-e89b-12d3-a456-426614174000"`
  - `foreign_transaction_id` (`CreateReaderCheckoutRequest.affiliate.foreign_transaction_id`; string, optional) — Integrator-owned transaction reference. Optional. Can be used to retrieve the transaction via the [Transactions API](https://developer.sumup.com/api/transactions/get).
    - example `"19e12390-72cf-4f9f-80b5-b0c8a67fa43f"`
  - `tags` (`CreateReaderCheckoutRequest.affiliate.tags`; object, optional) — Optional key-value metadata associated with the transaction.
    - example `{"custom_key_1":"custom_value_1","custom_key_2":"custom_value_2"}`
- `card_type` (`CreateReaderCheckoutRequest.card_type`; string, optional) — The card type of the card used for the transaction. It is required only for some countries (e.g: Brazil).
  - one of `"credit"`, `"debit"`; example `"credit"`
- `description` (`CreateReaderCheckoutRequest.description`; string, optional) — Description of the checkout to be shown in the Merchant Sales
- `installments` (`CreateReaderCheckoutRequest.installments`; integer, optional, nullable) — Number of installments for the transaction. It may vary according to the merchant country. For example, in Brazil, the maximum number of installments is 12. Omit if the merchant country does not support installments. Otherwise, the checkout will be rejected.
  - min 1; example `1`
- `payment_type` (`CreateReaderCheckoutRequest.payment_type`; string, optional) — The payment method type for the transaction. Defaults to `card`. Use `pix` to initiate a Pix QR-code payment flow on the device. Pix is only supported for Brazilian merchants; other merchants will receive a 422 error.
  - one of `"card"`, `"pix"`; default `"card"`; example `"card"`
- `return_url` (`CreateReaderCheckoutRequest.return_url`; string, optional) — Webhook URL to which the payment result will be sent. It must be a HTTPS url.
  - format `uri`; example `"https://www.example.com"`
- `tip_rates` (`CreateReaderCheckoutRequest.tip_rates`; array<number>, optional) — Exactly three distinct tipping rates to be displayed to the cardholder. Each rate is a fraction between 0.01 and 1.00 in increments of 0.01. The rates are sorted in ascending order by the server.
  - format `float`; min 0.01; max 1
- `tip_timeout` (`CreateReaderCheckoutRequest.tip_timeout`; integer, optional) — Time in seconds the cardholder has to select a tip rate. If not provided, the default value is 30 seconds. It can only be set if `tip_rates` is provided. **Note**: If the target device is a Solo, it must be in version 3.3.38.0 or higher.
  - min 30; max 120; default `30`; example `30`


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