• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
PaymentSurcharge
V1
Square V1 APIs

We recommend using the Square API (V2) for all new development when possible. See When to use Connect V1 to learn more about working with V1 endpoints.

V1PaymentSurcharge

Properties

Name Description
name
string

The name of the surcharge.

applied_money
Money

The amount of money applied to the order as a result of the surcharge.

rate
string

The amount of the surcharge as a percentage. The percentage is provided as a string representing the decimal equivalent of the percentage. For example, "0.7" corresponds to a 7% surcharge. Exactly one of rate or amount_money should be set.

amount_money
Money

The amount of the surcharge as a Money object. Exactly one of rate or amount_money should be set.

type
string

Indicates the source of the surcharge. For example, if it was applied as an automatic gratuity for a large group.

taxable
boolean

Indicates whether the surcharge is taxable.

taxes
PaymentTax [ ]

The list of taxes that should be applied to the surcharge.

surcharge_id
string

A Square-issued unique identifier associated with the surcharge.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?