Object Index

You are viewing an old version of the API

2022-11-16

Version 2022-11-16

• All Versions

Payment

Read only A unique ID for the payment.

Read only The timestamp of when the payment was created, in RFC 3339 format.

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

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

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

Read only The timestamp of when the payment was last updated, in RFC 3339 format.

Examples for January 25th, 2020 6:25: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 processed for this payment, not including tip_money.

The amount is 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.

This amount is 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.

Read only The total amount for the payment, including amount_money and tip_money. This amount is 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 the developer is taking as a fee for facilitating the payment on behalf of the seller. This amount is 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.

The amount cannot be more than 90% of the total_money value.

To set this field, PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS OAuth permission is required. For more information, see Permissions.

The initial amount of money approved for this payment.

Read only The processing fees and fee adjustments assessed by Square for this payment.

Read only The total amount of the payment refunded to date.

This amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents).

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

Read only 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 do not 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.

Current values include CANCEL and COMPLETE.

Read only The read-only timestamp of when the delay_action is automatically 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 might not exactly match the time on your local machine.

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

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

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

Read only The source type for this payment.

Current values include CARD, BANK_ACCOUNT, WALLET, BUY_NOW_PAY_LATER, CASH and EXTERNAL. For information about these payment source types, see Take Payments.

Read only Details about a card payment. These details are only populated if the source_type is CARD.

Details about a cash payment. These details are only populated if the source_type is CASH.

Read only Details about a bank account payment. These details are only populated if the source_type is BANK_ACCOUNT.

Read only Details about an external payment. The details are only populated if the source_type is EXTERNAL.

Read only Details about an wallet payment. The details are only populated if the source_type is WALLET.

Read only Details about a Buy Now Pay Later payment. The details are only populated if the source_type is BUY_NOW_PAY_LATER. For more information, see Afterpay Payments.

Read only The ID of the location associated with the payment.

Read only The ID of the order associated with the payment.

Read only An optional ID that associates the payment with an entity in another system.

Read only The ID of the customer associated with the payment. If the ID is not provided in the CreatePayment request that was used to create the Payment, Square may use information in the request (such as the billing and shipping address, email address, and payment source) to identify a matching customer profile in the Customer Directory. If found, the profile ID is used. If a profile is not found, the API attempts to create an instant profile. If the API cannot create an instant profile (either because the seller has disabled it or the seller's region prevents creating it), this field remains unset. Note that this process is asynchronous and it may take some time before a customer ID is added to the payment.

Read only Deprecated: Use Payment.team_member_id instead.

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

Read only An optional ID of the TeamMember associated with taking the payment.

Read only A list of refund_ids identifying refunds for the payment.

Read only Provides information about the risk associated with the payment, as determined by Square. This field is present for payments to sellers that have opted in to receive risk evaluations.

Read only The buyer's email address.

Read only The buyer's billing address.

Read only The buyer's shipping address.

Read only An optional note to include when creating a payment.

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

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

Read only Actions that can be performed on this payment:

• EDIT_AMOUNT_UP - The payment amount can be edited up.
• EDIT_AMOUNT_DOWN - The payment amount can be edited down.
• EDIT_TIP_AMOUNT_UP - The tip amount can be edited up.
• EDIT_TIP_AMOUNT_DOWN - The tip amount can be edited down.
• EDIT_DELAY_ACTION - The delay_action can be edited.

Read only The payment's receipt number. The field is missing if a payment is canceled.

Read only The URL for the payment's receipt. The field is only populated for COMPLETED payments.

Read only Details about the device that took the payment.

Read only Details about the application that took the payment.

Used for optimistic concurrency. This opaque token identifies a specific version of the Payment object.