Receipts | SumUp Developer

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

The Receipt object

Receipt details for a transaction.

transaction_data Receipt Transaction

Transaction information.
Show attributes
Close

Receipt Transaction
- 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 format: 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 Receipt Card
  
  Payment card details displayed on the receipt.
  
  Show attributes
  
  Close
  
  Receipt Card
  
  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 format: double
  
  Product price
  
  Example: "150.0"
  
  vat_rate string format: double
  
  VAT rate
  
  Example: "0.0"
  
  single_vat_amount string format: double
  
  VAT amount for a single product
  
  Example: "0.0"
  
  price_with_vat string format: double
  
  Product price including VAT
  
  Example: "150.0"
  
  vat_amount string format: double
  
  VAT amount
  
  Example: "0.0"
  
  quantity integer
  
  Product quantity
  
  Example: 1
  
  total_price string format: double
  
  Quantity x product price
  
  Example: "150.0"
  
  total_with_vat string format: 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 []ReceiptEvent
  
  Events
  
  Show attributes
  
  Close
  
  Receipt Event
  
  id Event ID
  
  Unique ID of the transaction event.
  
  transaction_id Transaction ID
  
  Unique ID of the transaction.
  
  type Event Type
  
  Options: PAYOUTCHARGE_BACKREFUNDPAYOUT_DEDUCTION
  
  Type of the transaction event.
  
  status Event Status
  
  Options: PENDINGSCHEDULEDFAILEDREFUNDEDSUCCESSFULPAID_OUT
  
  Status of the transaction event.
  
  amount string format: double
  
  Amount of the event.
  
  timestamp string format: date-time
  
  Date and time of the transaction event.
  
  receipt_no string
  
  Receipt number associated with the event.
- receipt_no string
  
  Receipt number
merchant_data Receipt Merchant Data

Receipt merchant data
Show attributes
Close

Receipt Merchant Data
- merchant_profile object
  
  Merchant profile details displayed on the receipt.
  
  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
  
  Locale used for rendering localized receipt fields.
emv_data object

EMV-specific metadata returned for card-present payments.
acquirer_data object

Acquirer-specific metadata related to the card authorization.
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

GET /v1.1/receipts/{id}

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

Response

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

transaction_data Receipt Transaction

Transaction information.
Show attributes
Close

Receipt Transaction
- 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 format: 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 Receipt Card
  
  Payment card details displayed on the receipt.
  
  Show attributes
  
  Close
  
  Receipt Card
  
  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 format: double
  
  Product price
  
  Example: "150.0"
  
  vat_rate string format: double
  
  VAT rate
  
  Example: "0.0"
  
  single_vat_amount string format: double
  
  VAT amount for a single product
  
  Example: "0.0"
  
  price_with_vat string format: double
  
  Product price including VAT
  
  Example: "150.0"
  
  vat_amount string format: double
  
  VAT amount
  
  Example: "0.0"
  
  quantity integer
  
  Product quantity
  
  Example: 1
  
  total_price string format: double
  
  Quantity x product price
  
  Example: "150.0"
  
  total_with_vat string format: 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 []ReceiptEvent
  
  Events
  
  Show attributes
  
  Close
  
  Receipt Event
  
  id Event ID
  
  Unique ID of the transaction event.
  
  transaction_id Transaction ID
  
  Unique ID of the transaction.
  
  type Event Type
  
  Options: PAYOUTCHARGE_BACKREFUNDPAYOUT_DEDUCTION
  
  Type of the transaction event.
  
  status Event Status
  
  Options: PENDINGSCHEDULEDFAILEDREFUNDEDSUCCESSFULPAID_OUT
  
  Status of the transaction event.
  
  amount string format: double
  
  Amount of the event.
  
  timestamp string format: date-time
  
  Date and time of the transaction event.
  
  receipt_no string
  
  Receipt number associated with the event.
- receipt_no string
  
  Receipt number
merchant_data Receipt Merchant Data

Receipt merchant data
Show attributes
Close

Receipt Merchant Data
- merchant_profile object
  
  Merchant profile details displayed on the receipt.
  
  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
  
  Locale used for rendering localized receipt fields.
emv_data object

EMV-specific metadata returned for card-present payments.
acquirer_data object

Acquirer-specific metadata related to the card authorization.
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
}

Content-Type: application/json

The request is invalid for the submitted parameters.

message string

Short description of the error.
error_code string

Platform code for the error.

Content-Type: application/json

The request is not authorized.

type string required format: uri

A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
title string

A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
status integer

The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detail string

A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instance string format: uri

A URI reference that identifies the specific occurrence of the problem.

Content-Type: application/json

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

message string

Short description of the error.
error_code string

Platform code for the error.

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
}