braintree/paypal

Members

(static) VERSION

Properties:
Name Type Description
VERSION string

the current version of the SDK

Source:

Methods

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

Parameters:
Name Type Description
options module:braintree/paypal~createOptions

Object containing configuration options for this module

callback errback

The second argument, data, is the PayPal instance

Source:
Returns:
Type
void

Type Definitions

createOptions

Options for create

Type:
  • Object
Properties:
Name Type Attributes Default Description
client Client

A Client instance

options.amount string | number

The amount of the transaction

options.currency string

The currency code of the amount, such as "USD"

options.displayName string <optional>

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

options.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

options.enableShippingAddress boolean <optional>
false

Returns a shipping address object in PayPal#tokenize

options.singleUse boolean <optional>
true

Set to true to use a one-time payment flow

options.shippingAddressOverride object <optional>

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

Properties
Name Type Attributes Default 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

editable boolean <optional>
true

Set to false to disable user editing of the shipping address

Source: