Represents a payment processed by the Square API.
Payment
Name | Type | Tags | Description | Getter |
---|---|---|---|---|
Id |
String |
Optional | A unique ID for the payment. Constraints: Maximum Length: 192 |
String getId() |
CreatedAt |
String |
Optional | The timestamp of when the payment was created, in RFC 3339 format. Constraints: Maximum Length: 32 |
String getCreatedAt() |
UpdatedAt |
String |
Optional | The timestamp of when the payment was last updated, in RFC 3339 format. Constraints: Maximum Length: 32 |
String getUpdatedAt() |
AmountMoney |
Money |
Optional | Represents an amount of money. Money fields can be signed or unsigned.Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information. |
Money getAmountMoney() |
TipMoney |
Money |
Optional | Represents an amount of money. Money fields can be signed or unsigned.Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information. |
Money getTipMoney() |
TotalMoney |
Money |
Optional | Represents an amount of money. Money fields can be signed or unsigned.Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information. |
Money getTotalMoney() |
AppFeeMoney |
Money |
Optional | Represents an amount of money. Money fields can be signed or unsigned.Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information. |
Money getAppFeeMoney() |
ApprovedMoney |
Money |
Optional | Represents an amount of money. Money fields can be signed or unsigned.Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information. |
Money getApprovedMoney() |
ProcessingFee |
List<ProcessingFee> |
Optional | The processing fees and fee adjustments assessed by Square for this payment. | List getProcessingFee() |
RefundedMoney |
Money |
Optional | Represents an amount of money. Money fields can be signed or unsigned.Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information. |
Money getRefundedMoney() |
Status |
String |
Optional | Indicates whether the payment is APPROVED, PENDING, COMPLETED, CANCELED, or FAILED. Constraints: Maximum Length: 50 |
String getStatus() |
DelayDuration |
String |
Optional | The duration of time after the payment's creation when Square automatically applies thedelay_action to the payment. This automatic delay_action applies only to payments thatdo 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. |
String getDelayDuration() |
DelayAction |
String |
Optional | The action to be applied to the payment when the delay_duration has elapsed.Current values include CANCEL and COMPLETE . |
String getDelayAction() |
DelayedUntil |
String |
Optional | 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 thetime on your local machine. |
String getDelayedUntil() |
SourceType |
String |
Optional | The source type for this payment. Current values include CARD , BANK_ACCOUNT , WALLET , BUY_NOW_PAY_LATER , SQUARE_ACCOUNT ,CASH and EXTERNAL . For information about these payment source types,see Take Payments. Constraints: Maximum Length: 50 |
String getSourceType() |
CardDetails |
CardPaymentDetails |
Optional | Reflects the current status of a card payment. Contains only non-confidential information. | CardPaymentDetails getCardDetails() |
CashDetails |
CashPaymentDetails |
Optional | Stores details about a cash payment. Contains only non-confidential information. For more information, see Take Cash Payments. |
CashPaymentDetails getCashDetails() |
BankAccountDetails |
BankAccountPaymentDetails |
Optional | Additional details about BANK_ACCOUNT type payments. | BankAccountPaymentDetails getBankAccountDetails() |
ExternalDetails |
ExternalPaymentDetails |
Optional | Stores details about an external payment. Contains only non-confidential information. For more information, see Take External Payments. |
ExternalPaymentDetails getExternalDetails() |
WalletDetails |
DigitalWalletDetails |
Optional | Additional details about WALLET type payments. Contains only non-confidential information. |
DigitalWalletDetails getWalletDetails() |
BuyNowPayLaterDetails |
BuyNowPayLaterDetails |
Optional | Additional details about a Buy Now Pay Later payment type. | BuyNowPayLaterDetails getBuyNowPayLaterDetails() |
SquareAccountDetails |
SquareAccountDetails |
Optional | Additional details about Square Account payments. | SquareAccountDetails getSquareAccountDetails() |
LocationId |
String |
Optional | The ID of the location associated with the payment. Constraints: Maximum Length: 50 |
String getLocationId() |
OrderId |
String |
Optional | The ID of the order associated with the payment. Constraints: Maximum Length: 192 |
String getOrderId() |
ReferenceId |
String |
Optional | An optional ID that associates the payment with an entity in another system. Constraints: Maximum Length: 40 |
String getReferenceId() |
CustomerId |
String |
Optional | The ID of the customer associated with the payment. If the ID is not provided in the CreatePayment request that was used to create the Payment ,Square may use information in the request (such as the billing and shipping address, email address, and payment source) to identify a matching customer profile in the Customer Directory. If found, the profile ID is used. If a profile is not found, the API attempts to create an instant profile. If the API cannot create an instant profile (either because the seller has disabled it or the seller's region prevents creating it), this field remains unset. Note that this process is asynchronous and it may take some time before a customer ID is added to the payment. Constraints: Maximum Length: 191 |
String getCustomerId() |
EmployeeId |
String |
Optional | Deprecated: Use Payment.team_member_id instead.An optional ID of the employee associated with taking the payment. Constraints: Maximum Length: 192 |
String getEmployeeId() |
TeamMemberId |
String |
Optional | An optional ID of the TeamMember associated with taking the payment. Constraints: Maximum Length: 192 |
String getTeamMemberId() |
RefundIds |
List<String> |
Optional | A list of refund_id s identifying refunds for the payment. |
List getRefundIds() |
RiskEvaluation |
RiskEvaluation |
Optional | Represents fraud risk information for the associated payment. When you take a payment through Square's Payments API (using the CreatePayment endpoint), Square evaluates it and assigns a risk level to the payment. Sellers can use this information to determine the course of action (for example, provide the goods/services or refund the payment). |
RiskEvaluation getRiskEvaluation() |
BuyerEmailAddress |
String |
Optional | The buyer's email address. Constraints: Maximum Length: 255 |
String getBuyerEmailAddress() |
BillingAddress |
Address |
Optional | Represents a postal address in a country. For more information, see Working with Addresses. |
Address getBillingAddress() |
ShippingAddress |
Address |
Optional | Represents a postal address in a country. For more information, see Working with Addresses. |
Address getShippingAddress() |
Note |
String |
Optional | An optional note to include when creating a payment. Constraints: Maximum Length: 500 |
String getNote() |
StatementDescriptionIdentifier |
String |
Optional | 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 descriptionto fit the required information including the Square identifier (SQ *) and the name of the seller taking the payment. |
String getStatementDescriptionIdentifier() |
Capabilities |
List<String> |
Optional | 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. |
List getCapabilities() |
ReceiptNumber |
String |
Optional | The payment's receipt number. The field is missing if a payment is canceled. Constraints: Maximum Length: 4 |
String getReceiptNumber() |
ReceiptUrl |
String |
Optional | The URL for the payment's receipt. The field is only populated for COMPLETED payments. Constraints: Maximum Length: 255 |
String getReceiptUrl() |
DeviceDetails |
DeviceDetails |
Optional | Details about the device that took the payment. | DeviceDetails getDeviceDetails() |
ApplicationDetails |
ApplicationDetails |
Optional | Details about the application that took the payment. | ApplicationDetails getApplicationDetails() |
IsOfflinePayment |
Boolean |
Optional | Whether or not this payment was taken offline. | Boolean getIsOfflinePayment() |
VersionToken |
String |
Optional | Used for optimistic concurrency. This opaque token identifies a specific version of thePayment object. |
String getVersionToken() |
{
"id": "id8",
"created_at": "created_at6",
"updated_at": "updated_at4",
"amount_money": {
"amount": 186,
"currency": "TZS"
},
"tip_money": {
"amount": 190,
"currency": "ZMK"
}
}