Skip to content
Myver logo Myver logo Myver

Receipt delivery

POST

Posted to the subscriber’s registered URL when a receipt is ready for delivery.

Request Body required

Section titled “Request Body required ”
object
subscriptionId
string
Example
sub-33MxMppykHWC9eb3tSjWqWEK8qg
reference
required

Freeform reference used for correlation in client system

string
<= 50 characters
Example
CUST-134422
receiptUrl
required
string
Example
https://receipts.myver.io/...
merchant
DeliveryMerchant
object
storeName
required

Name of the store.

string
storeAddress

Address as printed on the receipt.

string
email

Contact email address of the store.

string format: email
website

Website URL of the store.

string format: uri
phoneNumber

Contact phone number of the store.

string
countryCode
required

Country code (ISO 3166-1 alpha-2).

string
>= 2 characters <= 2 characters
Example
DK
vatId

VAT identifier, prefixed with country code, e.g. DK74590552.

string
brandName
required

Name of the brand.

string
squaredLogo
string format: uri
Example
https://cdn.myver.io/brands/acme/logo-squared.png
primaryColor
string
Example
#FF5733
receipt
DeliveryReceipt
object
header
required
DeliveryHeader
object
created
required

Timestamp of when the receipt was issued.

string format: date-time
Example
2025-08-25T08:57:37+00:00
documentType
string
default: receipt
Allowed values: receipt invoice creditNote return
Example
receipt
status
string
default: paid
Allowed values: pending paid partiallyRefunded refunded other
Example
paid
receiptId

Receipt ID internal to the store

string
Example
50450120058
orderId

Order ID internal to the store.

string
Example
345-499
purchaseOrderId

Purchase Order ID internal to the customer.

string
Example
R331883
cashier

Operator of the cash register, can be a number or the name of the cashier. Informational element, do not assume any specific syntax or localization.

string
Example
Anders H.
cashRegister

Reference of the cash register. Informational element, do not assume any specific syntax or localization.

string
Example
Till 2
customer
DeliveryCustomer
object
name
required

Name of the customer

string
Example
Lars Jensen
address

As the store wants to have it printed on the receipt

string
Example
Strandvejen 102, 3. th.
2900 Hellerup
countryCode

Country code as defined in ISO 3166-1 alpha 2

string
>= 2 characters <= 2 characters
Example
DK
customerId

Customer ID, as defined by the store, identified e.g., through loyalty or online shopping

string
vatId

VAT identifier

string
Example
DK74590552
lineItems

Line items of the receipt. The order of items in this array determines the rendering order.

Array<object>
DeliveryLineItem

LineItem

object
id
Line Item ID

A unique identifier for the individual line item

string
quantity
required
DeliveryQuantity

The quantity of items (goods or services)

object
value
required
number format: decimal
default: 1
Example
2.5
unit
required
DeliveryUnit

Commercial units of measure

string
default: each
Allowed values: each
description
required

A textual description of the line item.

string
modifiers
Array<object>
DeliveryModifier

Modifiers to the line, e.g. discounts and additional charges

object
amount
VatMoney

Monetary amount in a specific currency, with representation for VAT. Either gross or net must be specified.

object
net

Amount of money without VAT, represented as a number with optional fractional part.

number format: decimal
Example
120.25
gross

Amount of money with VAT, represented as a number with optional fractional part.

number format: decimal
Example
150.32
vat

Amount of money representing the VAT amount, represented as a number with optional fractional part.

number format: decimal
Example
30.07
currency
required
Currency

ISO 4217 three-letter currency code.

string
>= 3 characters <= 3 characters /^[A-Z]{3}$/
Example
USD
description
string
type
string
Allowed values: discount adjustment customization
item
DeliveryItem
object
sku

Unique ID internal to the store

string
gtin

Globally unique ID for product as defined by GS1 GTIN, typically EAN or UPC.

string
/^\d{8}(?:\d{4,6})?$/
unitPrice
VatMoney

Monetary amount in a specific currency, with representation for VAT. Either gross or net must be specified.

object
net

Amount of money without VAT, represented as a number with optional fractional part.

number format: decimal
Example
120.25
gross

Amount of money with VAT, represented as a number with optional fractional part.

number format: decimal
Example
150.32
vat

Amount of money representing the VAT amount, represented as a number with optional fractional part.

number format: decimal
Example
30.07
currency
required
Currency

ISO 4217 three-letter currency code.

string
>= 3 characters <= 3 characters /^[A-Z]{3}$/
Example
USD
lineAmount
required
VatMoney

Monetary amount in a specific currency, with representation for VAT. Either gross or net must be specified.

object
net

Amount of money without VAT, represented as a number with optional fractional part.

number format: decimal
Example
120.25
gross

Amount of money with VAT, represented as a number with optional fractional part.

number format: decimal
Example
150.32
vat

Amount of money representing the VAT amount, represented as a number with optional fractional part.

number format: decimal
Example
30.07
currency
required
Currency

ISO 4217 three-letter currency code.

string
>= 3 characters <= 3 characters /^[A-Z]{3}$/
Example
USD
totals
required

Totals lines of the receipt. The order of items in this array determines the rendering order.

Array<object>
DeliveryTotal

Totals summation of a particular type

object
description
string
type
required
Totals Type
string
default: amountDue
Allowed values: amountDue subTotal vat payment shipping handling discounts prepaid storeCredit tips tax surcharge refunds
sum
required
Money

Monetary amount in a specific currency.

object
amount
required

Amount of money, represented as a number with optional fractional part.

number format: decimal
Example
19.99
currency
required
Currency

ISO 4217 three-letter currency code.

string
>= 3 characters <= 3 characters /^[A-Z]{3}$/
Example
USD
payments
required
Array<object>
Any of: discriminator: paymentType
DeliveryCardPayment
object
paymentType
required
string
default: card
Allowed values: card
amountPaid
required
Money

Monetary amount in a specific currency.

object
amount
required

Amount of money, represented as a number with optional fractional part.

number format: decimal
Example
19.99
currency
required
Currency

ISO 4217 three-letter currency code.

string
>= 3 characters <= 3 characters /^[A-Z]{3}$/
Example
USD
paymentTypeLabel

Type of card that was used. Informational element, do not assume any specific syntax or localization.

string
Example
DEBIT MASTERCARD
paymentAccountReference

Payment Account Reference (PAR) is 29 characters long. The first four positions of the PAR contain the BIN Controller Identifier. See: https://www.emvco.com/registered-ids

string
>= 29 characters <= 29 characters
Example
12345678912345678912345678912
transactionId

Unique identifier generated by the bank, gateway, or store system.

string
retrievalReferenceNumber

Retrieval Reference Number (RRN). Unique transaction identifier from the payment network (ISO 8583 DE37).

string
acquirerReferenceNumber

Acquirer Reference Number (ARN).

string
systemTraceAuditNumber

System Trace Audit Number (STAN), 6 digits.

string
<= 6 characters
Example
123456
lastFour

Last four digits of the payment card that was used.

string
>= 4 characters <= 4 characters
Example
4931
approvalCode

Approval Code, sometimes printed as AUTH on the receipt.

string
terminalId

ID of the terminal used to capture the payment.

string
terminalSlip

Verbatim representation of the terminal slip.

string
barcodes

Barcodes printed on the receipt.

Array<object>
Barcode

A barcode on the receipt.

object
type
required

The barcode symbology.

string
Allowed values: interleavedTwoOfFive qr
purpose
required

The intended purpose of the barcode.

string
Allowed values: lookup selfServiceExitGate
content
required

The encoded content of the barcode.

string
attachments
Array<object>
DeliveryAttachment
object
href
required
string format: uri
Example
https://cdn.example.com/abc123/receipt.pdf
filename
required
string
Example
receipt.pdf
contentType
required
string
Example
application/pdf
documentType
string
Example
receipt
description
string
Example
Receipt for your purchase

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Receipt received