V1Payment

Description

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	Type	Description	Notes
id	String	The payment's unique identifier.	[optional]
merchantId	String	The unique identifier of the merchant that took the payment.	[optional]
createdAt	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.	[optional]
creatorId	String	The unique identifier of the Square account that took the payment.	[optional]
device	Device	The device that took the payment.	[optional]
paymentUrl	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.	[optional]
receiptUrl	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.	[optional]
inclusiveTaxMoney	V1Money	The sum of all inclusive taxes associated with the payment.	[optional]
additiveTaxMoney	V1Money	The sum of all additive taxes associated with the payment.	[optional]
taxMoney	V1Money	The total of all taxes applied to the payment. This is always the sum of inclusive_tax_money and additive_tax_money.	[optional]
tipMoney	V1Money	The total of all tips applied to the payment.	[optional]
discountMoney	V1Money	The total of all discounts applied to the payment.	[optional]
totalCollectedMoney	V1Money	The total of all discounts applied to the payment.	[optional]
processingFeeMoney	V1Money	The total of all processing fees collected by Square for the payment.	[optional]
netTotalMoney	V1Money	The amount to be deposited into the merchant's bank account for the payment.	[optional]
refundedMoney	V1Money	The total of all refunds applied to the payment.	[optional]
swedishRoundingMoney	V1Money	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)	[optional]
grossSalesMoney	V1Money	The total of all sales, including any applicable taxes.	[optional]
netSalesMoney	V1Money	The total of all sales, minus any applicable taxes.	[optional]
inclusiveTax	List<V1PaymentTax>	All of the inclusive taxes associated with the payment.	[optional]
additiveTax	List<V1PaymentTax>	All of the additive taxes associated with the payment.	[optional]
tender	List<V1Tender>	All of the tenders associated with the payment.	[optional]
refunds	List<V1Refund>	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.	[optional]
itemizations	List<V1PaymentItemization>	The items purchased in the payment.	[optional]
surchargeMoney	V1Money	The total of all surcharges applied to the payment.	[optional]
surcharges	List<V1PaymentSurcharge>	A list of all surcharges associated with the payment.	[optional]
isPartial	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.	[optional]