Payment Method
Object
PaymentMethod
Implements
List of interfaces this object implements
| Fields | Type | Description |
|---|---|---|
|
id |
The ID of the payment method |
|
|
name |
String! |
The local name of the payment method (displayed on the register and on receipts) |
|
type |
The type of payment method (controls how customers pay) |
|
|
surcharge |
Float |
The surcharge amount (not currently in use) |
|
denominations |
[Float] |
A list of denominations to use for predictions |
|
actualDenominations |
[Float] |
The denominations to display on the close register screen |
|
alwaysOpenDrawer |
Boolean |
Whether to always open the cash drawer when paying with the payment method |
|
alwaysPrint |
Boolean |
Whether to always print a receipt when paying with the payment method |
|
useRounding |
Boolean |
Whether this setting uses the Vendor's rounding amount to round payments to |
|
cashoutMethod |
The method to use for providing cash out, if null, cash out is not allowed |
|
|
defaultPayExact |
Boolean |
Whether we should default to paying the full remaining amount of the sale when selecting this payment method |
|
gatewayUrl |
String |
The URL to use to perform the payment, only applicable when the |
|
backgroundColour |
String |
The colour to display on the background of this payment method when in the sell screen |
|
textColour |
String |
The colour to set the text of this payment method when in the sell screen |
|
darkModeBackgroundColour |
String |
The colour to display on the background of this payment method when in the sell screen and in dark mode |
|
darkModeTextColour |
String |
The colour to set the text of this payment method when in the sell screen and in dark mode |