Payment
The Payment family — 6 operations.
A payment is a card charge against an order as the processor sees it — authorized (the hold), captured, settled or failed. Payments are made at the till and the online channels, never here; the back office reads them here — the amount, the tip, the currency, the card brand and last four, and the processor references — and follows each one to its order and its tender.
Operations
| Operation | Kind | What it does |
|---|---|---|
| authorizePayment | mutation | Authorize a card payment — reserve the money on the customer’s card without taking it yet. |
| cancelPayment | mutation | Cancel a payment on an order. |
| capturePayment | mutation | Capture an authorized card payment — actually take the reserved money. |
| payment | query | Look up one record — a payment on an order. |
| payments | query | The payment list — each entry is a payment on an order. |
| voidPayment | mutation | Void a payment on an order — cancel it as if it should not have happened, keeping the paper trail. |