CreateReaderCheckoutRequest

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateReaderCheckoutRequest",
  "description": "Reader Checkout",
  "type": "object",
  "properties": {
    "aade": {
      "description": "Optional object containing data for transactions from ERP integrators in Greece that comply with the AADE 1155 protocol.\nWhen such regulatory/business requirements apply, this object must be provided and contains the data needed to validate the transaction with the AADE signature provider.\n",
      "type": "object",
      "properties": {
        "provider_id": {
          "description": "The identifier of the AADE signature provider.",
          "type": "string",
          "example": "123"
        },
        "signature": {
          "description": "The base64 encoded signature of the transaction data.",
          "type": "string",
          "example": "QjcxRDdBNTU1MDcyRTNFRTREMkZEM0Y0NTdBMjkxMTU4MzBFNkNCQTs7MjAyNTExMTIyMTQ3MTM7Nzk2OzEwNDs5MDA7OTAwOzU0ODg5MDM5"
        },
        "signature_data": {
          "description": "The string containing the signed transaction data.",
          "type": "string",
          "example": "B71D7A555072E3EE4D2FD3F457A29115830E6CBA;;20251112214713;796;104;900;900;54889039"
        }
      },
      "required": [
        "provider_id",
        "signature",
        "signature_data"
      ]
    },
    "affiliate": {
      "description": "Affiliate metadata for the transaction.\nIt is a field that allow for integrators to track the source of the transaction.\n",
      "type": "object",
      "nullable": true,
      "properties": {
        "app_id": {
          "description": "Application ID of the affiliate.\nIt is a unique identifier for the application and should be set by the integrator in the [Affiliate Keys](https://developer.sumup.com/affiliate-keys) page.\n",
          "type": "string",
          "example": "com.example.app"
        },
        "foreign_transaction_id": {
          "description": "Foreign transaction ID of the affiliate.\nIt is a unique identifier for the transaction.\nIt can be used later to fetch the transaction details via the [Transactions API](https://developer.sumup.com/api/transactions/get).\n",
          "type": "string",
          "example": "19e12390-72cf-4f9f-80b5-b0c8a67fa43f"
        },
        "key": {
          "description": "Key of the affiliate.\nIt is a unique identifier for the key  and should be generated by the integrator in the [Affiliate Keys](https://developer.sumup.com/affiliate-keys) page.\n",
          "type": "string",
          "example": "123e4567-e89b-12d3-a456-426614174000"
        },
        "tags": {
          "description": "Additional metadata for the transaction.\nIt is key-value object that can be associated with the transaction.\n",
          "type": "object",
          "example": {
            "custom_key_1": "custom_value_1",
            "custom_key_2": "custom_value_2"
          },
          "additionalProperties": true
        }
      },
      "required": [
        "app_id",
        "key",
        "foreign_transaction_id"
      ],
      "title": "Affiliate"
    },
    "card_type": {
      "description": "The card type of the card used for the transaction.\nIs is required only for some countries (e.g: Brazil).\n",
      "type": "string",
      "example": "credit",
      "enum": [
        "credit",
        "debit"
      ]
    },
    "description": {
      "description": "Description of the checkout to be shown in the Merchant Sales",
      "type": "string"
    },
    "installments": {
      "description": "Number of installments for the transaction.\nIt may vary according to the merchant country.\nFor example, in Brazil, the maximum number of installments is 12.\n\nOmit if the merchant country does support installments.\nOtherwise, the checkout will be rejected.\n",
      "type": "integer",
      "example": 1,
      "minimum": 1,
      "nullable": true
    },
    "return_url": {
      "description": "Webhook URL to which the payment result will be sent.\nIt must be a HTTPS url.\n",
      "type": "string",
      "format": "uri",
      "example": "https://www.example.com"
    },
    "tip_rates": {
      "description": "List of tipping rates to be displayed to the cardholder.\nThe rates are in percentage and should be between 0.01 and 0.99.\nThe list should be sorted in ascending order.\n",
      "type": "array",
      "items": {
        "format": "float",
        "multipleOf": 0.01,
        "type": "number"
      }
    },
    "tip_timeout": {
      "description": "Time in seconds the cardholder has to select a tip rate.\nIf not provided, the default value is 30 seconds.\n\nIt can only be set if `tip_rates` is provided.\n\n**Note**: If the target device is a Solo, it must be in version 3.3.38.0 or higher.\n",
      "type": "integer",
      "example": 30,
      "default": 30,
      "maximum": 120,
      "minimum": 30
    },
    "total_amount": {
      "description": "Amount structure.\n\nThe amount is represented as an integer value altogether with the currency and the minor unit.\n\nFor example, EUR 1.00 is represented as value 100 with minor unit of 2.\n",
      "type": "object",
      "example": {
        "currency": "EUR",
        "minor_unit": 2,
        "value": 1000
      },
      "properties": {
        "currency": {
          "description": "Currency ISO 4217 code",
          "type": "string",
          "example": "EUR"
        },
        "minor_unit": {
          "description": "The minor units of the currency.\nIt represents the number of decimals of the currency. For the currencies CLP, COP and HUF, the minor unit is 0.\n",
          "type": "integer",
          "example": 2,
          "minimum": 0
        },
        "value": {
          "description": "Integer value of the amount.",
          "type": "integer",
          "example": 1000,
          "minimum": 0
        }
      },
      "required": [
        "currency",
        "minor_unit",
        "value"
      ],
      "title": "Money"
    }
  },
  "example": {
    "aade": {
      "provider_id": "123",
      "signature": "QjcxRDdBNTU1MDcyRTNFRTREMkZEM0Y0NTdBMjkxMTU4MzBFNkNCQTs7MjAyNTExMTIyMTQ3MTM7Nzk2OzEwNDs5MDA7OTAwOzU0ODg5MDM5",
      "signature_data": "B71D7A555072E3EE4D2FD3F457A29115830E6CBA;;20251112214713;796;104;900;900;54889039"
    },
    "affiliate": {
      "app_id": "com.example.app",
      "foreign_transaction_id": "123456",
      "key": "ef7b684a-d6f4-4e93-9b1b-6acdd6564a8e",
      "tags": {}
    },
    "card_type": "debit",
    "description": "This is a description...",
    "installments": 1,
    "return_url": "https://webhook.site/e21ddbb0-42c4-4358-a981-f5a95cd86fb5",
    "tip_rates": [
      0.05,
      0.1,
      0.15
    ],
    "tip_timeout": 60,
    "total_amount": {
      "currency": "EUR",
      "minor_unit": 2,
      "value": 5033
    }
  },
  "required": [
    "total_amount"
  ]
}