Payment
May 28, 2020 ยท View on GitHub
Description
Represents a payment processed by the Square API.
Properties
| Name | Getter | Setter | Type | Description | Notes |
|---|---|---|---|---|---|
| id | getId() | setId($value) | string | Unique ID for the payment. | [optional] |
| created_at | getCreatedAt() | setCreatedAt($value) | string | Timestamp of when the payment was created, in RFC 3339 format. | [optional] |
| updated_at | getUpdatedAt() | setUpdatedAt($value) | string | Timestamp of when the payment was last updated, in RFC 3339 format. | [optional] |
| amount_money | getAmountMoney() | setAmountMoney($value) | \SquareConnect\Model\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 | getTipMoney() | setTipMoney($value) | \SquareConnect\Model\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 | getTotalMoney() | setTotalMoney($value) | \SquareConnect\Model\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 | getAppFeeMoney() | setAppFeeMoney($value) | \SquareConnect\Model\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 | getProcessingFee() | setProcessingFee($value) | \SquareConnect\Model\ProcessingFee[] | Processing fees and fee adjustments assessed by Square on this payment. | [optional] |
| refunded_money | getRefundedMoney() | setRefundedMoney($value) | \SquareConnect\Model\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 | getStatus() | setStatus($value) | string | Indicates whether the payment is `APPROVED`, `COMPLETED`, `CANCELED`, or `FAILED`. | [optional] |
| delay_duration | getDelayDuration() | setDelayDuration($value) | 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 | getDelayAction() | setDelayAction($value) | 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 | getDelayedUntil() | setDelayedUntil($value) | 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 | getSourceType() | setSourceType($value) | string | The source type for this payment Current values include: `CARD`. | [optional] |
| card_details | getCardDetails() | setCardDetails($value) | \SquareConnect\Model\CardPaymentDetails | Non-confidential details about the source. Only populated if the `source_type` is `CARD`. | [optional] |
| location_id | getLocationId() | setLocationId($value) | string | ID of the location associated with the payment. | [optional] |
| order_id | getOrderId() | setOrderId($value) | string | ID of the order associated with this payment. | [optional] |
| reference_id | getReferenceId() | setReferenceId($value) | string | An optional ID that associates this payment with an entity in another system. | [optional] |
| customer_id | getCustomerId() | setCustomerId($value) | string | The `Customer` ID of the customer associated with the payment. | [optional] |
| employee_id | getEmployeeId() | setEmployeeId($value) | string | An optional ID of the employee associated with taking this payment. | [optional] |
| refund_ids | getRefundIds() | setRefundIds($value) | string[] | List of `refund_id`s identifying refunds for this payment. | [optional] |
| buyer_email_address | getBuyerEmailAddress() | setBuyerEmailAddress($value) | string | The buyer's e-mail address | [optional] |
| billing_address | getBillingAddress() | setBillingAddress($value) | \SquareConnect\Model\Address | The buyer's billing address | [optional] |
| shipping_address | getShippingAddress() | setShippingAddress($value) | \SquareConnect\Model\Address | The buyer's shipping address | [optional] |
| note | getNote() | setNote($value) | string | An optional note to include when creating a payment | [optional] |
| statement_description_identifier | getStatementDescriptionIdentifier() | setStatementDescriptionIdentifier($value) | 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 | getReceiptNumber() | setReceiptNumber($value) | string | The payment's receipt number. The field will be missing if a payment is CANCELED | [optional] |
| receipt_url | getReceiptUrl() | setReceiptUrl($value) | string | The URL for the payment's receipt. The field will only be populated for COMPLETED payments. | [optional] |
Note: All properties are protected and only accessed via getters and setters.