Object Index / Definition

You are viewing an old version of the API

2019-11-20

Version 2019-11-20

• All Versions

Payment

Unique ID for the payment.

The amount of money processed for this payment, not including tip_money. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see Working with monetary amounts.

The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents.

For more information, see
Take Payments and Collect Fees.

Cannot be more than 90% of the total_money value.

The buyer's billing address

The buyer's e-mail address

Non-confidential details about the source. Only populated if the source_type is CARD.

Timestamp of when the payment was created, in RFC 3339 format.

An optional customer_id to be entered by the developer when creating a payment.

An optional ID of the employee associated with taking this payment.

ID of the location associated with the payment.

An optional note to include when creating a payment

ID of the order associated with this payment.

Processing fees and fee adjustments assessed by Square on this payment.

An optional ID that associates this payment with an entity in another system.

List of refund_ids identifying refunds for this payment.

Total amount of the payment refunded to-date. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents.

The buyer's shipping address

The source type for this payment

Current values include: CARD

Additional payment information that gets added on the customer's card statement as part of the statement description.

Note that the statementdescriptionidentifier may get truncated on the statement description to fit the required information including the Square identifier (SQ *) and name of the merchant taking the payment.

Indicates whether the payment is APPROVED, COMPLETED, CANCELED, or FAILED.

The amount designated as a tip. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents.

The total money for the payment, including amount_money and tip_money. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents.

Timestamp of when the payment was last updated, in RFC 3339 format.