In the admin
On the order
The card details Pay Sync writes to each Shopify order and where to find them.
After a card payment is approved, Pay Sync writes the terminal's answer onto the Shopify order. It lets you match a sale to the terminal provider's report.
#Where do I find it?
- In the Shopify admin, open the order.
- Scroll to Metafields.
- Select View all, then View read only metafields.
The fields are read only. You cannot edit them on the order, and Pay Sync writes them from the terminal's answer, the provider's report, or a slip someone captured (see Capture source below).
Note: Fields appear after the sale is linked to the order. An order that was not paid on a terminal has none of these fields.
#What is written?
| Field name | What it holds |
|---|---|
| Terminal RRN | The retrieval reference number of the card sale. Printed on the slip. |
| Terminal UTI | The unique transaction identifier. The terminal provider's report prints it, so it ties the order to a line in that report. |
| Terminal batch number | The batch the sale belongs to in the provider's report. |
| Authorisation code | The bank's authorisation code for the sale. |
| Terminal ID | The ID of the terminal that took the payment. |
| Terminal STAN | The system trace audit number from the terminal. |
| Terminal outcome | The answer from the bank, for example APPROVED. |
| Card scheme | The card brand, for example Visa or Mastercard. |
| Masked card number | The card number with the middle hidden. Never the full number. |
| Capture source | How the payment reached the order. See below. |
| Terminal paid at | The date and time of the approval. |
| Terminal amount | The total approved on the terminal for this order. |
| Terminal refund RRNs | The reference of each card refund on the order. Only present after a refund. |
| Terminal transactions | Every card transaction on the order, sales and refunds, as a block of structured text for software to read. |
#What is Capture source?
It tells you how Pay Sync learned about the payment.
| Value | Meaning |
|---|---|
| POS_PUSH | The cashier sent the amount to the terminal from POS. |
| MANUAL_CAPTURE | Someone typed the details from the printed slip. |
| BATCH_IMPORT | Pay Sync found the payment in the terminal provider's nightly report. |
| SIMULATOR | The answer came from Simulator mode, not from a real terminal. |
#What does SIMULATOR mean?
In Simulator mode Pay Sync makes up a pretend bank answer, so you can practise without a terminal. Every simulated answer is marked SIMULATOR under Capture source, and in the Terminal transactions field, so a pretend reference number can never be mistaken for a real one.
Careful: If you see SIMULATOR on an order, no card was charged. Do not treat the RRN, UTI or authorisation code on it as a real payment. See Getting started and Connecting terminals for moving to real payments.
#Which payment do the main fields describe?
The single-value fields describe the first approved sale on the order. The exception is Terminal amount, which adds up every approved card sale on the order. If a sale was split across two cards, the amount is the total and the full detail of each card is in Terminal transactions.
#Can I filter orders by these fields?
Yes. Terminal RRN, Terminal UTI, Terminal batch number and Terminal ID can be used as filters, so you can find an order from a slip or a line in the provider's report.
#What if the fields are missing?
If a sale was approved but the order has no fields, Pay Sync raises an exception for a person to look at. See Exceptions.
Note: If a customer returns goods on an order older than 60 days, the refund to the card still goes through, but Pay Sync cannot update that order's fields. The write fails and a Write-back failures exception is raised.