Object Index / Definition

You are viewing an old version of the API
Payment

Represents a payment processed by the Square API

Properties

Name Description
id
string

Unique ID for the payment.

Max Length 192
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.

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.

billing_address
Address

The buyer's billing address

buyer_email_address
string

The buyer's e-mail address

card_details
Card​Payment​Details

Non-confidential details about the source. Only populated if the source_type is CARD.

created_at
string

Timestamp of when the payment was created, in RFC 3339 format.

customer_id
string

An optional customer_id to be entered by the developer when creating a payment.

employee_id
string

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

location_id
string

ID of the location associated with the payment.

note
string

An optional note to include when creating a payment

order_id
string

ID of the order associated with this payment.

processing_fee
Processing​Fee [ ]

Processing fees and fee adjustments assessed by Square on this payment.

reference_id
string

An optional ID that associates this payment with an entity in another system.

refund_ids
string [ ]

List of refund_ids identifying refunds for this payment.

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.

shipping_address
Address

The buyer's shipping address

source_type
string

The source type for this payment

Current values include: CARD

statement_description_identifier
string

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.

status
string

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

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.

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.

updated_at
string

Timestamp of when the payment was last updated, in RFC 3339 format.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?