Skip to main content

Retrieve receipt details​

Retrieves receipt specific data for a transaction.

Path Parameters
  • id string required

    SumUp unique transaction ID or transaction code, e.g. TS7HDYLSKD.

Query Parameters
  • mid string required

    Merchant code.

  • tx_event_id integer

    The ID of the transaction event (refund).

Responses

OK

Schema
  • transaction_data object

    Transaction information.

  • transaction_code string

    Transaction code.

  • amount string

    Transaction amount.

  • vat_amount string

    Transaction VAT amount.

  • tip_amount string

    Tip amount (included in transaction amount).

  • currency string

    Transaction currency.

  • timestamp date-time

    Time created at.

  • status string

    Transaction processing status.

  • payment_type string

    Transaction type.

  • entry_mode string

    Transaction entry mode.

  • verification_method string

    Cardholder verification method.

  • card object
  • last_4_digits string

    Card last 4 digits.

  • type string

    Card Scheme.

  • cardholder_name string

    Cardholder name.

  • expiry_month string

    Expiry month.

  • expiry_year string

    Expiry year.

  • token string

    Token ID of these card details.

  • installments_count integer

    Number of installments.

  • customer_email string
  • products object[]

    Products

  • name string

    Product name.

  • description string

    Product description.

  • price float

    Product price.

  • quantity integer

    Product quantity.

  • total_price float

    Quantity x product price.

  • vat_rates object[]

    Vat rates.

  • gross float

    Gross

  • net float

    Net

  • rate float

    Rate

  • vat float

    Vat

  • location object

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

  • lat float

    Possible values: <= 90

    Latitude value from the coordinates of the payment location (as received from the payment terminal reader).

  • lon float

    Possible values: <= 180

    Longitude value from the coordinates of the payment location (as received from the payment terminal reader).

  • horizontal_accuracy float

    Indication of the precision of the geographical position received from the payment terminal.

  • events object[]

    Events

  • id int64

    Unique ID of the transaction event.

  • transaction_id string

    Unique ID of the transaction.

  • type string

    Possible values: [PAYOUT, CHARGE_BACK, REFUND, PAYOUT_DEDUCTION]

    Type of the transaction event.

  • status string

    Possible values: [PENDING, SCHEDULED, FAILED, REFUNDED, SUCCESSFUL, PAID_OUT]

    Status of the transaction event.

  • amount float

    Amount of the event.

  • timestamp date-time

    Date and time of the transaction event.

  • receipt_no string
  • receipt_no string

    Receipt number

  • merchant_data object

    Receipt merchant data

  • merchant_profile object
  • merchant_code string
  • business_name string
  • email string
  • address object
  • address_line1 string
  • city string
  • country string
  • country_en_name string
  • country_native_name string
  • post_code string
  • landline string
  • settings object
  • tax_enabled boolean
  • legal_type object
  • description string
  • sole_trader boolean
  • locale string
  • emv_data object
  • acquirer_data object
  • tid string
  • authorization_code string
  • return_code string
  • local_time string