Represents a single payment for a remote order that has been collected by the provider
Required
remoteOrderPaymentID :
string (GUID)
The primary key for this remote order payment generated by ROS.
A third party provider should omit this property entirely OR leave this as Guid.Empty. ROS will overwrite it and return the new value at order submission
Required
decimal(18, 2)
amountPaid :
number (decimal)
The amount of money this payment is contributing to the parent orders balance.
This amount will NOT include AmountOutletTip/AmountOutletServiceCharge if that is specified.
Nullable
MaxLength(64)
providerPaymentID :
string
unique ID received from provider for this payment
Can be null
Nullable
MaxLength(32)
providerPaymentType :
string
Provider defined payment/media type (eg CASH, CC, VISA) to be mapped by POS
Can be null
Nullable
decimal(18, 2)
amountOutletTip :
number (decimal)
The amount of tip that has been applied to this remote order. This amount does NOT contribute to the parent orders balance or collected tax.
The tip does NOT represent a tip for a specific individual but rather for the entire restaurant. It is up to the outlet to manage how this tip will be
distributed amongst staff (if at all).
POS will record this amount but the outlet will be responsible to ensure they account for it according to local legal requirements.
A null value indicates that no tip was entered.
If specified - this amount will NOT modify AmountPaid. It will instead need to be charged to the customer in addition to AmountPaid.
Nullable
decimal(18, 2)
amountOutletServiceCharge :
number (decimal)
The amount of service charge that has been applied to this remote order. Service charges are primarily utilised in the UK market. This amount
does NOT contribute to the parent orders balance or collected tax.
Service charges are defined by the outlet in conjunction with the provider. The application of service charges are an outlet decision
and the provider should be working with the outlet directly in order to determine whether a service charge (if any) should be applied to orders.
If specified - this amount will NOT modify AmountPaid. It will instead need to be charged to the customer in addition to AmountPaid.
Example
{
"remoteOrderPaymentID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"amountPaid": 1.23,
"providerPaymentID": "string value",
"providerPaymentType": "string value",
"amountOutletTip": 1.23,
"amountOutletServiceCharge": 1.23
}