braintree-web/paypal

Members

(static) VERSION :string

The current version of the SDK, i.e. 3.0.0-beta.8.

Source:

Methods

(static) create(options, callback) → {void}

Parameters:
Name Type Description
options object

All creation options for the PayPal component.

Properties
Name Type Attributes Default Description
client Client

A Client instance.

flow string

Set to 'checkout' for one-time payment flow, or 'vault' for Vault flow.

amount string | number <optional>

The amount of the transaction. Required when using the Checkout flow.

currency string <optional>

The currency code of the amount, such as 'USD'. Required when using the Checkout flow.

displayName string <optional>

The merchant name displayed inside of the PayPal lightbox; defaults to the company name on your Braintree account

locale string <optional>
en_us

Use this option to change the language, links, and terminology used in the PayPal flow to suit the country and language of your customer.

enableShippingAddress boolean <optional>
false

Returns a shipping address object in PayPal#tokenize.

shippingAddressOverride object <optional>

Allows you to pass a shipping address you have already collected into the PayPal payment flow.

Properties
Name Type Attributes Description
line1 string

Street address.

line2 string <optional>

Street address (extended).

city string

City.

state string

State.

postalCode string

Postal code.

countryCode string

Country.

phone string <optional>

Phone number.

recipientName string <optional>

Recipient's name.

shippingAddressEditable boolean <optional>
true

Set to false to disable user editing of the shipping address.

billingAgreementsDescription boolean <optional>

Use this option to set the description of the preapproved payment agreement visible to customers in their PayPal profile. Max 255 characters.

callback callback

The second argument, data, is the PayPal instance.

Source:

Type Definitions

createOptions :object

Options for create

Source: