Object Index

You are viewing an old version of the API

2020-06-25

Version 2020-06-25

• All Versions

Payment

Unique ID for the payment.

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

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

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

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

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

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.

Processing fees and fee adjustments assessed by Square on 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.

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

The duration of time after the payment's creation when Square automatically applies the delay_action to the payment. This automatic delay_action applies only to payments that don't reach a terminal state (COMPLETED, CANCELED, or FAILED) before the delay_duration time period.

This field is specified as a time duration, in RFC 3339 format.

Notes: This feature is only supported for card payments.

Default:

• Card Present payments: "PT36H" (36 hours) from the creation time.
• Card Not Present payments: "P7D" (7 days) from the creation time.

Example for 2 days, 12 hours, 30 minutes, and 15 seconds: P2DT12H30M15S

The action to be applied to the payment when the delay_duration has elapsed. This field is read only.

Current values include: CANCEL

Read only timestamp of when the delay_action will automatically be applied, in RFC 3339 format.

Note that this field is calculated by summing the payment's delay_duration and created_at fields. The created_at field is generated by Square and may not exactly match the time on your local machine.

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

The source type for this payment

Current values include: CARD.

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

ID of the location associated with the payment.

ID of the order associated with this payment.

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

The Customer ID of the customer associated with the payment.

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

List of refund_ids identifying refunds for this payment.

The buyer's e-mail address

The buyer's billing address

The buyer's shipping address

An optional note to include when creating a payment

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

Note that the statement_description_identifier 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.

The payment's receipt number. The field will be missing if a payment is CANCELED

The URL for the payment's receipt. The field will only be populated for COMPLETED payments.