@sumup/sdk
    Preparing search index...

    Type Alias CreateReaderCheckout

    Reader

    Reader Checkout

    type CreateReaderCheckout = {
        affiliate?: Affiliate;
        card_type?: "credit" | "debit";
        description?: string;
        installments?: number;
        return_url?: string;
        tip_rates?: number[];
        total_amount: CreateReaderCheckoutAmount;
    }
    Index

    Properties

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

    Properties

    affiliate?: Affiliate
    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.

    total_amount: CreateReaderCheckoutAmount

    Settings

    Member Visibility

    On This Page

    Properties