Skip to content
Myver logo Myver logo Myver

Submit receipt

POST
/v1/sources/{sourceId}/receipts

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
sourceId
string
Example
src-33MxMq4MYpTSMw4xgkW9mGSe9p0

Source ID

Request Body

Section titled “Request Body ”
Receipt

Receipt

object
header
required
ReceiptHeader
object
storeId
required

ID of the store that issued the receipt

string
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
printed

Whether the receipt was originally printed

boolean
customer
Customer
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
required

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

Array<object>
LineItem

LineItem

object
id
Line Item ID

A unique identifier for the individual line item

string
quantity
required
Quantity

The quantity of items (goods or services)

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

Commercial units of measure

string
default: each
Allowed values: each
description
required

A textual description of the line item.

string
modifiers
Array<object>
LineModifier

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
Item
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>
Total

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
CardPayment
object
paymentType
required
string
default: card
Allowed values: card
paid
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. Format may be numeric, alphanumeric, or UUID depending on implementation. Not standardized across networks. Used for internal tracking within the originating system and may not be valid outside that system.

string
retrievalReferenceNumber

Retrieval Reference Number (RRN). Unique transaction identifier from the payment network (ISO 8583 DE37). Typically a 12-digit string (UPI, card networks); may vary by system. Generated by acquirer/network, not store. Treat as string and preserve any leading zeros.

string
lastFour

Last four digits of the payment card that was used

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

System Trace Audit Number (STAN), 6 digits, sometimes printed as REF on the receipt.

string
<= 6 characters
Example
123456
terminalId

ID of the terminal used to capture the payment.

string
approvalCode

Approval Code, sometimes printed as AUTH on the receipt.

string
terminalSlip

Verbatim representation of the terminal slip, typically output directly from the terminal itself.

string
Example
Term: 19400085-970006
2025-01-01 12:06
DEBIT MASTERCARD
Contactless
************3204-0
AID: A0000000001010
ATC: 00256
AED:230801
TVR: 0000008001
Sted: 1111112
Ref.: 430639 010124 KC1
Resp.: 00
Periode: 169
KB
DKK               14,00
GODKENDT
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

File attachments on the receipt (e.g. PDF copies of the original receipt).

Array<object>
Any of: discriminator: type
LinkAttachment

An external URL hosted by the vendor. Only the reference is stored.

object
type
required
string
default: link
Allowed values: link
documentType

The type of document the attachment represents.

string
default: receipt
Allowed values: receipt
Example
receipt
description

Optional human-readable description of the attachment.

string
Example
Original receipt PDF
contentType
required

MIME type of the attachment content. Allowed values: application/pdf

string
/^application\/pdf$/
Example
application/pdf
filename

Original filename of the attachment, used for display purposes only. Not used as the storage key.

string
Example
receipt-12345.pdf
href
required

The external URL where the vendor hosts the file.

string format: uri
Example
https://vendor.example.com/receipts/12345.pdf

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Receipt created

object
receiptUrl
required

URL to view the receipt

string format: uri
Example
https://receipts.myver.io/#1a2b3c...

400

Section titled “400 ”

Bad or malformed request

RFC 9457 problem details object.

object
type

A URI reference that identifies the problem type.

string format: uri
default: about:blank
title

Short, human-readable summary of the problem type.

string
status

HTTP status code for this occurrence of the problem.

integer format: int32
>= 100 <= 599
detail

Human-readable explanation specific to this occurrence.

string
instance

A URI reference that identifies the specific occurrence.

string format: uri

401

Section titled “401 ”

Unauthorized

RFC 9457 problem details object.

object
type

A URI reference that identifies the problem type.

string format: uri
default: about:blank
title

Short, human-readable summary of the problem type.

string
status

HTTP status code for this occurrence of the problem.

integer format: int32
>= 100 <= 599
detail

Human-readable explanation specific to this occurrence.

string
instance

A URI reference that identifies the specific occurrence.

string format: uri

403

Section titled “403 ”

Forbidden

RFC 9457 problem details object.

object
type

A URI reference that identifies the problem type.

string format: uri
default: about:blank
title

Short, human-readable summary of the problem type.

string
status

HTTP status code for this occurrence of the problem.

integer format: int32
>= 100 <= 599
detail

Human-readable explanation specific to this occurrence.

string
instance

A URI reference that identifies the specific occurrence.

string format: uri