@sumup/sdk
    Preparing search index...

    Type Alias CreateReaderCheckoutRequest

    CreateReaderCheckoutRequest

    Reader Checkout

    type CreateReaderCheckoutRequest = {
        affiliate?: {
            app_id: string;
            foreign_transaction_id: string;
            key: string;
            tags?: Record<string, unknown>;
        };
        card_type?: "credit"
        | "debit";
        description?: string;
        installments?: number;
        return_url?: string;
        tip_rates?: number[];
        tip_timeout?: number;
        total_amount: { currency: string; minor_unit: number; value: number };
    }
    Index

    Properties

    affiliate? card_type? description? installments? return_url? tip_rates? tip_timeout? total_amount

    Properties

    affiliate?: {
        app_id: string;
        foreign_transaction_id: string;
        key: string;
        tags?: Record<string, unknown>;
    }

    Affiliate

    Affiliate metadata for the transaction. It is a field that allow for integrators to track the source of the transaction.

    Type Declaration

    • app_id: string

      Application ID of the affiliate. It is a unique identifier for the application and should be set by the integrator in the Affiliate Keys page.

    • foreign_transaction_id: string

      Foreign transaction ID of the affiliate. It is a unique identifier for the transaction. It can be used later to fetch the transaction details via the Transactions API.

    • key: string

      Key of the affiliate. It is a unique identifier for the key and should be generated by the integrator in the Affiliate Keys page.

    • Optionaltags?: Record<string, unknown>

      Additional metadata for the transaction. It is key-value object that can be associated with the transaction.

    card_type?: "credit" | "debit"

    The card type of the card used for the transaction. Is is required only for some countries (e.g: Brazil).

    description?: string

    Description of the checkout to be shown in the Merchant Sales

    installments?: number

    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.

    return_url?: string

    Webhook URL to which the payment result will be sent. It must be a HTTPS url.

    tip_rates?: number[]

    List of tipping rates to be displayed to the cardholder. The rates are in percentage and should be between 0.01 and 0.99. The list should be sorted in ascending order.

    tip_timeout?: number

    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.

    total_amount: { currency: string; minor_unit: number; value: number }

    Money

    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.

    Type Declaration

    • currency: string

      Currency ISO 4217 code

    • minor_unit: number

      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.

    • value: number

      Integer value of the amount.

    Settings

    Member Visibility

    On This Page

    Properties