Square · Schema
Square Payment
Represents a payment processed by the Square API, including credit cards, gift cards, digital wallets, ACH bank transfers, cash, and external payments.
BookingsCatalogCheckoutCustomersDisputesEcommerceFinancial TechnologyGift CardsInventoryInvoicingLaborLocationsLoyaltyMerchantsOrdersPaymentsPoint of SaleRefundsRetailSubscriptionsTeamTerminalWebhooks
Properties
| Name | Type | Description |
|---|---|---|
| id | string | A unique ID for the payment. |
| created_at | string | The timestamp of when the payment was created, in RFC 3339 format. |
| updated_at | string | The timestamp of when the payment was last updated, in RFC 3339 format. |
| amount_money | object | The amount processed for this payment, not including tip_money. |
| tip_money | object | The amount designated as a tip. |
| total_money | object | The total amount for the payment, including amount_money and tip_money. |
| app_fee_money | object | The amount the developer is taking as a fee for facilitating the payment on behalf of the seller. |
| approved_money | object | The amount of money approved for this payment. |
| processing_fee | array | The processing fees and fee adjustments assessed by Square for this payment. |
| refunded_money | object | The total amount of the payment refunded to date. |
| status | string | Indicates whether the payment is APPROVED, PENDING, COMPLETED, CANCELED, or FAILED. |
| delay_duration | string | The duration of time after the payment's creation when Square automatically applies the delay_action to the payment, in RFC 3339 duration format. |
| delay_action | string | The action to be applied to the payment when the delay_duration has elapsed. Current values include CANCEL and COMPLETE. |
| delayed_until | string | The read-only timestamp of when the delay_action is automatically applied, in RFC 3339 format. |
| source_type | string | The source type for this payment. |
| card_details | object | Details about a card payment. Only populated if the source_type is CARD. |
| cash_details | object | Details about a cash payment. Only populated if the source_type is CASH. |
| bank_account_details | object | Details about a bank account payment. Only populated if the source_type is BANK_ACCOUNT. |
| external_details | object | Details about an external payment. Only populated if the source_type is EXTERNAL. |
| wallet_details | object | Details about a wallet payment. Only populated if the source_type is WALLET. |
| buy_now_pay_later_details | object | Details about a Buy Now Pay Later payment. Only populated if the source_type is BUY_NOW_PAY_LATER. |
| square_account_details | object | Details about a Square Account payment. Only populated if the source_type is SQUARE_ACCOUNT. |
| location_id | string | The ID of the location associated with the payment. |
| order_id | string | The ID of the order associated with the payment. |
| reference_id | string | An optional ID that associates the payment with an entity in another system. |
| customer_id | string | The ID of the customer associated with the payment. |
| employee_id | string | An optional ID of the employee associated with taking the payment. |
| team_member_id | string | An optional ID of the TeamMember associated with taking the payment. |
| refund_ids | array | A list of refund IDs associated with the payment. |
| risk_evaluation | object | An assessment of the risk associated with the payment. |
| buyer_email_address | string | The buyer's email address. |
| billing_address | object | The buyer's billing address. |
| shipping_address | object | The buyer's shipping address. |
| note | string | An optional note to include when creating a payment. |
| statement_description_identifier | string | Additional payment information that gets added to the customer's card statement. |
| receipt_number | string | The payment's receipt number. |
| receipt_url | string | The URL for the payment's receipt. |
| version_token | string | Used for optimistic concurrency. This opaque token identifies a specific version of the Payment object. |