Skip to content
This repository was archived by the owner on Apr 23, 2021. It is now read-only.

Latest commit

 

History

History
36 lines (29 loc) · 4.04 KB

Payment.md

File metadata and controls

36 lines (29 loc) · 4.04 KB

Payment

Description

Represents a payment processed by the Square API.

Properties

Name Type Description Notes
id String Unique ID for the payment. [optional]
createdAt String Timestamp of when the payment was created, in RFC 3339 format. [optional]
updatedAt String Timestamp of when the payment was last updated, in RFC 3339 format. [optional]
amountMoney 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]
tipMoney 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]
totalMoney 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]
appFeeMoney 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]
processingFee List<ProcessingFee> Processing fees and fee adjustments assessed by Square on this payment. [optional]
refundedMoney 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]
sourceType String The source type for this payment Current values include: `CARD` [optional]
cardDetails CardPaymentDetails Non-confidential details about the source. Only populated if the `source_type` is `CARD`. [optional]
locationId String ID of the location associated with the payment. [optional]
orderId String ID of the order associated with this payment. [optional]
referenceId String An optional ID that associates this payment with an entity in another system. [optional]
customerId String An optional customer_id to be entered by the developer when creating a payment. [optional]
employeeId String An optional ID of the employee associated with taking this payment. [optional]
refundIds List<String> List of `refund_id`s identifying refunds for this payment. [optional]
buyerEmailAddress String The buyer's e-mail address [optional]
billingAddress Address The buyer's billing address [optional]
shippingAddress Address The buyer's shipping address [optional]
note String An optional note to include when creating a payment [optional]
statementDescriptionIdentifier 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]