Objects & Enums

The ACH Payment Method

Identifying details of a tokenized bank account

Create charge for bank account on file.

Provides information about ACH tokenization.

Link bank account and create charge.

Create recurring charge for bank on file.

Link bank account.

Create recurring charge with a variable amount for bank on file.

Exception thrown when the total amount is greater than, or less than, the allowed Afterpay/Clearpay transaction limits. This exception will be thrown on initialization of the Afterpay/Clearpay payment method and on tokenization if the total amount for the PaymentRequest was updated.

Options for the Checkout Widget to better customize it.

Create an Afterpay/Clearpay payment method instance.

Exception thrown when Afterpay/Clearpay is not enabled for a merchant. This exception will be thrown on initialization.

Expected return value from the afterpay_shippingaddresschanged event listener on the PaymentRequest instance.

Digital Wallet shipping option choice

Exception thrown when the currency provided is not supported for use by Afterpay/Clearpay. This exception will be thrown on initialization of the Afterpay/Clearpay payment method and on tokenization if the currency for the PaymentRequest was updated.

The ApplePay Payment Method.

Details object of an error that occurred throughout the Web Payment SDK.

The BillingContact includes contact information about the buyer.

The credit or debit card payment method

The stylesheet classes assigned to input fields by field state

Identifying details of a processed payment card

Input event emitted from the Card and Fields payment method instances.

The state of an input field at the time a card input event is triggered

Optional parameters provided to the Card payment tokenize method

Create a CashAppPay method instance

The verification details parameter, passed to the card.tokenize() function, for cases in which the buyer is being charged.

The verification details parameter passed, to the payments.verifyBuyer() function, for cases in which the buyer is being charged.

The result of an erroring request to tokenize a payment.

An object with the methods to create and set up a Gift Cards payment.

GiftCard details interface

GiftCard field event interface

GiftCard payment method options interface

The Google Pay Payment Method.

Provides display properties for rendering a Google Pay button

An aggregated set of style class errors including all of the issues related to styles provided by an application.

A single line item in an Apple Pay or Google Pay payment request

The result of a miscellaneous request to tokenize a payment.

An object that represents an Apple Pay or Google Pay payment request

The payments.paymentRequest method argument

Interface that describes the object argument of the paymentRequest.addEventListener method return value.

Returned by Square.payments(appId, locationId).

The errors that can be thrown by the Web Payments SDK

The result of calling setLocale() on the WebPaySDK payments instance.

A digital wallet shipping contact

Digital wallet shipping contact information and the shipping options

Details about digital wallet shipping address errors

Digital Wallet shipping option choice

The entry point of the Web Payments SDK.

Square API Error Format.

The verification details parameter, passed to the card.tokenize() function, for cases in which the card is being stored on file.

The verification details parameter, passed to the payments.verifyBuyer() function, for cases in which the card is being stored on file.

The result of a successful request to tokenize a payment.

Details about the payment card used to create a payment token

Details object of an error that occurred while attempting to tokenize.

Format of error details returned from verifyBuyer

Response details from the await payments.verifyBuyer() function.