Tip Adjust
The following PayProtocol (P3) Tip Adjust messages are supported by the PayServer. Also
seeMessage
Specification.
Tip Adjust allows you to offer your US-based restaurants a traditional, receipt-based
tipping workflow for both magstripe and EMV transactions. To activate this feature, contact
your account manager.
Run Charge and Provide Printed Receipt
The waiter takes the payment card from the guest back to the POS
System and runs a CHARGE transaction for the invoice amount
(excluding any tips). Your POS System then prints merchant and
shopper receipts that include lines for Tip and Total Amount.
The guest receives the payment card together with the printed receipts from the waiter and
can fill in the desired Tip and / or Total Amounts at their discretion. If required, the
guest also provides their signature. Once the guest has left, the waiter collects the
receipt and stores it for later Tip Adjust.
To perform a
CHARGE
that can be Tip Adjusted later
on, modify the EXECUTE_TRANSACTION_REQUEST
to include
"tipAdjustable": true
for the initial transaction:{ "tag": "abc123", "type": "EXECUTE_TRANSACTION_REQUEST", "resource": "devices/usbReader", "executeTransactionRequest": { "transactionParameters": { "type": "CHARGE", "amount": 10.00, "currency": "USD", "subject": "Bouquet of Flowers", "customIdentifier": "yourReferenceForTheTransaction", "tipAdjustable": true } } }
For details on how to implement the required
EXECUTE_TRANSACTION
messages, see Message
Specification.Make sure to always provide printed merchant and shopper
receipts and especially ensure to print the lines for Tip and
Total Amount if
tipLineRequired
equals
true
.Performing Tip Adjust
At the end of the shift or business day, the waiter can perform the Tip Adjust on the
respective transactions. It is not required to perform a zero-amount adjust for transactions
without tip.
To implement Tip Adjust, your POS System needs to allow the waiter to first relocate the
transaction (e.g., by entering a POS-provided invoice number printed on the payment
receipt), and then to specify the Tip Amount as written down by the guest.
To perform a Tip Adjust, send a
AMEND_TRANSACTION_REQUEST
message with
type
TIP_ADJUST
that contains the transactionIdentifier
of the
transaction that should be adjusted and the Tip Amount (not the Total Amount) that should be
added:{ "tag": "abc123", "type": "AMEND_TRANSACTION_REQUEST", "amendTransactionRequest": { "transactionParameters": { "type": "TIP_ADJUST", "amount": 2.00, "currency": "USD", "referencedTransactionIdentifier": "transactionIdentifier" } } }
Check for
state
APPROVED
in AMEND_TRANSACTION_RESPONSE
to find out whether
the Tip Adjust was successful!.Implementation Considerations
- 20% Adjust Limit:As per card scheme rules you are allowed to perform a Tip Adjust for up to 20% of the original invoice amount. Higher amounts will be rejected.
- Printed Receipts:The Tip Adjust workflow is based on printed merchant and shopper receipts, so make sure your POS System implements them.
- Invoice Number:In order to make it easy for the waiter to retrieve transactions for Tip Adjust, we strongly recommend to print a short, POS-provided invoice number on each receipt. Your POS System should then store thetransactionIdentifieras part of your invoice data.
- 24 Hour Time Limit:It is possible to run a Tip Adjust up to 24 hours after the initialCHARGE. You can determine this also programatically via thetransactionobject by checking forADJUSTABLEas thetransaction.details.tipAdjustStatus.