Headers

• Account-ID string(uuid) Required

  Account ID - Can be found on the Dashboard under Settings → API Tokens

Path parameters

• transaction string(uuid) Required

Responses

• 200 application/json

  Transaction updated

  Hide response attribute Show response attribute object

  • data object

    Payment transaction details for an order including pricing, taxes, discounts, and buyer information

    Hide data attributes Show data attributes object

    • id string(uuid)

      Unique identifier for the transaction. Internal use only - not displayed to customers. Use this ID for API operations like updating payment references or resending receipts.

    • list_prices_include_tax boolean

      Indicates whether the list_price field includes tax (true) or is pre-tax (false). Important for correct price display and accounting.

    • list_price integer

      Total list price in cents (smallest currency unit) before discounts are applied. Whether this includes tax depends on the list_prices_include_tax field.

    • promotion_name string | null

      Display name of the promotion applied to this transaction, if any

    • promotion_code string | null

      The specific promotion code used by the customer, if applicable

    • discounts object

      Breakdown of all discounts applied to this transaction by type. Keys represent discount types, values are amounts in cents.

      Hide discounts attribute Show discounts attribute object

      • * integer Additional properties
    • tax_percentages object

      Breakdown of tax amounts by tax rate. Keys are tax rates as strings (e.g., "0.2" for 20%, "0" for tax-exempt items). Values are the total tax amount in cents for all items taxed at that rate.

      Hide tax_percentages attribute Show tax_percentages attribute object

      • * integer Additional properties
    • tax integer

      Total tax amount in cents (smallest currency unit)

    • value integer

      Final transaction amount in cents (smallest currency unit) after all discounts and including tax. This is the amount charged to the customer.

    • currency_code string

      ISO 4217 currency code in lowercase (e.g., usd, gbp, eur). Determines the currency for all monetary values in this transaction.

    • buyer object

      Customer information collected during checkout

      Hide buyer attributes Show buyer attributes object

      • email string(email)

        Buyer's email address for receipts and communication

      • name string

        Buyer's name as provided during checkout

    • marketing_consent boolean

      Indicates whether the buyer opted in to receive marketing communications

    • completed_at string(date-time) | null

      Timestamp when the transaction payment was completed. Null if payment is pending or failed.

    • type string

      Transaction type indicating how the order was placed:

      • online: Created through online storefront checkout
      • offline: Created through terminal/POS or manually by staff

      Values are online or offline.

    • is_imported boolean

      Indicates if this transaction was imported from an external system

    • payment_gateway string | null

      Payment gateway used to process the transaction (e.g., Stripe, PayPal). Null for offline/manual transactions.

    • payment_reference string | null

      External payment reference or transaction ID from the payment gateway. Used for reconciliation and refunds. Examples: Stripe checkout session ID (cs_live_xxx), PayPal transaction ID, or custom reference for offline payments.

• 404

  Transaction not found