• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
Payment

Represents a payment processed by the Square API.

Properties

Name Description
id
string

Read only A unique ID for the payment.

Max Length 192
created_at
string

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

Max Length 32
updated_at
string

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

Max Length 32
amount_money
Money

The amount processed for this payment, not including tip_money.

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_money
Money

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_money
Money

Read only The total amount for the payment, including amount_money and tip_money. 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.

app_fee_money
Money

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 total_money value.

To set this field, PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS OAuth permission is required. For more information, see Permissions.

approved_money
Money

The initial amount of money approved for this payment.

processing_fee
ProcessingFee [ ]

Read only The processing fees and fee adjustments assessed by Square for this payment.

refunded_money
Money

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
string

Read only Indicates whether the payment is APPROVED, PENDING, COMPLETED, CANCELED, or FAILED.

Max Length 50
delay_duration
string

Read only 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 do not 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.

Example for 2 days, 12 hours, 30 minutes, and 15 seconds: P2DT12H30M15S

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

Read only The read-only timestamp of when the delay_action is automatically 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 might not exactly match the time on your local machine.

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_type
string

Read only The source type for this payment.

Current values include CARD, BANK_ACCOUNT, WALLET, BUY_NOW_PAY_LATER, CASH, or EXTERNAL. For information about these payment source types, see Take Payments.

Max Length 50
card_details
CardPaymentDetails

Read only Details about a card payment. These details are only populated if the source_type is CARD.

cash_details
CashPaymentDetails

Details about a cash payment. These details are only populated if the source_type is CASH.

bank_account_details
BankAccountPaymentDetails

Read only Details about a bank account payment. These details are only populated if the source_type is BANK_ACCOUNT.

external_details
ExternalPaymentDetails

Read only Details about an external payment. The details are only populated if the source_type is EXTERNAL.

wallet_details
DigitalWalletDetails

Read only Details about an wallet payment. The details are only populated if the source_type is WALLET.

buy_now_pay_later_details
BuyNowPayLaterDetails

Read only Details about a Buy Now Pay Later payment. The details are only populated if the source_type is BUY_NOW_PAY_LATER. For more information, see Afterpay Payments.

location_id
string

Read only The ID of the location associated with the payment.

Max Length 50
order_id
string

Read only The ID of the order associated with the payment.

Max Length 192
reference_id
string

Read only An optional ID that associates the payment with an entity in another system.

Max Length 40
customer_id
string

Read only The Customer ID of the customer associated with the payment.

Max Length 191
employee_id
string

Deprecated

Read only Deprecated: Use Payment.team_member_id instead.

An optional ID of the employee associated with taking the payment.

Max Length 192
team_member_id
string

Read only An optional ID of the TeamMember associated with taking the payment.

Max Length 192
refund_ids
string [ ]

Read only A list of refund_ids identifying refunds for the payment.

risk_evaluation
RiskEvaluation

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_email_address
string

Read only The buyer's email address.

Max Length 255
billing_address
Address

Read only The buyer's billing address.

shipping_address
Address

Read only The buyer's shipping address.

note
string

Read only An optional note to include when creating a payment.

Max Length 500
statement_description_identifier
string

Read only Additional payment information that gets added to the customer's card statement as part of the statement description.

Note that the statement_description_identifier might get truncated on the statement description to fit the required information including the Square identifier (SQ *) and the name of the seller taking the payment.

capabilities
string [ ]

Read only Actions that can be performed on this payment:

  • EDIT_AMOUNT_UP - The payment amount can be edited up.
  • EDIT_AMOUNT_DOWN - The payment amount can be edited down.
  • EDIT_TIP_AMOUNT_UP - The tip amount can be edited up.
  • EDIT_TIP_AMOUNT_DOWN - The tip amount can be edited down.
  • EDIT_DELAY_ACTION - The delay_action can be edited.
receipt_number
string

Read only The payment's receipt number. The field is missing if a payment is canceled.

Max Length 4
receipt_url
string

Read only The URL for the payment's receipt. The field is only populated for COMPLETED payments.

Max Length 255
device_details
DeviceDetails

Read only Details about the device that took the payment.

application_details
ApplicationDetails

Read only Details about the application that took the payment.

version_token
string

Used for optimistic concurrency. This opaque token identifies a specific version of the Payment object.