Object Index
You are viewing an old version of the API
Payment
Object Index
Represents a payment processed by the Square API.
Properties
Name | Description |
---|---|
id
|
Read only A unique ID for the payment. |
created_
|
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 |
updated_
|
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 |
amount_
|
The amount processed for this payment, not including 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. |
tip_
|
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. |
total_
|
Read only The total amount for the payment, including |
app_
|
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 To set this field, |
approved_
|
The initial amount of money approved for this payment. |
processing_
|
Read only The processing fees and fee adjustments assessed by Square for this payment. |
refunded_
|
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). |
status
|
Read only Indicates whether the payment is APPROVED, PENDING, COMPLETED, CANCELED, or FAILED. |
delay_
|
Read only The duration of time after the payment's creation when Square automatically applies the
This field is specified as a time duration, in RFC 3339 format. Notes: This feature is only supported for card payments. Default:
Example for 2 days, 12 hours, 30 minutes, and 15 seconds: P2DT12H30M15S |
delay_
|
The action to be applied to the payment when the Current values include |
delayed_
|
Read only The read-only timestamp of when the Note that this field is calculated by summing the payment's 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 |
source_
|
Read only The source type for this payment. Current values include |
card_
|
Read only Details about a card payment. These details are only populated if the source_type is |
cash_
|
Details about a cash payment. These details are only populated if the source_type is |
bank_
|
Read only Details about a bank account payment. These details are only populated if the source_type is |
external_
|
Read only Details about an external payment. The details are only populated
if the |
wallet_
|
Read only Details about an wallet payment. The details are only populated
if the |
buy_
|
Read only Details about a Buy Now Pay Later payment. The details are only populated
if the |
location_
|
Read only The ID of the location associated with the payment. |
order_
|
Read only The ID of the order associated with the payment. |
reference_
|
Read only An optional ID that associates the payment with an entity in another system. |
customer_
|
Read only The Customer ID of the customer associated with the payment. |
employee_
Deprecated
|
Read only Deprecated: Use An optional ID of the employee associated with taking the payment. |
team_
|
Read only An optional ID of the TeamMember associated with taking the payment. |
refund_
|
Read only A list of |
risk_
Beta
|
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. |
buyer_
|
Read only The buyer's email address. |
billing_
|
Read only The buyer's billing address. |
shipping_
|
Read only The buyer's shipping address. |
note
|
Read only An optional note to include when creating a payment. |
statement_
|
Read only Additional payment information that gets added to the customer's card statement as part of the statement description. Note that the |
capabilities
|
Read only Actions that can be performed on this payment:
|
receipt_
|
Read only The payment's receipt number. The field is missing if a payment is canceled. |
receipt_
|
Read only The URL for the payment's receipt. The field is only populated for COMPLETED payments. |
device_
|
Read only Details about the device that took the payment. |
application_
|
Read only Details about the application that took the payment. |
version_
|
Used for optimistic concurrency. This opaque token identifies a specific version of the
|