Skip to content

Latest commit

 

History

History
75 lines (63 loc) · 4.39 KB

v1-payment.md

File metadata and controls

75 lines (63 loc) · 4.39 KB
Raw

V1 Payment

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).

Structure

V1 Payment

Fields

Name Type Tags Description
id string Optional The payment's unique identifier.
merchant_id string Optional The unique identifier of the merchant that took the payment.
created_at string Optional 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 Optional The unique identifier of the Square account that took the payment.
device Device Optional -
payment_url string Optional 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.
receipt_url string Optional 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.
inclusive_tax_money V1 Money Optional -
additive_tax_money V1 Money Optional -
tax_money V1 Money Optional -
tip_money V1 Money Optional -
discount_money V1 Money Optional -
total_collected_money V1 Money Optional -
processing_fee_money V1 Money Optional -
net_total_money V1 Money Optional -
refunded_money V1 Money Optional -
swedish_rounding_money V1 Money Optional -
gross_sales_money V1 Money Optional -
net_sales_money V1 Money Optional -
inclusive_tax List of V1 Payment Tax Optional All of the inclusive taxes associated with the payment.
additive_tax List of V1 Payment Tax Optional All of the additive taxes associated with the payment.
tender List of V1 Tender Optional All of the tenders associated with the payment.
refunds List of V1 Refund Optional 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.
itemizations List of V1 Payment Itemization Optional The items purchased in the payment.
surcharge_money V1 Money Optional -
surcharges List of V1 Payment Surcharge Optional A list of all surcharges associated with the payment.
is_partial bool Optional 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.

Example (as JSON)

{
  "id": "id0",
  "merchant_id": "merchant_id0",
  "created_at": "created_at2",
  "creator_id": "creator_id0",
  "device": {
    "id": "id6",
    "name": "name6"
  }
}