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 information.
Show attributes
Close
Receipt Transaction
- transaction_codestring
  Transaction code.
- transaction_idTransaction ID
  Unique ID of the transaction.
- merchant_codestring
  Merchant code.
- amountstring
  Transaction amount.
- vat_amountstring
  Transaction VAT amount.
- tip_amountstring
  Tip amount (included in transaction amount).
- currencystring
  Transaction currency.
- timestampstringformat: date-time
  Time created at.
- statusstring
  Transaction processing status.
- payment_typestring
  Transaction type.
- entry_modestring
  Transaction entry mode.
- verification_methodstring
  Cardholder verification method.
- card_readerReceipt Reader
  Card reader details displayed on the receipt.
  
  Show attributes
  Close
  Receipt Reader
  codestring
  Reader serial number.
  
  typestring
  Reader type.
- cardReceipt Card
  Payment card details displayed on the receipt.
  
  Show attributes
  Close
  Receipt Card
  last_4_digitsstring
  Card last 4 digits.
  
  typestring
  Card Scheme.
- installments_countinteger
  Number of installments.
- process_asstring
  Options: CREDITDEBIT
  Debit/Credit.
  
  Example: "CREDIT"
- products[]object
  Products
  
  Show attributes
  Close
  Attributes
  namestring
  Product name
  
  Example: "Coffee"
  descriptionstring
  Product description
  
  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
  VAT amount
  
  Example: "0.0"
  quantityinteger
  Product quantity
  
  Example: 1
  total_pricestringformat: double
  Quantity x product price
  
  Example: "150.0"
  total_with_vatstringformat: double
  Total price including VAT
  
  Example: "150.0"
- vat_rates[]object
  Vat rates.
  
  Show attributes
  Close
  Attributes
  grossnumber
  Gross
  
  netnumber
  Net
  
  ratenumber
  Rate
  
  vatnumber
  Vat
- events[]ReceiptEvent
  Events
  
  Show attributes
  Close
  Receipt Event
  idEvent ID
  Unique ID of the transaction event.
  
  transaction_idTransaction ID
  Unique ID of the transaction.
  
  typeEvent Type
  Options: PAYOUTCHARGE_BACKREFUNDPAYOUT_DEDUCTION
  Type of the transaction event.
  
  statusEvent 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.
  
  amountstringformat: double
  Amount of the event.
  
  timestampstringformat: date-time
  Date and time of the transaction event.
  
  receipt_nostring
  Receipt number associated with the event.
- receipt_nostring
  Receipt number
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
Receipt merchant data
Show attributes
Close
Receipt Merchant Data
- merchant_profileobject
  Merchant profile details displayed on the receipt.
  
  Show attributes
  Close
  Attributes
  merchant_codestring
  Example: "MH4H92C7"
  business_namestring
  company_registration_numberstring
  vat_idstring
  websitestring
  emailstring
  languagestring
  addressobject
  Show attributes
  Close
  Attributes
  address_line1string
  address_line2string
  citystring
  countrystring
  country_en_namestring
  country_native_namestring
  region_namestring
  post_codestring
  landlinestring
- localestring
  Locale used for rendering localized receipt fields.
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
- authorization_codestring
- return_codestring
- local_timestring
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": null,
21
      "company_registration_number": null,
22
      "vat_id": null,
23
      "website": null,
24
      "email": null,
25
      "language": null,
26
      "address": {
27
        "address_line1": null,
28
        "address_line2": null,
29
        "city": null,
30
        "country": null,
31
        "country_en_name": null,
32
        "country_native_name": null,
33
        "region_name": null,
34
        "post_code": null,
35
        "landline": null
36
      }
37
    },
38
    "locale": null
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.

Path Parameters

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

Query Parameters

midstringrequired
Merchant code.
tx_event_idinteger
The ID of the transaction event (refund).

Response

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

transaction_dataReceipt Transaction
Transaction information.
Show attributes
Close
Receipt Transaction
- transaction_codestring
  Transaction code.
- transaction_idTransaction ID
  Unique ID of the transaction.
- merchant_codestring
  Merchant code.
- amountstring
  Transaction amount.
- vat_amountstring
  Transaction VAT amount.
- tip_amountstring
  Tip amount (included in transaction amount).
- currencystring
  Transaction currency.
- timestampstringformat: date-time
  Time created at.
- statusstring
  Transaction processing status.
- payment_typestring
  Transaction type.
- entry_modestring
  Transaction entry mode.
- verification_methodstring
  Cardholder verification method.
- card_readerReceipt Reader
  Card reader details displayed on the receipt.
  
  Show attributes
  Close
  Receipt Reader
  codestring
  Reader serial number.
  
  typestring
  Reader type.
- cardReceipt Card
  Payment card details displayed on the receipt.
  
  Show attributes
  Close
  Receipt Card
  last_4_digitsstring
  Card last 4 digits.
  
  typestring
  Card Scheme.
- installments_countinteger
  Number of installments.
- process_asstring
  Options: CREDITDEBIT
  Debit/Credit.
  
  Example: "CREDIT"
- products[]object
  Products
  
  Show attributes
  Close
  Attributes
  namestring
  Product name
  
  Example: "Coffee"
  descriptionstring
  Product description
  
  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
  VAT amount
  
  Example: "0.0"
  quantityinteger
  Product quantity
  
  Example: 1
  total_pricestringformat: double
  Quantity x product price
  
  Example: "150.0"
  total_with_vatstringformat: double
  Total price including VAT
  
  Example: "150.0"
- vat_rates[]object
  Vat rates.
  
  Show attributes
  Close
  Attributes
  grossnumber
  Gross
  
  netnumber
  Net
  
  ratenumber
  Rate
  
  vatnumber
  Vat
- events[]ReceiptEvent
  Events
  
  Show attributes
  Close
  Receipt Event
  idEvent ID
  Unique ID of the transaction event.
  
  transaction_idTransaction ID
  Unique ID of the transaction.
  
  typeEvent Type
  Options: PAYOUTCHARGE_BACKREFUNDPAYOUT_DEDUCTION
  Type of the transaction event.
  
  statusEvent 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.
  
  amountstringformat: double
  Amount of the event.
  
  timestampstringformat: date-time
  Date and time of the transaction event.
  
  receipt_nostring
  Receipt number associated with the event.
- receipt_nostring
  Receipt number
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
Receipt merchant data
Show attributes
Close
Receipt Merchant Data
- merchant_profileobject
  Merchant profile details displayed on the receipt.
  
  Show attributes
  Close
  Attributes
  merchant_codestring
  Example: "MH4H92C7"
  business_namestring
  company_registration_numberstring
  vat_idstring
  websitestring
  emailstring
  languagestring
  addressobject
  Show attributes
  Close
  Attributes
  address_line1string
  address_line2string
  citystring
  countrystring
  country_en_namestring
  country_native_namestring
  region_namestring
  post_codestring
  landlinestring
- localestring
  Locale used for rendering localized receipt fields.
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
- authorization_codestring
- return_codestring
- local_timestring
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("transaction_id", "mid");

1
using SumUp;
2

3
var client = new SumUpClient();
4

5
var result = await client.Receipts.GetAsync(
6
    "transaction_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
  "transaction_id",
7
  "mid"
8
);

1
from sumup import Sumup
2

3
client = Sumup()
4

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

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

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

1
client := sumup.NewClient()
2

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

1
use sumup::Client;
2

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

5
let result = client.receipts().get("transaction_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": "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.

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
}