Receipts | SumUp Developer

The Receipts model obtains receipt-like details for specific transactions.

The Receipt object

Receipt details for a transaction.

transaction_dataReceipt Transaction
Transaction details displayed on a receipt.
Show attributes
Close
Receipt Transaction
- transaction_codestring
  Transaction code returned after processing the transaction.
  
  Example: "TEENSK4W2K"
- transaction_idTransaction ID
  Unique identifier of the transaction.
  
  Example: "410fc44a-5956-44e1-b5cc-19c6f8d727a4"
- merchant_codestring
  Short unique identifier for the merchant.
  
  Example: "MH4H92C7"
- amountstring
  Total transaction amount, in major units.
  
  Example: "10.10"
- vat_amountstring
  VAT included in the transaction amount, in major units.
  
  Example: "6.00"
- tip_amountstring
  Tip included in the transaction amount, in major units.
  
  Example: "3.00"
- currencystring
  Three-letter ISO 4217 currency code of the transaction.
  
  Example: "EUR"
- timestampstringformat: date-time
  The timestamp of when the transaction was created.
  
  Example: "2020-02-29T10:56:56.876Z"
- statusstring
  Current processing status of the transaction.
  
  Example: "SUCCESSFUL"
- payment_typestring
  Payment type used for the transaction.
  
  Example: "ECOM"
- entry_modestring
  Entry mode of the payment details.
  
  Example: "CUSTOMER_ENTRY"
- verification_methodstring
  Cardholder verification method.
  
  Example: "none"
- card_readerReceipt Reader
  Card reader details displayed on the receipt.
  
  Show attributes
  Close
  Receipt Reader
  codestring
  Unique identifier of the physical card reader.
  
  Example: "U1DT3NA00-CN"
  typestring
  Model of the physical card reader.
  
  Example: "solo"
- cardReceipt Card
  Payment card details displayed on the receipt.
  
  Show attributes
  Close
  Receipt Card
  last_4_digitsstring
  Last four digits of the payment card number.
  
  Example: "3456"
  typestring
  Issuing card network of the payment card.
  
  Example: "VISA"
- installments_countinteger
  Number of installments.
  
  Example: 1
- process_asstring
  Options: CREDITDEBIT
  Whether the transaction was processed as credit or debit.
  
  Example: "CREDIT"
- products[]object
  Products associated with the transaction.
  
  Show attributes
  Close
  Attributes
  namestring
  Product name.
  
  Example: "Coffee"
  descriptionstring
  Product description.
  
  Example: "Cappuccino"
  pricestringformat: double
  Product price.
  
  Example: "150.0"
  vat_ratestringformat: double
  VAT rate.
  
  Example: "0.0"
  single_vat_amountstringformat: double
  VAT amount for a single product.
  
  Example: "0.0"
  price_with_vatstringformat: double
  Product price including VAT.
  
  Example: "150.0"
  vat_amountstringformat: double
  Total VAT amount for the product quantity.
  
  Example: "0.0"
  quantityinteger
  Product quantity.
  
  Example: 1
  total_pricestringformat: double
  Total price calculated as the product price multiplied by the quantity.
  
  Example: "150.0"
  total_with_vatstringformat: double
  Total product price including VAT.
  
  Example: "150.0"
- vat_rates[]object
  VAT breakdown for the transaction.
  
  Show attributes
  Close
  Attributes
  grossnumber
  Gross amount to which the VAT rate applies.
  
  Example: 10.1
  netnumber
  Net amount to which the VAT rate applies.
  
  Example: 8.49
  ratenumber
  VAT rate applied to the transaction amount.
  
  Example: 0.19
  vatnumber
  VAT amount included in the gross amount.
  
  Example: 1.61
- events[]ReceiptEvent
  Transaction events displayed on the receipt.
  
  Show attributes
  Close
  Receipt Event
  idTransaction Event ID
  Unique identifier of the transaction event.
  
  Example: 9567461191
  transaction_idTransaction ID
  Unique identifier of the transaction.
  
  Example: "410fc44a-5956-44e1-b5cc-19c6f8d727a4"
  typeTransaction Event Type
  Options: PAYOUTCHARGE_BACKREFUNDPAYOUT_DEDUCTION
  Type of the transaction event.
  
  Example: "REFUND"
  statusTransaction Event Status
  Options: FAILEDPAID_OUTPENDINGRECONCILEDREFUNDEDSCHEDULEDSUCCESSFUL
  Status of the transaction event.
  
  Not every value is used for every event type.
  
  PENDING: The event has been created but is not final yet. Used for events that are still being processed and whose final outcome is not known yet.
  
  SCHEDULED: The event is planned for a future payout cycle but has not been executed yet. This applies to payout events before money is actually sent out.
  
  RECONCILED: The underlying payment has been matched with settlement data and is ready to continue through payout processing, but the funds have not been paid out yet. This applies to payout events.
  
  PAID_OUT: The payout event has been completed and the funds were included in a merchant payout.
  
  REFUNDED: A refund event has been accepted and recorded in the refund flow. This is the status returned for refund events once the transaction amount is being or has been returned to the payer.
  
  SUCCESSFUL: The event completed successfully. Use this as the generic terminal success status for event types that do not expose a more specific business outcome such as PAID_OUT or REFUNDED.
  
  FAILED: The event could not be completed. Typical examples are a payout that could not be executed or an event that was rejected during processing.
  
  Example: "SUCCESSFUL"
  amountstringformat: double
  Amount associated with the transaction event, in major units.
  
  Example: "10.10"
  timestampstringformat: date-time
  The timestamp of when the transaction event occurred.
  
  Example: "2020-05-25T10:49:42.784Z"
  receipt_nostring
  Receipt number associated with the event.
  
  Example: "123456"
- receipt_nostring
  Receipt number associated with the transaction.
  
  Example: "123456"
Example: {"transaction_code":"TEENSK4W2K","transaction_id":"410fc44a-5956-44e1-b5cc-19c6f8d727a4","merchant_code":"MH4H92C7","amount":"10.10","vat_amount":"6.00","tip_amount":"3.00","currency":"EUR","timestamp":"2020-02-29T10:56:56.876Z","status":"SUCCESSFUL","payment_type":"ECOM","entry_mode":"CUSTOMER_ENTRY","installments_count":1,"process_as":"CREDIT"}
merchant_dataReceipt Merchant Data
Merchant details displayed on a transaction receipt.
Show attributes
Close
Receipt Merchant Data
- merchant_profileobject
  Merchant profile details displayed on the receipt.
  
  Show attributes
  Close
  Attributes
  merchant_codestring
  Short unique identifier for the merchant.
  
  Example: "MH4H92C7"
  business_namestring
  Business name of the merchant.
  
  Example: "Coffee House"
  company_registration_numberstring
  Company registration number of the merchant.
  
  Example: "HRB 123456"
  vat_idstring
  VAT identification number of the merchant.
  
  Example: "DE123456789"
  websitestring
  Website of the merchant.
  
  Example: "https://example.com"
  emailstring
  Email address of the merchant.
  
  Example: "merchant@example.com"
  languagestring
  Language configured for the merchant profile.
  
  Example: "de"
  addressobject
  Business address of the merchant.
  
  Show attributes
  Close
  Attributes
  address_line1string
  First line of the merchant address.
  
  Example: "Sample street 1"
  address_line2string
  Second line of the merchant address.
  
  Example: "Floor 2"
  citystring
  City of the merchant address.
  
  Example: "Berlin"
  countrystring
  Two-letter ISO 3166-1 alpha-2 country code of the merchant address.
  
  Example: "DE"
  country_en_namestring
  English name of the country in the merchant address.
  
  Example: "Germany"
  country_native_namestring
  Localized name of the country in the merchant address.
  
  Example: "Deutschland"
  region_namestring
  Region or state of the merchant address.
  
  Example: "Berlin"
  post_codestring
  Postal code of the merchant address.
  
  Example: "10115"
  landlinestring
  Landline phone number of the merchant.
  
  Example: "+493012345678"
- localestring
  Locale used for rendering localized receipt fields.
  
  Example: "de-DE"
emv_dataobject
EMV-specific metadata returned for card-present payments.

Example: {}
acquirer_dataobject
Acquirer-specific metadata related to the card authorization.
Show attributes
Close
Attributes
- tidstring
  Identifier of the terminal used for the authorization.
  
  Example: "12345678"
- authorization_codestring
  Authorization code returned by the acquirer.
  
  Example: "053201"
- return_codestring
  Return code reported by the acquirer.
  
  Example: "00"
- local_timestring
  Local timestamp of the card authorization.
  
  Example: "2020-02-29T11:56:56+01:00"
Example: {"authorization_code":"053201","return_code":"00"}

1
{
2
  "transaction_data": {
3
    "transaction_code": "TEENSK4W2K",
4
    "transaction_id": "410fc44a-5956-44e1-b5cc-19c6f8d727a4",
5
    "merchant_code": "MH4H92C7",
6
    "amount": "10.10",
7
    "vat_amount": "6.00",
8
    "tip_amount": "3.00",
9
    "currency": "EUR",
10
    "timestamp": "2020-02-29T10:56:56.876Z",
11
    "status": "SUCCESSFUL",
12
    "payment_type": "ECOM",
13
    "entry_mode": "CUSTOMER_ENTRY",
14
    "installments_count": 1,
15
    "process_as": "CREDIT"
16
  },
17
  "merchant_data": {
18
    "merchant_profile": {
19
      "merchant_code": "MH4H92C7",
20
      "business_name": "Coffee House",
21
      "company_registration_number": "HRB 123456",
22
      "vat_id": "DE123456789",
23
      "website": "https://example.com",
24
      "email": "merchant@example.com",
25
      "language": "de",
26
      "address": {
27
        "address_line1": "Sample street 1",
28
        "address_line2": "Floor 2",
29
        "city": "Berlin",
30
        "country": "DE",
31
        "country_en_name": "Germany",
32
        "country_native_name": "Deutschland",
33
        "region_name": "Berlin",
34
        "post_code": "10115",
35
        "landline": "+493012345678"
36
      }
37
    },
38
    "locale": "de-DE"
39
  },
40
  "emv_data": {},
41
  "acquirer_data": {
42
    "authorization_code": "053201",
43
    "return_code": "00"
44
  }
45
}

Receipts

Retrieve receipt details

GET/v1.1/receipts/{transaction_id}

Retrieves receipt specific data for a transaction.

Requires one of scopes:receipts.read

Path Parameters

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

Example: "410fc44a-5956-44e1-b5cc-19c6f8d727a4"

Query Parameters

midstringrequired
Short unique identifier for the merchant.

Example: "MH4H92C7"
tx_event_idinteger
Unique identifier of the transaction event to include on the receipt.

Example: 9567461191

Response

Returns receipt details for the requested transaction. See Receipt object.

transaction_dataReceipt Transaction
Transaction details displayed on a receipt.
Show attributes
Close
Receipt Transaction
- transaction_codestring
  Transaction code returned after processing the transaction.
  
  Example: "TEENSK4W2K"
- transaction_idTransaction ID
  Unique identifier of the transaction.
  
  Example: "410fc44a-5956-44e1-b5cc-19c6f8d727a4"
- merchant_codestring
  Short unique identifier for the merchant.
  
  Example: "MH4H92C7"
- amountstring
  Total transaction amount, in major units.
  
  Example: "10.10"
- vat_amountstring
  VAT included in the transaction amount, in major units.
  
  Example: "6.00"
- tip_amountstring
  Tip included in the transaction amount, in major units.
  
  Example: "3.00"
- currencystring
  Three-letter ISO 4217 currency code of the transaction.
  
  Example: "EUR"
- timestampstringformat: date-time
  The timestamp of when the transaction was created.
  
  Example: "2020-02-29T10:56:56.876Z"
- statusstring
  Current processing status of the transaction.
  
  Example: "SUCCESSFUL"
- payment_typestring
  Payment type used for the transaction.
  
  Example: "ECOM"
- entry_modestring
  Entry mode of the payment details.
  
  Example: "CUSTOMER_ENTRY"
- verification_methodstring
  Cardholder verification method.
  
  Example: "none"
- card_readerReceipt Reader
  Card reader details displayed on the receipt.
  
  Show attributes
  Close
  Receipt Reader
  codestring
  Unique identifier of the physical card reader.
  
  Example: "U1DT3NA00-CN"
  typestring
  Model of the physical card reader.
  
  Example: "solo"
- cardReceipt Card
  Payment card details displayed on the receipt.
  
  Show attributes
  Close
  Receipt Card
  last_4_digitsstring
  Last four digits of the payment card number.
  
  Example: "3456"
  typestring
  Issuing card network of the payment card.
  
  Example: "VISA"
- installments_countinteger
  Number of installments.
  
  Example: 1
- process_asstring
  Options: CREDITDEBIT
  Whether the transaction was processed as credit or debit.
  
  Example: "CREDIT"
- products[]object
  Products associated with the transaction.
  
  Show attributes
  Close
  Attributes
  namestring
  Product name.
  
  Example: "Coffee"
  descriptionstring
  Product description.
  
  Example: "Cappuccino"
  pricestringformat: double
  Product price.
  
  Example: "150.0"
  vat_ratestringformat: double
  VAT rate.
  
  Example: "0.0"
  single_vat_amountstringformat: double
  VAT amount for a single product.
  
  Example: "0.0"
  price_with_vatstringformat: double
  Product price including VAT.
  
  Example: "150.0"
  vat_amountstringformat: double
  Total VAT amount for the product quantity.
  
  Example: "0.0"
  quantityinteger
  Product quantity.
  
  Example: 1
  total_pricestringformat: double
  Total price calculated as the product price multiplied by the quantity.
  
  Example: "150.0"
  total_with_vatstringformat: double
  Total product price including VAT.
  
  Example: "150.0"
- vat_rates[]object
  VAT breakdown for the transaction.
  
  Show attributes
  Close
  Attributes
  grossnumber
  Gross amount to which the VAT rate applies.
  
  Example: 10.1
  netnumber
  Net amount to which the VAT rate applies.
  
  Example: 8.49
  ratenumber
  VAT rate applied to the transaction amount.
  
  Example: 0.19
  vatnumber
  VAT amount included in the gross amount.
  
  Example: 1.61
- events[]ReceiptEvent
  Transaction events displayed on the receipt.
  
  Show attributes
  Close
  Receipt Event
  idTransaction Event ID
  Unique identifier of the transaction event.
  
  Example: 9567461191
  transaction_idTransaction ID
  Unique identifier of the transaction.
  
  Example: "410fc44a-5956-44e1-b5cc-19c6f8d727a4"
  typeTransaction Event Type
  Options: PAYOUTCHARGE_BACKREFUNDPAYOUT_DEDUCTION
  Type of the transaction event.
  
  Example: "REFUND"
  statusTransaction Event Status
  Options: FAILEDPAID_OUTPENDINGRECONCILEDREFUNDEDSCHEDULEDSUCCESSFUL
  Status of the transaction event.
  
  Not every value is used for every event type.
  
  PENDING: The event has been created but is not final yet. Used for events that are still being processed and whose final outcome is not known yet.
  
  SCHEDULED: The event is planned for a future payout cycle but has not been executed yet. This applies to payout events before money is actually sent out.
  
  RECONCILED: The underlying payment has been matched with settlement data and is ready to continue through payout processing, but the funds have not been paid out yet. This applies to payout events.
  
  PAID_OUT: The payout event has been completed and the funds were included in a merchant payout.
  
  REFUNDED: A refund event has been accepted and recorded in the refund flow. This is the status returned for refund events once the transaction amount is being or has been returned to the payer.
  
  SUCCESSFUL: The event completed successfully. Use this as the generic terminal success status for event types that do not expose a more specific business outcome such as PAID_OUT or REFUNDED.
  
  FAILED: The event could not be completed. Typical examples are a payout that could not be executed or an event that was rejected during processing.
  
  Example: "SUCCESSFUL"
  amountstringformat: double
  Amount associated with the transaction event, in major units.
  
  Example: "10.10"
  timestampstringformat: date-time
  The timestamp of when the transaction event occurred.
  
  Example: "2020-05-25T10:49:42.784Z"
  receipt_nostring
  Receipt number associated with the event.
  
  Example: "123456"
- receipt_nostring
  Receipt number associated with the transaction.
  
  Example: "123456"
Example: {"transaction_code":"TEENSK4W2K","transaction_id":"410fc44a-5956-44e1-b5cc-19c6f8d727a4","merchant_code":"MH4H92C7","amount":"10.10","vat_amount":"6.00","tip_amount":"3.00","currency":"EUR","timestamp":"2020-02-29T10:56:56.876Z","status":"SUCCESSFUL","payment_type":"ECOM","entry_mode":"CUSTOMER_ENTRY","installments_count":1,"process_as":"CREDIT"}
merchant_dataReceipt Merchant Data
Merchant details displayed on a transaction receipt.
Show attributes
Close
Receipt Merchant Data
- merchant_profileobject
  Merchant profile details displayed on the receipt.
  
  Show attributes
  Close
  Attributes
  merchant_codestring
  Short unique identifier for the merchant.
  
  Example: "MH4H92C7"
  business_namestring
  Business name of the merchant.
  
  Example: "Coffee House"
  company_registration_numberstring
  Company registration number of the merchant.
  
  Example: "HRB 123456"
  vat_idstring
  VAT identification number of the merchant.
  
  Example: "DE123456789"
  websitestring
  Website of the merchant.
  
  Example: "https://example.com"
  emailstring
  Email address of the merchant.
  
  Example: "merchant@example.com"
  languagestring
  Language configured for the merchant profile.
  
  Example: "de"
  addressobject
  Business address of the merchant.
  
  Show attributes
  Close
  Attributes
  address_line1string
  First line of the merchant address.
  
  Example: "Sample street 1"
  address_line2string
  Second line of the merchant address.
  
  Example: "Floor 2"
  citystring
  City of the merchant address.
  
  Example: "Berlin"
  countrystring
  Two-letter ISO 3166-1 alpha-2 country code of the merchant address.
  
  Example: "DE"
  country_en_namestring
  English name of the country in the merchant address.
  
  Example: "Germany"
  country_native_namestring
  Localized name of the country in the merchant address.
  
  Example: "Deutschland"
  region_namestring
  Region or state of the merchant address.
  
  Example: "Berlin"
  post_codestring
  Postal code of the merchant address.
  
  Example: "10115"
  landlinestring
  Landline phone number of the merchant.
  
  Example: "+493012345678"
- localestring
  Locale used for rendering localized receipt fields.
  
  Example: "de-DE"
emv_dataobject
EMV-specific metadata returned for card-present payments.

Example: {}
acquirer_dataobject
Acquirer-specific metadata related to the card authorization.
Show attributes
Close
Attributes
- tidstring
  Identifier of the terminal used for the authorization.
  
  Example: "12345678"
- authorization_codestring
  Authorization code returned by the acquirer.
  
  Example: "053201"
- return_codestring
  Return code reported by the acquirer.
  
  Example: "00"
- local_timestring
  Local timestamp of the card authorization.
  
  Example: "2020-02-29T11:56:56+01:00"
Example: {"authorization_code":"053201","return_code":"00"}

1
curl https://api.sumup.com/v1.1/receipts/{transaction_id} \
2
 -X GET \
3
 -H "Authorization: Bearer $SUMUP_API_KEY"

1
import SumUp from '@sumup/sdk';
2

3
const client = new SumUp();
4

5
const result = await client.receipts.get("410fc44a-5956-44e1-b5cc-19c6f8d727a4", "MH4H92C7");

1
using SumUp;
2

3
var client = new SumUpClient();
4

5
var result = await client.Receipts.GetAsync(
6
    "410fc44a-5956-44e1-b5cc-19c6f8d727a4",
7
    "MH4H92C7"
8
);

1
import com.sumup.sdk.SumUpClient;
2

3
SumUpClient client = SumUpClient.builder().build();
4

5
var result = client.receipts().getReceipt(
6
  "410fc44a-5956-44e1-b5cc-19c6f8d727a4",
7
  "MH4H92C7"
8
);

1
from sumup import Sumup
2

3
client = Sumup()
4

5
result = client.receipts.get("410fc44a-5956-44e1-b5cc-19c6f8d727a4", "MH4H92C7")

1
$sumup = new \SumUp\SumUp();
2

3
$result = $sumup->receipts->get('410fc44a-5956-44e1-b5cc-19c6f8d727a4', 'MH4H92C7');

1
client := sumup.NewClient()
2

3
result, err := client.Receipts.Get(context.Background(), "410fc44a-5956-44e1-b5cc-19c6f8d727a4", "MH4H92C7")

1
use sumup::Client;
2

3
let client = Client::default();
4

5
let result = client.receipts().get("410fc44a-5956-44e1-b5cc-19c6f8d727a4", sumup::GetReceiptParams{
6
    mid: Some("MH4H92C7".to_string()),
7
    tx_event_id: Some(9567461191),
8
}).await;

1
{
2
  "transaction_data": {
3
    "transaction_code": "TEENSK4W2K",
4
    "transaction_id": "410fc44a-5956-44e1-b5cc-19c6f8d727a4",
5
    "merchant_code": "MH4H92C7",
6
    "amount": "10.10",
7
    "vat_amount": "6.00",
8
    "tip_amount": "3.00",
9
    "currency": "EUR",
10
    "timestamp": "2020-02-29T10:56:56.876Z",
11
    "status": "SUCCESSFUL",
12
    "payment_type": "ECOM",
13
    "entry_mode": "CUSTOMER_ENTRY",
14
    "installments_count": 1,
15
    "process_as": "CREDIT"
16
  },
17
  "merchant_data": {
18
    "merchant_profile": {
19
      "merchant_code": "MH4H92C7"
20
    }
21
  },
22
  "acquirer_data": {
23
    "authorization_code": "053201"
24
  }
25
}

Content-Type: application/json

The request is invalid for the submitted parameters.

messagestring
Short description of the error.

Example: "Resource not found"
error_codestring
Platform code for the error.

Example: "NOT_FOUND"

Content-Type: application/json

The request is not authorized.

typestringrequiredformat: uri
A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
titlestring
A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detailstring
A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instancestringformat: uri
A URI reference that identifies the specific occurrence of the problem.

Example: "https://api.sumup.com/v0.1/checkouts/4e425463-3e1b-431d-83fa-1e51c2925e99"

Content-Type: application/json

The requested transaction event does not exist for the provided transaction.

messagestring
Short description of the error.

Example: "Resource not found"
error_codestring
Platform code for the error.

Example: "NOT_FOUND"

1
{
2
  "message": "is not a valid merchant code",
3
  "error_code": "INVALID"
4
}

1
{
2
  "detail": "Unauthorized.",
3
  "status": 401,
4
  "title": "Unauthorized",
5
  "trace_id": "3c77294349d3b5647ea2d990f0d8f017",
6
  "type": "https://developer.sumup.com/problem/unauthorized"
7
}

1
{
2
  "message": "No such tx event (ID=9567461191) for transaction 4ffb8dfc-7f2b-413d-a497-2ad00766585e",
3
  "error_code": "NOT_FOUND"
4
}