Skip to main content

Retrieve a transaction

Retrieves the full details of an identified transaction. The transaction resource is identified by a query parameter and one of following parameters is required:

  • id
  • internal_id
  • transaction_code
  • foreign_transaction_id
  • client_transaction_id
Query Parameters
  • id string

    Retrieves the transaction resource with the specified transaction ID (the id parameter in the transaction resource).

  • internal_id string

    Retrieves the transaction resource with the specified internal transaction ID (the internal_id parameter in the transaction resource).

  • transaction_code string

    Retrieves the transaction resource with the specified transaction code.

Responses

OK


Schema
  • id string

    Unique ID of the transaction.

  • transaction_code string

    Transaction code returned by the acquirer/processing entity after processing the transaction.

  • amount float

    Total amount of the transaction.

  • currency string

    Possible values: [BGN, BRL, CHF, CLP, CZK, DKK, EUR, GBP, HRK, HUF, NOK, PLN, RON, SEK, USD]

    Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank" rel="noopener">ISO4217</a> code of the currency for the amount. Currently supported currency values are enumerated above.

  • timestamp date-time

    Date and time of the creation of the transaction. Response format expressed according to <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank" rel="noopener">ISO8601</a> code.

  • status string

    Possible values: [SUCCESSFUL, CANCELLED, FAILED, PENDING]

    Current status of the transaction.

  • payment_type string

    Possible values: [ECOM, RECURRING]

    Payment type used for the transaction.

  • installments_count integer

    Possible values: >= 1

    Current number of the installment for deferred payments.

  • merchant_code string

    Unique code of the registered merchant to whom the payment is made.

  • vat_amount float

    Amount of the applicable VAT (out of the total transaction amount).

  • tip_amount float

    Amount of the tip (out of the total transaction amount).

  • entry_mode string

    Possible values: [CUSTOMER_ENTRY]

    Entry mode of the payment details.

  • auth_code string

    Authorization code for the transaction sent by the payment card issuer or bank. Applicable only to card payments.

  • internal_id integer

    Internal unique ID of the transaction on the SumUp platform.

  • product_summary string

    Short description of the payment. The value is taken from the description property of the related checkout resource.

  • payouts_total integer

    Total number of payouts to the registered user specified in the user property.

  • payouts_received integer

    Number of payouts that are made to the registered user specified in the user property.

  • payout_plan string

    Possible values: [SINGLE_PAYMENT, TRUE_INSTALLMENT, ACCELERATED_INSTALLMENT]

    Payout plan of the registered user at the time when the transaction was made.

  • username email

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

  • 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.

  • simple_payment_type string

    Possible values: [MOTO, CASH, CC_SIGNATURE, ELV, CC_CUSTOMER_ENTERED, MANUAL_ENTRY, EMV]

    Simple name of the payment type.

  • verification_method string

    Possible values: [none, signature, offline pin, online pin, offline pin + signature, confirmation code verified]

    Verification method used for the transaction.

  • card object

    Details of the payment card.

  • last_4_digits string

    Possible values: >= 4 characters and <= 4 characters

    Last 4 digits of the payment card number.

  • type string

    Possible values: [AMEX, CUP, DINERS, DISCOVER, ELO, ELV, HIPERCARD, JCB, MAESTRO, MASTERCARD, VISA, VISA_ELECTRON, VISA_VPAY, UNKNOWN]

    Issuing card network of the payment card.

  • local_time date-time

    Local date and time of the creation of the transaction.

  • payout_type string

    Possible values: [BANK_ACCOUNT, BALANCE, PREPAID_CARD]

    Payout type for the transaction.

  • products object[]

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

  • name string

    Name of the product from the merchant's catalog.

  • price float

    Price of the product without VAT.

  • vat_rate float

    VAT rate applicable to the product.

  • single_vat_amount float

    Amount of the VAT for a single product item (calculated as the product of price and vat_rate, i.e. single_vat_amount = price * vat_rate).

  • price_with_vat float

    Price of a single product item with VAT.

  • vat_amount float

    Total VAT amount for the purchase (calculated as the product of single_vat_amount and quantity, i.e. vat_amount = single_vat_amount * quantity).

  • quantity number

    Number of product items for the purchase.

  • total_price float

    Total price of the product items without VAT (calculated as the product of price and quantity, i.e. total_price = price * quantity).

  • total_with_vat float

    Total price of the product items including VAT (calculated as the product of price_with_vat and quantity, i.e. total_with_vat = price_with_vat * quantity).

  • vat_rates array

    List of VAT rates applicable to the transaction.

  • transaction_events object[]

    List of transaction events related to the transaction.

  • id int64

    Unique ID of the transaction event.

  • event_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.

  • due_date date

    Date when the transaction event is due to occur.

  • date date

    Date when the transaction event occurred.

  • installment_number integer

    Consequtive number of the installment that is paid. Applicable only payout events, i.e. event_type = PAYOUT.

  • timestamp date-time

    Date and time of the transaction event.

  • simple_status string

    Possible values: [SUCCESSFUL, PAID_OUT, CANCEL_FAILED, CANCELLED, CHARGEBACK, FAILED, REFUND_FAILED, REFUNDED, NON_COLLECTION]

    Status generated from the processing status and the latest transaction state.

  • links object[]

    List of hyperlinks for accessing related resources.

  • events object[]

    List of events related to the transaction.

  • 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.

  • fee_amount float

    Amount of the fee related to the event.

  • installment_number integer

    Consequtive number of the installment.

  • deducted_amount float

    Amount deducted for the event.

  • deducted_fee_amount float

    Amount of the fee deducted for the event.

  • 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.

  • tax_enabled boolean

    Indicates whether tax deduction is enabled for the transaction.