@sumup/sdk
    Preparing search index...

    Type Alias TransactionFull

    TransactionFull: TransactionBase & TransactionCheckoutInfo & TransactionMixinHistory & {
        card?: CardResponse;
        client_transaction_id?: string;
        device_info?: Device;
        elv_account?: ElvCardAccount;
        events?: Event[];
        fee_amount?: number;
        foreign_transaction_id?: string;
        horizontal_accuracy?: HorizontalAccuracy;
        lat?: Lat;
        links?: Link[];
        local_time?: string;
        location?: {
            horizontal_accuracy?: HorizontalAccuracy;
            lat?: Lat;
            lon?: Lon;
        };
        lon?: Lon;
        merchant_id?: number;
        payout_date?: string;
        payout_type?: "BANK_ACCOUNT"
        | "PREPAID_CARD";
        process_as?: "CREDIT" | "DEBIT";
        products?: Product[];
        simple_payment_type?:
            | "CASH"
            | "CC_SIGNATURE"
            | "ELV"
            | "ELV_WITHOUT_SIGNATURE"
            | "CC_CUSTOMER_ENTERED"
            | "MANUAL_ENTRY"
            | "EMV"
            | "RECURRING"
            | "BALANCE"
            | "MOTO"
            | "BOLETO"
            | "APM"
            | "BITCOIN"
            | "CARD";
        simple_status?: | "SUCCESSFUL"
        | "PAID_OUT"
        | "CANCEL_FAILED"
        | "CANCELLED"
        | "CHARGEBACK"
        | "FAILED"
        | "REFUND_FAILED"
        | "REFUNDED"
        | "NON_COLLECTION"
        | "PENDING";
        tax_enabled?: boolean;
        transaction_events?: TransactionEvent[];
        username?: string;
        vat_rates?: { gross?: number; net?: number; rate?: number; vat?: number }[];
        verification_method?:
            | "none"
            | "signature"
            | "offline PIN"
            | "online PIN"
            | "offline PIN + signature"
            | "na";
    }

    Transaction Full

    Full transaction resource with checkout, payout, and event details.

    Type Declaration

    • Optionalcard?: CardResponse
    • Optionalclient_transaction_id?: string

      Client transaction id.

    • Optionaldevice_info?: Device
    • Optionalelv_account?: ElvCardAccount
    • Optionalevents?: Event[]

      Compact list of events related to the transaction.

    • Optionalfee_amount?: number

      Transaction SumUp total fee amount.

    • Optionalforeign_transaction_id?: string

      External/foreign transaction id (passed by clients).

    • Optionalhorizontal_accuracy?: HorizontalAccuracy
    • Optionallat?: Lat
    • Optionallinks?: Link[]

      List of hyperlinks for accessing related resources.

    • Optionallocal_time?: string

      Local date and time of the creation of the transaction.

    • Optionallocation?: { horizontal_accuracy?: HorizontalAccuracy; lat?: Lat; lon?: Lon }

      Details of the payment location as received from the payment terminal.

    • Optionallon?: Lon
    • Optionalmerchant_id?: number

      SumUp merchant internal Id.

    • Optionalpayout_date?: string

      The date of the payout.

    • Optionalpayout_type?: "BANK_ACCOUNT" | "PREPAID_CARD"

      Payout type for the transaction.

    • Optionalprocess_as?: "CREDIT" | "DEBIT"

      Debit/Credit.

    • Optionalproducts?: Product[]

      List of products from the merchant's catalogue for which the transaction serves as a payment.

    • Optionalsimple_payment_type?:
          | "CASH"
          | "CC_SIGNATURE"
          | "ELV"
          | "ELV_WITHOUT_SIGNATURE"
          | "CC_CUSTOMER_ENTERED"
          | "MANUAL_ENTRY"
          | "EMV"
          | "RECURRING"
          | "BALANCE"
          | "MOTO"
          | "BOLETO"
          | "APM"
          | "BITCOIN"
          | "CARD"

      Simple name of the payment type.

    • Optionalsimple_status?:
          | "SUCCESSFUL"
          | "PAID_OUT"
          | "CANCEL_FAILED"
          | "CANCELLED"
          | "CHARGEBACK"
          | "FAILED"
          | "REFUND_FAILED"
          | "REFUNDED"
          | "NON_COLLECTION"
          | "PENDING"

      High-level status of the transaction from the merchant's perspective.

      • PENDING: The payment has been initiated and is still being processed. A final outcome is not available yet.
      • SUCCESSFUL: The payment was completed successfully.
      • PAID_OUT: The payment was completed successfully and the funds have already been included in a payout to the merchant.
      • FAILED: The payment did not complete successfully.
      • CANCELLED: The payment was cancelled or reversed and is no longer payable or payable to the merchant.
      • CANCEL_FAILED: An attempt to cancel or reverse the payment was not completed successfully.
      • REFUNDED: The payment was refunded in full or in part.
      • REFUND_FAILED: An attempt to refund the payment was not completed successfully.
      • CHARGEBACK: The payment was subject to a chargeback.
      • NON_COLLECTION: The amount could not be collected from the merchant after a chargeback or related adjustment.
    • Optionaltax_enabled?: boolean

      Indicates whether tax deduction is enabled for the transaction.

    • Optionaltransaction_events?: TransactionEvent[]

      Detailed list of events related to the transaction.

    • Optionalusername?: string

      Email address of the registered user (merchant) to whom the payment is made.

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

      List of VAT rates applicable to the transaction.

    • Optionalverification_method?:
          | "none"
          | "signature"
          | "offline PIN"
          | "online PIN"
          | "offline PIN + signature"
          | "na"

      Verification method used for the transaction.

    Settings

    Member Visibility