Sign in
Transactions

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
get/v2.1/merchants/{merchant_code}/transactions

Path parameters

merchant_codestring required
Example:MH4H92C7

Query parameters

idstring

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

internal_idstring

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

transaction_codestring

Retrieves the transaction resource with the specified transaction code.

foreign_transaction_idstring

External/foreign transaction id (passed by clients).

client_transaction_idstring

Client transaction id.

Response

Returns the requested transaction resource.

idstring

Unique ID of the transaction.

transaction_codestring

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

amountnumber float

Total amount of the transaction.

currency'BGN' | 'BRL' | 'CHF' | 'CLP' | 'COP' | 'CZK' | 'DKK' | 'EUR' | 'GBP' | 'HRK' | 'HUF' | 'NOK' | 'PLN' | 'RON' | 'SEK' | 'USD'

Three-letter ISO4217 code of the currency for the amount. Currently supported currency values are enumerated above.

timestampstring date-time

Date and time of the creation of the transaction. Response format expressed according to ISO8601 code.

status'SUCCESSFUL' | 'CANCELLED' | 'FAILED' | 'PENDING'

Current status of the transaction.

payment_type'CASH' | 'POS' | 'ECOM' | 'RECURRING' | 'BITCOIN' | 'BALANCE' | 'MOTO' | 'BOLETO' | 'DIRECT_DEBIT' | 'APM' | 'UNKNOWN'

Payment type used for the transaction.

installments_countinteger

Current number of the installment for deferred payments.

merchant_codestring

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

vat_amountnumber float

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

tip_amountnumber float

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

entry_mode'none' | 'magstripe' | 'chip' | 'manual entry' | 'customer entry' | 'magstripe fallback' | 'contactless' | 'moto' | 'contactless magstripe' | 'boleto' | 'direct debit' | 'sofort' | 'ideal' | 'bancontact' | 'eps' | 'mybank' | 'satispay' | 'blik' | 'p24' | 'giropay' | 'pix' | 'qr code pix' | 'apple pay' | 'google pay' | 'paypal' | 'twint' | 'na'

Entry mode of the payment details.

auth_codestring

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

internal_idinteger

Internal unique ID of the transaction on the SumUp platform.

product_summarystring

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

payouts_totalinteger

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

payouts_receivedinteger

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

payout_plan'SINGLE_PAYMENT' | 'TRUE_INSTALLMENT' | 'ACCELERATED_INSTALLMENT'

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

foreign_transaction_idstring

External/foreign transaction id (passed by clients).

client_transaction_idstring

Client transaction id.

usernamestring email

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

fee_amountnumber

Transaction SumUp total fee amount.

latnumber float

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

lonnumber float

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

horizontal_accuracynumber float

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

merchant_idinteger

SumUp merchant internal Id.

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

verification_method'none' | 'signature' | 'offline PIN' | 'online PIN' | 'offline PIN + signature' | 'na'

Verification method used for the transaction.

local_timestring date-time

Local date and time of the creation of the transaction.

payout_datestring date

The date of the payout.

payout_type'BANK_ACCOUNT' | 'PREPAID_CARD'

Payout type for the transaction.

process_as'CREDIT' | 'DEBIT'

Debit/Credit.

simple_status'SUCCESSFUL' | 'PAID_OUT' | 'CANCEL_FAILED' | 'CANCELLED' | 'CHARGEBACK' | 'FAILED' | 'REFUND_FAILED' | 'REFUNDED' | 'NON_COLLECTION' | 'PENDING'

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

tax_enabledboolean

Indicates whether tax deduction is enabled for the transaction.

Example response

{
  "id": "6b425463-3e1b-431d-83fa-1e51c2925e99",
  "transaction_code": "TEENSK4W2K",
  "amount": 10.1,
  "currency": "EUR",
  "timestamp": "2020-02-29T10:56:56.876Z",
  "merchant_code": "MH4H92C7",
  "vat_amount": 6,
  "tip_amount": 3,
  "auth_code": "053201",
  "internal_id": 1763892018,
  "foreign_transaction_id": "J13253253x1",
  "client_transaction_id": "urn:sumup:pos:sale:MNKKNGST:1D4E3B2D-111D-48D7-9AF0-832DAEF63DD7;2",
  "fee_amount": 8,
  "merchant_id": 136902,
  "device_info": {
    "name": "m0xx",
    "system_name": "Android",
    "model": "GT-I9300",
    "system_version": "4.3",
    "uuid": "3ae2a6b7-fb0d-3b50-adbf-cb7e2db30cd2"
  },
  "card": {
    "last_4_digits": "3456"
  },
  "elv_account": {
    "sort_code": "87096214",
    "last_4_digits": "5674",
    "sequence_no": 1,
    "iban": "DE60870962140012345674"
  },
  "payout_date": "2019-08-28",
  "process_as": "CREDIT",
  "products": [
    {
      "name": "Purchase reader for merchant with code ME3FCAVF",
      "price": 100,
      "quantity": 1,
      "total_price": 100
    }
  ],
  "vat_rates": [
    {
      "rate": 0.045,
      "net": 1.36,
      "vat": 0.06,
      "gross": 1.42
    }
  ],
  "transaction_events": [
    {
      "amount": 58.8,
      "due_date": "2020-05-25",
      "date": "2020-05-25",
      "installment_number": 1,
      "timestamp": "2020-05-25T10:49:42.784Z"
    }
  ]
}

Changes