- DATE:
- AUTHOR:
- The Toast - API team
New credit card payment surcharge information in orders API
The AppliedServiceCharge
object in the orders API includes information about credit card payment surcharges and also service charges in two new values:
serviceChargeCategory
- the type of the service charge or surcharge. Values are:SERVICE_CHARGE
- the default value. Used for service charges that are not in one of the other categories.CREDIT_CARD_SURCHARGE
- a fee assessed only on payment transactions that use a credit card.FUNDRAISING_CAMPAIGN
- a service charge applied for a charity or similar fundraising effort.paymentGuid
- the unique identifier of the credit card payment that a credit card surcharge service charge is applied to. You can use this identifier to match a service charge to aPayment
object on aCheck
. ThepaymentGuid
value isnull
for any service charge that is not a credit card surcharge.
The Toast platform functionality that sets this service charge and surcharge information in the orders API is in limited release. Initially, API orders only include service charge and surcharge information for orders created by the Toast POS app.