Structured receipt details for a transaction. The transaction's amount, vat_amount, and tip_amount, as well as event amounts, are returned as decimal strings in major currency units, for example "10.10" for EUR 10.10.
Fields
- transaction_dataobject
Transaction details displayed on a receipt.
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"}Show 20 properties
- transaction_codestring
Transaction code returned after processing the transaction.
Example:
"TEENSK4W2K" - transaction_idstring
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-timeThe 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_readerobject
Card reader details displayed on the receipt.
- cardobject
Payment card details displayed on the receipt.
Show 2 properties
- 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_asstringOptions:
"CREDIT""DEBIT"Whether the transaction was processed as credit or debit.
Example:
"CREDIT" - productsarray<object>
Products associated with the transaction.
Show 10 properties
- namestring
Product name.
Example:
"Coffee" - descriptionstring
Product description.
Example:
"Cappuccino" - pricestringformat:
doubleProduct price.
Example:
"150.0" - vat_ratestringformat:
doubleVAT rate.
Example:
"0.0" - single_vat_amountstringformat:
doubleVAT amount for a single product.
Example:
"0.0" - price_with_vatstringformat:
doubleProduct price including VAT.
Example:
"150.0" - vat_amountstringformat:
doubleTotal VAT amount for the product quantity.
Example:
"0.0" - quantityintegerformat:
int64Product quantity.
Example:
1 - total_pricestringformat:
doubleTotal price calculated as the product price multiplied by the quantity.
Example:
"150.0" - total_with_vatstringformat:
doubleTotal product price including VAT.
Example:
"150.0"
- vat_ratesarray<object>
VAT breakdown for the transaction.
Show 4 properties
- grossnumberformat:
floatGross amount to which the VAT rate applies.
Example:
10.1 - netnumberformat:
floatNet amount to which the VAT rate applies.
Example:
8.49 - ratenumberformat:
floatVAT rate applied to the transaction amount.
Example:
0.19 - vatnumberformat:
floatVAT amount included in the gross amount.
Example:
1.61
- eventsarray<object>
Transaction events displayed on the receipt.
Show 7 properties
- idintegerformat:
int64Numeric identifier of a transaction event. Use it as
tx_event_idwhen requesting receipt details for a specific event. This is separate from the transaction ID and the transaction history pagination references.Example:
9567461191 - transaction_idstring
Unique identifier of the transaction.
Example:
"410fc44a-5956-44e1-b5cc-19c6f8d727a4" - typestringOptions:
"PAYOUT""CHARGE_BACK""REFUND""PAYOUT_DEDUCTION"Financial event associated with a transaction.
PAYOUT: Funds from the transaction being prepared for or included in a merchant payout. Check the event status to determine whether they have been paid out.REFUND: Money returned to the payer.CHARGE_BACK: A reversal of the payment following a chargeback.PAYOUT_DEDUCTION: An amount deducted from a merchant payout, for example to cover a refund or chargeback.
Example:
"REFUND" - statusstringOptions:
"FAILED""PAID_OUT""PENDING""RECONCILED""REFUNDED""SCHEDULED""SUCCESSFUL"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 asPAID_OUTorREFUNDED.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:
doubleAmount associated with the transaction event, in major units.
Example:
"10.10" - timestampstringformat:
date-timeThe 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"
- merchant_dataobject
Merchant details displayed on a transaction receipt.
Show 2 properties
- merchant_profileobject
Merchant profile details displayed on the receipt.
Show 8 properties
- merchant_codestring
Short unique identifier for the merchant.
Example:
"MH4H92C7" - business_namestring
Business name of the merchant.
Example:
"Coffee House" 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 9 properties
- 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.
Example:
{"authorization_code":"053201","return_code":"00"}Show 4 properties
- tidstring
Identifier of the terminal used for the authorization.
Example:
"12345678" - 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"