Refunds to the card through the API: 8.5, 11.4 and which document charged the card
Refunding the card and reversing the sale are two moves. If the receipt charged the card, one 11.4 does both. If an 8.4 charged it, the refund is an 8.5 and the sale is reversed separately.
The guest paid by card and the order never arrived, or arrived wrong. The money has to go back to the card, and the sale has to be reversed. Those are two different things, and which document does each depends on a single question: which document charged the card.
Two moves: the money and the sale
- Refunding the money goes through the terminal and points at the document that charged the card.
- Reversing the sale is an 11.4 retail credit note, correlated to the original receipt's ΜΑΡΚ.
Depending on how the card was charged, the two moves take one document or two.
Which shape, depending on what charged the card
| The card was charged by | Refund | Reversing the sale |
|---|---|---|
The 11.1 receipt itself, on the terminal or with aade_ | One 11.4 that does both | |
| An 8.4, in a mixed payment | 8.5 POS Refund Receipt | A separate 11.4, no terminal |
When the receipt charged the card: one 11.4
An 11.4 credit note with:
pos_device_id, so the money goes back through the terminal,refund_invoice_idset to the Wrapp id of the original receipt,- the original's ΜΑΡΚ in
correlated_invoices.
It credits the sale and refunds the card together.
When an 8.4 charged the card: the 8.5 and the 11.4
The 8.5 POS Refund Receipt sends the money back through the terminal, with pos_device_id, payment_method_type: 3 and refund_invoice_id set to the Wrapp id of the 8.4. The 8.5's amount is the amount refunded, so one 8.4 also takes partial refunds. The 8.5 is issued once the terminal completes the refund. Its body is in the JSON examples for the refund to the card.
The sale is reversed with an 11.4 with no terminal, carrying the original's lines and payment method and its ΜΑΡΚ in correlated_invoices, as in the JSON examples for cancelling a receipt.
The mistake everyone makes: id or ΜΑΡΚ
The two link fields take different kinds of value. correlated_invoices takes a ΜΑΡΚ. refund_invoice_id takes the Wrapp id, the one the issuing call returned.
Refunding in cash
If the money is handed back in cash, nothing goes through the terminal. The sale is reversed with an 11.4 correlated to the original receipt, and that is all.
How to start
Sign up free at wrapp.ai with your VAT number and press "Try the API". On staging you test a charge and a refund with a Viva demo terminal, with no tax effect. How the card gets charged in the first place is explained in the guide to split payment and the card at the table.
Frequently asked questions
Which document refunds money to the card?
It depends on which document charged the card. If the 11.1 receipt itself charged it, one 11.4 credit note with pos_device_id and refund_invoice_id refunds the card and reverses the sale together. If an 8.4 charged it, the refund is a POS Refund Receipt 8.5.
Can I refund part of the amount to the card?
Yes, with the 8.5: its amount is the amount refunded, so one 8.4 also takes partial refunds.
What goes in refund_invoice_id?
The Wrapp id of the document that charged the card, the one the issuing call returned. Not a ΜΑΡΚ: the ΜΑΡΚ goes in correlated_invoices.
Is the 8.5 enough, or is a credit note needed too?
The 8.5 refunds the money. The sale is reversed separately, with an 11.4 with no terminal, correlated to the original receipt's ΜΑΡΚ.
When is the 8.5 issued?
Once the terminal completes the refund. The result arrives as with any transaction on the terminal.
Need help?
If you have a question about this topic or want to make sure everything is set up correctly, contact us and we will look at it together.