Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 1.29 KB

v1-payment-surcharge.md

File metadata and controls

40 lines (31 loc) · 1.29 KB
Raw

V1 Payment Surcharge

V1PaymentSurcharge

Structure

V1 Payment Surcharge

Fields

Name Type Tags Description
name string Optional The name of the surcharge.
applied_money V1 Money Optional -
rate string Optional 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 V1 Money Optional -
type str (V1 Payment Surcharge Type) Optional -
taxable bool Optional Indicates whether the surcharge is taxable.
taxes List of V1 Payment Tax Optional The list of taxes that should be applied to the surcharge.
surcharge_id string Optional A Square-issued unique identifier associated with the surcharge.

Example (as JSON)

{
  "name": "name0",
  "applied_money": {
    "amount": 196,
    "currency_code": "LYD"
  },
  "rate": "rate0",
  "amount_money": {
    "amount": 186,
    "currency_code": "KRW"
  },
  "type": "CUSTOM"
}