Nullified payment receipt template

Use our sample template for creating nullified payment receipts.

A nullified payment is when a payment transaction is cancelled, by the customer or sales associate on the pin entry device (PED) or in the InStore colleague app; or when a payment is rejected by a third-party payment system. The nullified payment receipt provides proof for the customer that no payment was taken from their account.

You can view the nullified payment receipt in the InStore Center by creating a new Receipt Template set that includes the nullified payment receipt template, then editing it.

Template

1. `{{logo 32 32}}`
2. `{align:center}`
3. `{{location.description}}`
4. `{{location.address_line_1}}{{#if location.address_line_2}}\n{{location.address_line_2}}{{/if}}`
5. `{{location.city}}`
6. `{{location.state}}`
7. `{{location.postal_code}}`
8. `{{location.telephone_number}}`
9. `{align:left}`
10. `|Date: |{{timestamp_formatted}}`
11. `|Workstation: |{{workstation_id}}`
12. `|Cashier: |{{user_id}}`
13. `|Transaction #: |{{order_number}}`
14.
15. `{{#if charge_card}}`
16. `{{#if charge_card.additional_data}}`
17. `{{#if charge_card.additional_data.receiptData}}`
18. `{width:16,20; align:right}`
19. `|Card: | {{charge_card.additional_data.receiptData.pan}}`
20. `|PAN seq: | {{charge_card.additional_data.receiptData.panSeq}}`
21. `|Pref. name: | {{charge_card.additional_data.receiptData.preferredName}}`
22. `|Card type: | {{charge_card.additional_data.receiptData.cardType}}`
23. `|Payment method: | {{charge_card.additional_data.receiptData.paymentMethod}}`
24. `|Payment variant: | {{charge_card.additional_data.receiptData.paymentMethodVariant}}`
25. `|Entry mode: | {{charge_card.additional_data.receiptData.posEntryMode}}`
26. `|AID: | {{charge_card.additional_data.receiptData.aid}}`
27. `|MID: | {{charge_card.additional_data.receiptData.mid}}`
28. `|TID: | {{charge_card.additional_data.receiptData.tid}}`
29. `|PTID: | {{charge_card.additional_data.receiptData.ptid}}`
30. `|Auth. code: | {{charge_card.additional_data.receiptData.authCode}}`
31. `|Response code: | {{charge_card.authorization_response_code}}`
32. `|Tender: | {{charge_card.additional_data.receiptData.txRef}}`
33. `|Reference: | {{charge_card.additional_data.receiptData.mref}}`
34. `|Type: | {{charge_card.additional_data.receiptData.txtype}}`
35. `|^TOTAL: | {{formatCurrency charge_card.additional_data.receiptData.totalAmount}}`
36. `{{/if}}{{else}}`
37. `{width:24,20; align:right}`
38. `|card number: | {{charge_card.last4}}`
39. `|account type: | {{charge_card.brand}}/{{charge_card.account_type}}`
40. `|application name: | {{charge_card.application_preferred_name}}`
41. `|AID: | {{charge_card.dedicated_file_name}}`
42. `|ARC: | {{authorization_response_code}}`
43. `{{/if}}{{/if}}`
44. `{{#if gift_card}}`
45. `{width:16,20; align:right}`
46. `|card number: | *{{gift_card.last4}}`
47. `|card type: | {{gift_card.type}}`
48. `{{/if}}`
49. `{{#if wallet}}`
50. `{width:16,20; align:right}`
51. `method: {{wallet.method}}`
52. `|transaction id: | {{wallet.transaction_id}}`
53. `|merchant id: | {{wallet.merchant_id}}`
54. `|terminal id: | {{wallet.terminal_id}}`
55. `{{/if}}`

Line number descriptions

Location and address data is pulled from fields on the Location Information page in the InStore Center.

Line number	Source and description of field
1	Prints the logo image that the you previously injected into the physical printer memory at position 32 32 in the printer. See your printer manufacturer documentation for logo injection and printing capabilities for the particular make and model.
2	Aligns the following text to the center of the page.
3	Inserts the location name from the Location Name field.
4	Inserts the first line of the address from the Address Line 1 field. Also inserts Address Line 2 if it contains text.
5	Inserts the town or city from the City/Town field.
6	Inserts the state or county from the State or Province/County field.
7	Inserts the post code from the Postal Code field.
8	Inserts the phone number from the Telephone Number field.
9	Aligns the following text to the left of the page.
10	Creates a table that formats this line and those that follow into two columns with plain-language text as labels in the left column. Inserts `timestamp_formatted` from the server that stores the location's database and uses database-determined formatting.
11	Inserts the `workstation_id` for the workstation where the transaction was completed.
12	Inserts the `user_id_` of the user who was logged in when the sale was tendered.
13	Inserts the `order_number` that was assigned to this transaction by InStore; this is also visible on Search Transactions page of the InStore Center.
14	Blank line, which renders as white space (linefeed) on the receipt.
15	Sets a condition that the following formatting will be used if one of the tenders listed is a `charge_card`, which is a credit or debit card.
16	Sets a condition that the following formatting is used if there is `additional.information` available about the `charge_card`.
17	Sets a condition that the following formatting will be used if there is a `receipt.data` package returned by the payment service provider (PSP) for the `charge_card`.
18	Defines the width of each column in the next table level to be created and aligns the text to the right. Column 1 is `16` characters wide and column 2 is `20` characters wide.
19-35	Creates a table that displays information that was returned in the `receipt.data` package. For more information, contact your PSP.
36	Ends the subsection that formats `receipt.data` and starts an `else` subsection for any `charge_card` that lacks a PSP provided `receipt.data`.
37	Defines the width of each column in the next table level to be created and aligns the text to the right. Column 1 is `24` characters wide and column 2 is `20` characters wide.
38-42	Creates a table that displays information that was returned for the `charge_card`.
43	Ends the subsections that format the `additional.information` and `charge_card` conditions.
44	Sets a condition that the following formatting will be used if the attempted payment contains a tender type of `gift_card`.
45	Defines the width of each column in the next table level to be created and aligns the text to the right. Column 1 is `16` characters wide and column 2 is `20` characters wide.
46-47	Creates a table that displays the `gift_card.last4` (obtained from the user who swiped, scanned, or typed the gift card) and the `gift_card.type` (returned by the gift card processor).
48	Ends the subsection that formats `gift_card` information.
49	Sets a condition that the following formatting will be used if the attempted payment contained a tender type of `wallet`
50	Defines the width of each column in the next table level to be created and aligns the text to the right. Column 1 is `16` characters wide and column 2 is `20` characters wide.
51	Displays a label and the `wallet.method` that was used to collect payment. For example type, tap, swipe, or insert.
52-54	Creates a table that displays the information returned by the wallet processor.
55	Ends the subsection that formats the `wallet` information.

You don't need a cutfeed directive, as ReceiptLine automatically adds this when it reaches the end of the template.