The ACH Payment Method
The Web Payments SDK shares common objects across properties and methods to make it easier for you to build your app and enforce consistency across our API surface. This reference documents every common object currently in use.
The ACH Payment Method
Identifying details of a tokenized bank account
Defines an ACH payment options object
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 attaching the Afterpay/Clearpay payment method. See Afterpay/Clearpay's Options for Afterpay Button dcoumentation.
Options for the Checkout Widget to better customize it.
Create an Afterpay/Clearpay payment method instance.
Options for the information modal parts of the Messaging Component. See Afterpay/Clearpay's Modal Themes documentation.
Exception thrown when a Payment Request is invalid for Afterpay/Clearpay specifically. These are cases where a field/value combination is expected for Afterpay/Clearpay which would not be required for other payment methods.
Exception thrown when Afterpay/Clearpay is not enabled for a merchant. This exception will be thrown on initialization.
Options for styling the Afterpay/Clearpay Messaging Component. See Afterpay/Clearpay's Style Messaging documentation.
Expected return value from the
afterpay_shippingaddresschanged event listener
on the PaymentRequest instance.
Exception thrown when the PaymentRequest used with Afterpay/Clearpay causes a failure during initialization of the payment method, or tokenization of the payment method.
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 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
An interface that declares the properties used to customize the appearance and behavior of the card entry form. For more information about applying custom styles to the card form, see the available CardClassSelectors for styling.
Optional parameters provided to the Card payment
Create a CashAppPay method instance
Exception thrown when a tokenize validator is not a function. This can happen when a user passes a non-function to the cashAppPay shouldTokenize option.
The verification details parameter passed, to the
payments.verifyBuyer() function, for cases in which the buyer is being charged.
The specified element was not found
Exception thrown when use of a disabled feature is attempted
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
The specified option name does not exist
The specified option has an invalid value
The specified amount is not expressed in a valid format for the provided currency.
The developer has an element with a forbidden/clashing ID on the page.
The developer attempted to attach a payment method with an invalid selector or element type.
eventListener callback is throwing an unexpected error.
A provided style property is invalid for the payment method.
A provided style selector is invalid or unsupported.
A provided style value is invalid for the property.
Invalid method parameter errors.
PaymentRequestUpdate object is malformed.
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
Interface for handling any currency
Exception thrown when a method was called on a payment method before a needed listener was added
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
The errors that can be thrown by the Web Payments SDK
The result of calling
setLocale() on the WebPaySDK payments instance.
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
payments.verifyBuyer() function, for cases in which the card is being stored on file.
An error for when a stylesheet fails to load.
Details about the payment card used to create a payment token
Details object of an error that occurred while attempting to tokenize.
The result of a request to tokenize a payment card
Exception thrown when trying to call a method before it has been implemented
Format of error details returned from verifyBuyer
Response details from the
await payments.verifyBuyer() function.
The Web Payments SDK requires HTTPS