@sumup/sdk
    Preparing search index...

    Type Alias ReceiptTransaction

    Receipt Transaction

    Transaction details displayed on a receipt.

    type ReceiptTransaction = {
        amount?: string;
        card?: ReceiptCard;
        card_reader?: ReceiptReader;
        currency?: string;
        entry_mode?: string;
        events?: ReceiptEvent[];
        installments_count?: number;
        merchant_code?: string;
        payment_type?: string;
        process_as?: "CREDIT" | "DEBIT";
        products?: {
            description?: string;
            name?: string;
            price?: string;
            price_with_vat?: string;
            quantity?: number;
            single_vat_amount?: string;
            total_price?: string;
            total_with_vat?: string;
            vat_amount?: string;
            vat_rate?: string;
        }[];
        receipt_no?: string;
        status?: string;
        timestamp?: string;
        tip_amount?: string;
        transaction_code?: string;
        transaction_id?: TransactionID;
        vat_amount?: string;
        vat_rates?: { gross?: number; net?: number; rate?: number; vat?: number }[];
        verification_method?: string;
    }
    Index
    amount? card? card_reader? currency? entry_mode? events? installments_count? merchant_code? payment_type? process_as? products? receipt_no? status? timestamp? tip_amount? transaction_code? transaction_id? vat_amount? vat_rates? verification_method?
    amount?: string

    Total transaction amount, in major units.

    card?: ReceiptCard
    card_reader?: ReceiptReader
    currency?: string

    Three-letter ISO 4217 currency code of the transaction.

    Optionalentry_mode

    entry_mode?: string

    Entry mode of the payment details.

    events?: ReceiptEvent[]

    Transaction events displayed on the receipt.

    installments_count?: number

    Number of installments.

    merchant_code?: string

    Short unique identifier for the merchant.

    payment_type?: string

    Payment type used for the transaction.

    process_as?: "CREDIT" | "DEBIT"

    Whether the transaction was processed as credit or debit.

    products?: {
        description?: string;
        name?: string;
        price?: string;
        price_with_vat?: string;
        quantity?: number;
        single_vat_amount?: string;
        total_price?: string;
        total_with_vat?: string;
        vat_amount?: string;
        vat_rate?: string;
    }[]

    Products associated with the transaction.

    Type Declaration

    • Optionaldescription?: string

      Product description.

    • Optionalname?: string

      Product name.

    • Optionalprice?: string

      Product price.

    • Optionalprice_with_vat?: string

      Product price including VAT.

    • Optionalquantity?: number

      Product quantity.

    • Optionalsingle_vat_amount?: string

      VAT amount for a single product.

    • Optionaltotal_price?: string

      Total price calculated as the product price multiplied by the quantity.

    • Optionaltotal_with_vat?: string

      Total product price including VAT.

    • Optionalvat_amount?: string

      Total VAT amount for the product quantity.

    • Optionalvat_rate?: string

      VAT rate.

    receipt_no?: string

    Receipt number associated with the transaction.

    status?: string

    Current processing status of the transaction.

    timestamp?: string

    The timestamp of when the transaction was created.

    tip_amount?: string

    Tip included in the transaction amount, in major units.

    transaction_code?: string

    Transaction code returned after processing the transaction.

    transaction_id?: TransactionID
    vat_amount?: string

    VAT included in the transaction amount, in major units.

    vat_rates?: { gross?: number; net?: number; rate?: number; vat?: number }[]

    VAT breakdown for the transaction.

    Type Declaration

    • Optionalgross?: number

      Gross amount to which the VAT rate applies.

    • Optionalnet?: number

      Net amount to which the VAT rate applies.

    • Optionalrate?: number

      VAT rate applied to the transaction amount.

    • Optionalvat?: number

      VAT amount included in the gross amount.

    verification_method?: string

    Cardholder verification method.

    Settings
    Member Visibility

    On This Page
    Properties