Payment WebElement Options
Parameters
| Parameter | Required/Optional | Type | Description |
|---|---|---|---|
| type | required | string | Always "payment". |
| options | optional | object | Initialization Options |
options
| Parameter | Required/Optional | Type | Description |
|---|---|---|---|
| layout | optional | string | The layout of the Payment WebElement. Options are "accordion" and "tab". Defaults to "tab" if not specified. |
| defaultValues | optional | object | You can pre-fill initial customer information in the Payment WebElement using the defaultValues object. |
| terms | optional | object | You can customize how mandates and other legal agreements are displayed in the Payment WebElement using the terms object. If not specified, it defaults to "auto", which automatically displays legal agreements when necessary. |
| wallets | optional | object | You can specify which wallets to display when the "card" payment method is enabled using the wallets object. If not specified, it defaults to "auto". |
defaultValues
| Parameter | Required/Optional | Type | Description |
|---|---|---|---|
| billingDetails | optional | object | The customer's billing details, if collected previously, to pre-fill the Payment WebElement. |
defaultValues.billingDetails
| Parameter | Required/Optional | Type | Description |
|---|---|---|---|
| name | optional | string | The customer’s name. |
| optional | string | The customer’s email address. | |
| phone | optional | string | The customer’s phone number. |
| address | optional | object | The customer’s address. |
defaultValues.billingDetails.address
| Parameter | Required/Optional | Type | Description |
|---|---|---|---|
| line1 | optional | string | Address line 1. (e.g., street, PO Box, or company name) |
| line2 | optional | string | Address line 2. (e.g., apartment, suite, unit, or building) |
| city | optional | string | City, district, suburb, town, or village. |
| state | optional | string | State, county, province, or region. |
| country | optional | string | Two-letter country code (ISO 3166-1 alpha-2). |
| postalCode | optional | string | ZIP or postal code. |
terms
| Parameter | Required/Optional | Type | Description |
|---|---|---|---|
| applePay | optional | string | "auto" or "never" |
| googlePay | optional | string | "auto" or "never" |
| card | optional | string | "auto" or "never" |
| usBankAccount | optional | string | "auto" or "never" |
wallets
| Parameter | Required/Optional | Type | Description |
|---|---|---|---|
| applePay | optional | string | "auto" or "never" |
| googlePay | optional | string | "auto" or "never" |
Updated 9 months ago