Skip to content

Latest commit

 

History

History
39 lines (34 loc) · 5.57 KB

Payment.md

File metadata and controls

39 lines (34 loc) · 5.57 KB

SquareConnect.Payment

Description

Represents a payment processed by the Square API.

Properties

Name Type Description Notes
id String Unique ID for the payment. [optional]
created_at String Timestamp of when the payment was created, in RFC 3339 format. [optional]
updated_at String Timestamp of when the payment was last updated, in RFC 3339 format. [optional]
amount_money Money 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. [optional]
tip_money 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. [optional]
total_money Money 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. [optional]
app_fee_money 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 `total_money` value. [optional]
processing_fee [ProcessingFee] Processing fees and fee adjustments assessed by Square on this payment. [optional]
refunded_money 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. [optional]
status String Indicates whether the payment is `APPROVED`, `COMPLETED`, `CANCELED`, or `FAILED`. [optional]
delay_duration String 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. [optional] [beta]
delay_action String The action to be applied to the payment when the `delay_duration` has elapsed. This field is read only. Current values include: `CANCEL` [optional] [beta]
delayed_until String 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. [optional] [beta]
source_type String The source type for this payment Current values include: `CARD` [optional]
card_details CardPaymentDetails Non-confidential details about the source. Only populated if the `source_type` is `CARD`. [optional]
location_id String ID of the location associated with the payment. [optional]
order_id String ID of the order associated with this payment. [optional]
reference_id String An optional ID that associates this payment with an entity in another system. [optional]
customer_id String An optional customer_id to be entered by the developer when creating a payment. [optional]
employee_id String An optional ID of the employee associated with taking this payment. [optional]
refund_ids [String] List of `refund_id`s identifying refunds for this payment. [optional]
buyer_email_address String The buyer's e-mail address [optional]
billing_address Address The buyer's billing address [optional]
shipping_address Address The buyer's shipping address [optional]
note String An optional note to include when creating a payment [optional]
statement_description_identifier String 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. [optional] [beta]
receipt_number String The payment's receipt number. The field will be missing if a payment is CANCELED [optional]
receipt_url String The URL for the payment's receipt. The field will only be populated for COMPLETED payments. [optional]