Object Index / Definition

You are viewing an old version of the API
Payment
V1

Note We recommend using the Square API (V2) for all new development when possible.

A payment represents a paid transaction between a Square merchant and a customer

Payment details are usually available from Connect API endpoints within a few minutes after the transaction completes.

Each Payment object includes several fields that end in _money. These fields describe the various amounts of money that contribute to the payment total:

  • Monetary values are positive if they represent an increase in the amount of money the merchant receives (e.g., tax_money, tip_money).
  • Monetary values are negative if they represent an decrease in the amount of money the merchant receives (e.g., discount_money, refunded_money).

Properties

Name Description
id
string

The payment's unique identifier.

additive_tax
V1​Payment​Tax [ ]

All of the additive taxes associated with the payment.

additive_tax_money
V1​Money

The sum of all additive taxes associated with the payment.

created_at
string

The time when the payment was created, in ISO 8601 format. Reflects the time of the first payment if the object represents an incomplete partial payment, and the time of the last or complete payment otherwise.

creator_id
string

The unique identifier of the Square account that took the payment.

device
Device

The device that took the payment.

discount_money
V1​Money

The total of all discounts applied to the payment.

gross_sales_money
V1​Money

The total of all sales, including any applicable taxes.

inclusive_tax
V1​Payment​Tax [ ]

All of the inclusive taxes associated with the payment.

inclusive_tax_money
V1​Money

The sum of all inclusive taxes associated with the payment.

is_partial
boolean

Indicates whether or not the payment is only partially paid for. If true, this payment will have the tenders collected so far, but the itemizations will be empty until the payment is completed.

itemizations
V1​Payment​Itemization [ ]

The items purchased in the payment.

merchant_id
string

The unique identifier of the merchant that took the payment.

net_sales_money
V1​Money

The total of all sales, minus any applicable taxes.

net_total_money
V1​Money

The amount to be deposited into the merchant's bank account for the payment.

payment_url
string

The URL of the payment's detail page in the merchant dashboard. The merchant must be signed in to the merchant dashboard to view this page.

processing_fee_money
V1​Money

The total of all processing fees collected by Square for the payment.

receipt_url
string

The URL of the receipt for the payment. Note that for split tender payments, this URL corresponds to the receipt for the first tender listed in the payment's tender field. Each Tender object has its own receipt_url field you can use to get the other receipts associated with a split tender payment.

refunded_money
V1​Money

The total of all refunds applied to the payment.

refunds
V1​Refund [ ]

All of the refunds applied to the payment. Note that the value of all refunds on a payment can exceed the value of all tenders if a merchant chooses to refund money to a tender after previously accepting returned goods as part of an exchange.

surcharge_money
V1​Money

The total of all surcharges applied to the payment.

surcharges
V1​Payment​Surcharge [ ]

A list of all surcharges associated with the payment.

swedish_rounding_money
V1​Money

The total of all sales, including any applicable taxes, rounded to the smallest legal unit of currency (e.g., the nearest penny in USD, the nearest nickel in CAD)

tax_money
V1​Money

The total of all taxes applied to the payment. This is always the sum of inclusivetaxmoney and additivetaxmoney.

tender
V1​Tender [ ]

All of the tenders associated with the payment.

tip_money
V1​Money

The total of all tips applied to the payment.

total_collected_money
V1​Money

The total of all discounts applied to the payment.

Share Feedback

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