Cmdlets for Square

Build 24.0.9060

Payments

Query the available card Payments in Square. Cash and other tenders payments will not be returned.

Table Specific Information

Select

The following queries show the filters that are processed server side, while other filters are processed client side within the cmdlet.

Retrieve all Payments: Retrieve a single payment by providing a valid Id: 

    SELECT * FROM Payments WHERE Id = '5xNDT7Sd6qFHsLyKlugpZIqeV'

Filter by the creation date of a Payment: 

  SELECT * FROM Payments WHERE CreatedAt > '2015-08-15'
  SELECT * FROM Payments WHERE CreatedAt < '2015-08-15'

Columns

Name Type Description
Id [KEY] String The Id of the payment.
MoneyAmount Int64 The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
MoneyCurrency String The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
AppFeeMoneyAmount Int64 The amount the developer is taking as a fee for facilitating the payment on behalf of the seller.
AppFeeMoneyCurrency String The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
ApprovedMoneyAmount Int64 The initial amount of money approved for this payment. The amount the developer is taking as a fee for facilitating the payment on behalf of the seller.
ApprovedMoneyCurrency String The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
BankAccountOwnershipType String The ownership type of the bank account performing the transfer.

The allowed values are INDIVIDUAL, COMPANY, UNKNOWN.

ACHDetailsAccountNumberSuffix String The last few digits of the bank account number.
ACHDetailsAccountType String The type of the bank account performing the transfer.

The allowed values are CHECKING, SAVINGS, UNKNOWN.

ACHDetailsRoutingNumber String The routing number for the bank account.
BankName String The name of the bank associated with the bank account.
BankAccountCountry String The two-letter ISO code representing the country the bank account is located in.
BankAccountFingerprint String Uniquely identifies the bank account for this seller and can be used to determine if payments are from the same bank account.
BankAccountStatementDescription String The statement description as sent to the bank.
BankAccountTransferType String The type of the bank transfer.

The allowed values are ACH, UNKNOWN.

BillingAddressLine1 String The first line of the address.
BillingAddressLine2 String The second line of the address, if any.
BillingAddressLine3 String The third line of the address, if any.
BillingAddressAdministrativeDistrictLevel1 String A civil entity within the address's country. In the US, this is the state.
BillingAddressAdministrativeDistrictLevel2 String A civil entity within the address's administrative_district_level_1. In the US, this is the county.
BillingAddressAdministrativeDistrictLevel3 String A civil entity within the address's administrative_district_level_2, if any.
BillingAddressCountry String The address's country, in ISO 3166-1-alpha-2 format.
BillingAddressFirstName String Optional first name when it's representing recipient.
BillingAddressLastName String Optional last name when it's representing recipient.
BillingAddressLocality String The city or town of the address.
BillingAddressOrganization String Optional organization name when it's representing recipient.
BillingAddressPostalCode String The address's postal code.
BillingAddressSubLocality String A civil region within the address's locality, if any.
BillingAddressSubLocality2 String A civil region within the address's sublocality, if any.
BillingAddressSubLocality3 String A civil region within the address's sublocality_2, if any.
BuyerEmailAddress String The buyer's email address.
Capabilities String Actions that can be performed on this payment:EDIT_AMOUNT_UP,EDIT_AMOUNT_DOWN,EDIT_TIP_AMOUNT_UP,EDIT_TIP_AMOUNT_DOWN
CardDetailsApplicationCryptogram String For EMV payments, the cryptogram generated for the payment.
CardDetailsApplicationIdentifier String For EMV payments, the application ID identifies the EMV application used for the payment.
CardDetailsApplicationName String For EMV payments, the human-readable name of the EMV application used for the payment.
CardDetailsAuthResultCode String The status code returned by the card issuer that describes the payment's authorization status.
CardDetailsAverageStatus String The status code returned from the Address Verification System (AVS) check.

The allowed values are AVS_ACCEPTED, AVS_REJECTED, AVS_NOT_CHECKED.

CardId String Unique ID for this card. Generated by Square.
CardBillingAddressLine1 String The first line of the address.
CardBillingAddressLine2 String The second line of the address, if any.
CardBillingAddressLine3 String The third line of the address, if any.
CardBillingAddressAdministrativeDistrictLevel1 String A civil entity within the address's country. In the US, this is the state.
CardBillingAddressAdministrativeDistrictLevel2 String A civil entity within the address's administrative_district_level_1. In the US, this is the county.
CardBillingAddressAdministrativeDistrictLevel3 String A civil entity within the address's administrative_district_level_2, if any.
CardBillingAddressCountry String The address's country, in ISO 3166-1-alpha-2 format.
CardBillingAddressFirstName String Optional first name when it's representing recipient.
CardBillingAddressLastName String Optional last name when it's representing recipient.
CardBillingAddressLocality String The city or town of the address.
CardBillingAddressOrganization String Optional organization name when it's representing recipient.
CardBillingAddressPostalCode String The address's postal code.
CardBillingAddressSubLocality String A civil region within the address's locality, if any.
CardBillingAddressSubLocality2 String A civil region within the address's sublocality, if any.
CardBillingAddressSubLocality3 String A civil region within the address's sublocality_2, if any.
CardBin String The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API returns this field.
CardType String The type of the card. The Card object includes this field only in response to Payments API calls.

The allowed values are UNKNOWN_CARD_TYPE, CREDIT, DEBIT.

CardholderName String The name of the cardholder.
CardCustomerId String The ID of a customer created using the Customers API to be associated with the card.
CardEnabled Boolean Indicates whether or not a card can be used for payments.
CardExpiryMonth Int64 The expiration month of the associated card as an integer between 1 and 12.
CardExpiryYear Int64 The four-digit year of the card's expiration date.
CardFingerprint String Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.
CardLast4 String The last 4 digits of the card number.
CardPrepaidType String Indicates whether the Card is prepaid or not. The Card object includes this field only in response to Payments API calls
CardReferenceId String An optional user-defined reference ID that associates this card with another entity in an external system.
CardVersion Int64 Current version number of the card. Increments with each card update.
CardTimelineAuthorizedAt Datetime The timestamp when the payment was authorized, in RFC 3339 format.
CardTimelineCapturedAt Datetime The timestamp when the payment was captured, in RFC 3339 format.
CardTimelineVoidedAt Datetime The timestamp when the payment was voided, in RFC 3339 format.
CardCVVStatus String The status code returned from the Card Verification Value (CVV) check.

The allowed values are CVV_ACCEPTED, CVV_REJECTED, CVV_NOT_CHECKED.

CardDeviceId String The Square-issued ID of the device.
CardDeviceInstallationId String The Square-issued installation ID for the device.
CardDeviceName String The name of the device set by the seller.
CardEntryMethod String The method used to enter the card's details for the payment.

The allowed values are KEYED, SWIPED, EMV, ON_FILE, CONTACTLESS.

RefundRequiresCardPresence Boolean Whether the card must be physically present for the payment to be refunded. If set to true, the card must be present.
CardStatementDescription String The statement description sent to the card networks.
CardStatus String The card payment's current state.

The allowed values are AUTHORIZED, CAPTURED, VOIDED, FAILED.

CardVerificationMethod String For EMV payments, the method used to verify the cardholder's identity.

The allowed values are PIN, SIGNATURE, PIN_AND_SIGNATURE, ON_DEVICE, NONE.

CardVerificationResults String For EMV payments, the results of the cardholder verification.

The allowed values are SUCCESS, FAILURE, UNKNOWN.

CashBuyerSupplierMoneyAmount Int64 The amount of money, in the smallest denomination of the currency indicated by currency.
CashBuyerSupplierMoneyCurrency String The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
CashChangeBackMoneyAmount Int64 The amount of change due back to the buyer. This read-only field is calculated from the amount_money and buyer_supplied_money fields.
CashChangeBackMoneyCurrency String The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
CreatedAt Datetime The timestamp of when the payment was created, in RFC 3339 format.
CustomerId String The Customer ID of the customer associated with the payment.
DelayAction String The action to be applied to the payment when the delay_duration has elapsed.
DelayDuration String The duration of time after the payment's creation when Square automatically applies the delay_action to the payment.
DelayedUntil Datetime The timestamp of when the delay_action is automatically applied, in RFC 3339 format.
EmployeeId String An optional ID of the employee associated with taking the payment.
ExternalDetailsSource String A description of the external payment source. For example, 'Food Delivery Service'.
ExternalDetailsType String The type of external payment the seller received.

The allowed values are CHECK, BANK_TRANSFER, OTHER_GIFT_CARD, CRYPTO, SQUARE_CASH, SOCIAL, EXTERNAL, EMONEY, CARD, STORED_BALANCE, OTHER.

ExternalDetailsSourceFeeMoneyAmount Int64 The fees paid to the source. The amount_money minus this field is the net amount seller receives.
ExternalDetailsSourceFeeMoneyCurrency String The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
ExternalDetailsSourceId String An ID to associate the payment to its originating source.
LocationId String The ID of the location associated with the payment.
Note String An optional note to include when creating a payment.
OrderId String The ID of the order associated with the payment.
ProcessingFee String The processing fees and fee adjustments assessed by Square for this payment.
ReceiptNumber String The payment's receipt number. The field is missing if a payment is canceled.
ReceiptURL String The URL for the payment's receipt. The field is only populated for COMPLETED payments.
ReferenceId String An optional ID that associates the payment with an entity in another system.
RefundIds String A list of refund_ids identifying refunds for the payment.
RefundedMoneyAmount Int64 The total amount of the payment refunded to date.
RefundedMoneyCurrency String The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
RiskEvaluationCreatedAt Datetime Provides information about the risk associated with the payment, as determined by Square.
RiskEvaluationLevel String The risk level associated with the payment.

The allowed values are PENDING, NORMAL, MODERATE, HIGH.

ShippingAddressLine1 String The first line of the address.
ShippingAddressLine2 String The second line of the address, if any.
ShippingAddressLine3 String The third line of the address, if any.
ShippingAddressAdministrativeDistrictLevel1 String A civil entity within the address's country. In the US, this is the state.
ShippingAddressAdministrativeDistrictLevel2 String A civil entity within the address's administrative_district_level_1. In the US, this is the county.
ShippingAddressAdministrativeDistrictLevel3 String A civil entity within the address's administrative_district_level_2, if any.
ShippingAddressCountry String The address's country, in ISO 3166-1-alpha-2 format.
ShippingAddressFirstName String Optional first name when it's representing recipient.
ShippingAddressLastName String Optional last name when it's representing recipient.
ShippingAddressLocality String The city or town of the address.
ShippingAddressOrganization String Optional organization name when it's representing recipient.
ShippingAddressPostalCode String The address's postal code.
ShippingAddressSubLocality String A civil region within the address's locality, if any.
ShippingAddressSubLocality2 String A civil region within the address's sublocality, if any.
ShippingAddressSubLocality3 String A civil region within the address's sublocality_2, if any.
SourceType String The source type for this payment.

The allowed values are CARD, BANK_ACCOUNT, CASH, EXTERNAL.

StatementDescriptionIdentifier String Additional payment information that gets added to the customer's card statement as part of the statement description.
Status String Indicates whether the payment is APPROVED, PENDING, COMPLETED, CANCELED, or FAILED.
TipMoneyAmount Int64 The amount designated as a tip.
TipMoneyCurrency String The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
TotalMoneyAmount Int64 The total amount for the payment, including amount_money and tip_money.
TotalMoneyCurrency String The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
UpdatedAt Datetime The timestamp of when the payment was last updated, in RFC 3339 format.
VersionToken String Used for optimistic concurrency. This opaque token identifies a specific version of the Payment object.
TeamMemberId String An optional ID of the TeamMember associated with taking the payment.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060