ACH
The ACH Payment Method
Objects & Enums
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.
Ach
Bank Account Details Identifying details of a tokenized bank account
Ach
Charge Token Options Defines an ACH payment options object
Ach
Options Afterpay
Button Options Options for attaching the Afterpay/Clearpay payment method. See Afterpay/Clearpay's Options for Afterpay Button documentation.
Afterpay
Checkout Widget Options Options for the Checkout Widget to better customize it.
Afterpay
Clearpay Create an Afterpay/Clearpay payment method instance.
Afterpay
Display Information Modal Options Options for the information modal parts of the Messaging Component. See Afterpay/Clearpay's Modal Themes documentation.
Afterpay
Messaging Options Options for styling the Afterpay/Clearpay Messaging Component. See Afterpay/Clearpay's Style Messaging documentation.
Afterpay
Payment Request Shipping Update Expected return value from the
afterpay_shippingaddresschangedevent listener on the PaymentRequest instance.Afterpay
Shipping Option Apple
Pay The ApplePay Payment Method.
Application
Error Details object of an error that occurred throughout the Web Payment SDK.
Billing
Contact A buyer
Card
The credit or debit card payment method
Card
Class Selectors The stylesheet classes assigned to input fields by field state
Card
Details Identifying details of a processed payment card
Card
Input Event Input event emitted from the Card and Fields payment method instances.
Card
Input Event State The state of an input field at the time a card input event is triggered
Card
Options 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.
Card
Token Options Optional parameters provided to the Card payment
tokenizemethodCash
App Pay Create a CashAppPay method instance
Cash
App Pay Button Options Cash
App Pay Customer Interaction Event Cash
App Payment Request Options Charge
Verify Buyer Details The verification details parameter passed, to the
payments.verifyBuyer()function, for cases in which the buyer is being charged.Gift
Card An object with the methods to create and set up a Gift Cards payment.
Gift
Card Details GiftCard details interface
Gift
Card Input Event GiftCard field event interface
Gift
Card Options GiftCard payment method options interface
Google
Pay The Google Pay Payment Method.
Google
Pay Button Options Provides display properties for rendering a Google Pay button
Invalid
Styles Error An aggregated set of style class errors including all of the issues related to styles provided by an application.
Line
Item A single line item in an Apple Pay or Google Pay payment request
Money
Interface for handling any currency
Payment
Request An object that represents an Apple Pay or Google Pay payment request
Payment
Request Options The payments.paymentRequest method argument
Payment
Request Update Interface that describes the object argument of the
paymentRequest.addEventListenermethod return value.Payments
Returned by
Square.payments(appId, locationId).Public
Errors The errors that can be thrown by the Web Payments SDK
Set
Locale Result The result of calling
setLocale()on the WebPaySDK payments instance.Shipping
Contact A digital wallet shipping contact
Shipping
Details Digital wallet shipping contact information and the shipping options
Shipping
Errors Details about digital wallet shipping address errors
Shipping
Option Digital Wallet shipping option choice
Square
The entry point of the Web Payments SDK.
Square
Api Error Square API Error Format.
Store
Verify Buyer Details The verification details parameter, passed to the
payments.verifyBuyer()function, for cases in which the card is being stored on file.Token
Details Details about the payment card used to create a payment token
Token
Error Details Details object of an error that occurred while attempting to tokenize.
Token
Result The result of a request to tokenize a payment card
Tokenization
Event Verify
Buyer Error Details Format of error details returned from verifyBuyer
Verify
Buyer Response Details Response details from the
await payments.verifyBuyer()function.Window