OrderNPayPayment
Model
Required
decimal(13, 2)
amountSale :
number (decimal)
The sale amount paid for, EXCLUDING any tips, surcharges and service charges
Required
MaxLength(32)
name :
string
The name of the payment method (eg visa)
Nullable
MaxLength(64)
providerPaymentID :
string
The unique id for this line from the provider
Nullable
decimal(13, 2)
amountTip :
number (decimal)
The tip amount
Nullable
decimal(13, 2)
amountSurcharge :
number (decimal)
The amount of any payment surcharges (eg 1% Credit Card surcharge) applied
Nullable
decimal(13, 2)
explicitServiceChargeAmount :
number (decimal)
Defines an explicit service charge amount specified by the provider.
Null means automatic service charge, ie let POS figure it out. The pos calculated SC portion is then deducted automatically from the AmountSale.
If a value is set, then it is an explicit service charge total, and the sale amount is assumed to already be exclusive of this.
Nullable
MaxLength(40)
merchantID :
string
The merchant id of the payment
Nullable
MaxLength(40)
terminalID :
string
The terminal id of the payment
Example
{
"amountSale": 1.23,
"name": "string value",
"providerPaymentID": "string value",
"amountTip": 1.23,
"amountSurcharge": 1.23,
"explicitServiceChargeAmount": 1.23,
"merchantID": "string value",
"terminalID": "string value"
}