Object Index
/ Definition
You are viewing an old version of the API
Payment
Object Index / Definition
Represents a payment processed by the Square API.
Properties
| Name | Description |
|---|---|
id
|
Unique ID for the payment. |
created_at
|
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 |
updated_at
|
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 |
amount_money
|
The amount of money processed for this payment, not including |
tip_money
|
The amount designated as a tip. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. |
total_money
|
The total money for the payment, including |
app_fee_money
|
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 |
processing_fee
|
Processing fees and fee adjustments assessed by Square on this payment. |
refunded_money
|
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. |
status
|
Indicates whether the payment is |
delay_duration
Beta
|
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_action
Beta
|
The action to be applied to the payment when the Current values include:
|
delayed_until
Beta
|
Read only timestamp of when the Note that this field is calculated by summing the payment's 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 |
source_type
|
The source type for this payment Current values include:
|
card_details
|
Non-confidential details about the source. Only populated if the
|
location_id
|
ID of the location associated with the payment. |
order_id
|
ID of the order associated with this payment. |
reference_id
|
An optional ID that associates this payment with an entity in another system. |
customer_id
|
An optional customer_id to be entered by the developer when creating a payment. |
employee_id
|
An optional ID of the employee associated with taking this payment. |
refund_ids
|
List of |
buyer_email_address
|
The buyer's e-mail address |
billing_address
|
The buyer's billing address |
shipping_address
|
The buyer's shipping address |
note
|
An optional note to include when creating a payment |
statement_description_identifier
Beta
|
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. |
receipt_number
|
The payment's receipt number. The field will be missing if a payment is CANCELED |
receipt_url
|
The URL for the payment's receipt. The field will only be populated for COMPLETED payments. |