Receipts

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

The Receipt object

Receipt

transaction_data object

Transaction information.
Show attributes
Close

Attributes
- 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 string 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
  
  Show attributes
  
  Close
  
  Attributes
  
  last_4_digits string
  
  Card last 4 digits.
  
  type string
  
  Card Scheme.
- installments_count integer
  
  Number of installments.
- products []object
  
  Products
  
  Show attributes
  
  Close
  
  Attributes
  
  name string
  
  Product name
  
  Example: "Coffee"
  
  price string double
  
  Product price
  
  Example: "150.0"
  
  vat_rate string double
  
  VAT rate
  
  Example: "0.0"
  
  single_vat_amount string double
  
  VAT amount for a single product
  
  Example: "0.0"
  
  price_with_vat string double
  
  Product price including VAT
  
  Example: "150.0"
  
  vat_amount string double
  
  VAT amount
  
  Example: "0.0"
  
  quantity integer
  
  Product quantity
  
  Example: 1
  
  total_price string double
  
  Quantity x product price
  
  Example: "150.0"
  
  total_with_vat string double
  
  Total price including VAT
  
  Example: "150.0"
- vat_rates []object
  
  Vat rates.
  
  Show attributes
  
  Close
  
  Attributes
  
  gross number
  
  Gross
  
  net number
  
  Net
  
  rate number
  
  Rate
  
  vat number
  
  Vat
- events []object
  
  Events
  
  Show attributes
  
  Close
  
  Attributes
  
  id integer
  
  Unique ID of the transaction event.
  
  transaction_id string
  
  Unique ID of the transaction.
  
  type string
  
  Type of the transaction event.
  
  status string
  
  Status of the transaction event.
  
  amount string double
  
  Amount of the event.
  
  timestamp string date-time
  
  Date and time of the transaction event.
  
  receipt_no string
- receipt_no string
  
  Receipt number
merchant_data object

Receipt merchant data
Show attributes
Close

Attributes
- merchant_profile object
  
  Show attributes
  
  Close
  
  Attributes
  
  merchant_code string
  
  Example: "MH4H92C7"
  
  business_name string
  
  email string
  
  address object
  
  Show attributes
  
  Close
  
  Attributes
  
  address_line1 string
  
  city string
  
  country string
  
  country_en_name string
  
  country_native_name string
  
  post_code string
  
  landline string
- locale string
emv_data object
acquirer_data object
Show attributes
Close

Attributes
- tid string
- authorization_code string
- return_code string
- local_time string

1
{
2
  "transaction_data": {
3
    "transaction_code": null,
4
    "amount": null,
5
    "vat_amount": null,
6
    "tip_amount": null,
7
    "currency": null,
8
    "timestamp": null,
9
    "status": null,
10
    "payment_type": null,
11
    "entry_mode": null,
12
    "verification_method": null,
13
    "card": {
14
      "last_4_digits": null,
15
      "type": null
16
    },
17
    "installments_count": null,
18
    "products": [
19
      {
20
        "name": "Coffee",
21
        "price": "150.0",
22
        "vat_rate": "0.0",
23
        "single_vat_amount": "0.0",
24
        "price_with_vat": "150.0",
25
        "vat_amount": "0.0",
26
        "quantity": 1,
27
        "total_price": "150.0",
28
        "total_with_vat": "150.0"
29
      }
30
    ],
31
    "vat_rates": [
32
      {
33
        "gross": null,
34
        "net": null,
35
        "rate": null,
36
        "vat": null
37
      }
38
    ],
39
    "events": [
40
      {
41
        "id": null,
42
        "transaction_id": null,
43
        "type": null,
44
        "status": null,
45
        "amount": null,
46
        "timestamp": null,
47
        "receipt_no": null
48
      }
49
    ],
50
    "receipt_no": null
51
  },
52
  "merchant_data": {
53
    "merchant_profile": {
54
      "merchant_code": "MH4H92C7",
55
      "business_name": null,
56
      "email": null,
57
      "address": {
58
        "address_line1": null,
59
        "city": null,
60
        "country": null,
61
        "country_en_name": null,
62
        "country_native_name": null,
63
        "post_code": null,
64
        "landline": null
65
      }
66
    },
67
    "locale": null
68
  },
69
  "emv_data": {},
70
  "acquirer_data": {
71
    "tid": null,
72
    "authorization_code": null,
73
    "return_code": null,
74
    "local_time": null
75
  }
76
}

Receipts

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

Receipt

transaction_data object

Transaction information.
Show attributes
Close

Attributes
- 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 string 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
  
  Show attributes
  
  Close
  
  Attributes
  
  last_4_digits string
  
  Card last 4 digits.
  
  type string
  
  Card Scheme.
- installments_count integer
  
  Number of installments.
- products []object
  
  Products
  
  Show attributes
  
  Close
  
  Attributes
  
  name string
  
  Product name
  
  Example: "Coffee"
  
  price string double
  
  Product price
  
  Example: "150.0"
  
  vat_rate string double
  
  VAT rate
  
  Example: "0.0"
  
  single_vat_amount string double
  
  VAT amount for a single product
  
  Example: "0.0"
  
  price_with_vat string double
  
  Product price including VAT
  
  Example: "150.0"
  
  vat_amount string double
  
  VAT amount
  
  Example: "0.0"
  
  quantity integer
  
  Product quantity
  
  Example: 1
  
  total_price string double
  
  Quantity x product price
  
  Example: "150.0"
  
  total_with_vat string double
  
  Total price including VAT
  
  Example: "150.0"
- vat_rates []object
  
  Vat rates.
  
  Show attributes
  
  Close
  
  Attributes
  
  gross number
  
  Gross
  
  net number
  
  Net
  
  rate number
  
  Rate
  
  vat number
  
  Vat
- events []object
  
  Events
  
  Show attributes
  
  Close
  
  Attributes
  
  id integer
  
  Unique ID of the transaction event.
  
  transaction_id string
  
  Unique ID of the transaction.
  
  type string
  
  Type of the transaction event.
  
  status string
  
  Status of the transaction event.
  
  amount string double
  
  Amount of the event.
  
  timestamp string date-time
  
  Date and time of the transaction event.
  
  receipt_no string
- receipt_no string
  
  Receipt number
merchant_data object

Receipt merchant data
Show attributes
Close

Attributes
- merchant_profile object
  
  Show attributes
  
  Close
  
  Attributes
  
  merchant_code string
  
  Example: "MH4H92C7"
  
  business_name string
  
  email string
  
  address object
  
  Show attributes
  
  Close
  
  Attributes
  
  address_line1 string
  
  city string
  
  country string
  
  country_en_name string
  
  country_native_name string
  
  post_code string
  
  landline string
- locale string
emv_data object
acquirer_data object
Show attributes
Close

Attributes
- tid string
- authorization_code string
- return_code string
- local_time string

1
curl https://api.sumup.com/v1.1/receipts/{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("id", "mid");

1
using SumUp;
2

3
var client = new SumUpClient();
4

5
var result = await client.Receipts.GetAsync(
6
    "id",
7
    "mid"
8
);

1
import com.sumup.sdk.SumUpClient;
2

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

5
var result = client.receipts().getReceipt(
6
  "id",
7
  "mid"
8
);

1
from sumup import Sumup
2

3
client = Sumup()
4

5
result = client.receipts.get("id", "mid")

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

3
$result = $sumup->receipts->get('id', 'mid');

1
client := sumup.NewClient()
2

3
result, err := client.Receipts.Get(context.Background(), "id", "mid")

1
use sumup::Client;
2

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

5
let result = client.receipts().get("id", sumup::GetReceiptParams{
6
    mid: Some("mid".to_string()),
7
    tx_event_id: Some("tx_event_id".to_string()),
8
}).await;

1
{
2
  "transaction_data": {
3
    "transaction_code": null,
4
    "amount": null,
5
    "vat_amount": null,
6
    "tip_amount": null,
7
    "currency": null,
8
    "timestamp": null,
9
    "status": null,
10
    "payment_type": null,
11
    "entry_mode": null,
12
    "verification_method": null,
13
    "card": {
14
      "last_4_digits": null,
15
      "type": null
16
    },
17
    "installments_count": null,
18
    "products": [
19
      {
20
        "name": "Coffee",
21
        "price": "150.0",
22
        "vat_rate": "0.0",
23
        "single_vat_amount": "0.0",
24
        "price_with_vat": "150.0",
25
        "vat_amount": "0.0",
26
        "quantity": 1,
27
        "total_price": "150.0",
28
        "total_with_vat": "150.0"
29
      }
30
    ],
31
    "vat_rates": [
32
      {
33
        "gross": null,
34
        "net": null,
35
        "rate": null,
36
        "vat": null
37
      }
38
    ],
39
    "events": [
40
      {
41
        "id": null,
42
        "transaction_id": null,
43
        "type": null,
44
        "status": null,
45
        "amount": null,
46
        "timestamp": null,
47
        "receipt_no": null
48
      }
49
    ],
50
    "receipt_no": null
51
  },
52
  "merchant_data": {
53
    "merchant_profile": {
54
      "merchant_code": "MH4H92C7",
55
      "business_name": null,
56
      "email": null,
57
      "address": {
58
        "address_line1": null,
59
        "city": null,
60
        "country": null,
61
        "country_en_name": null,
62
        "country_native_name": null,
63
        "post_code": null,
64
        "landline": null
65
      }
66
    },
67
    "locale": null
68
  },
69
  "emv_data": {},
70
  "acquirer_data": {
71
    "tid": null,
72
    "authorization_code": null,
73
    "return_code": null,
74
    "local_time": null
75
  }
76
}