Members
(static) VERSION :string
The current version of the SDK, i.e. 3.0.0-beta.6.
- Source:
Methods
(static) create(options, callback) → {void}
Parameters:
| Name | Type | Description |
|---|---|---|
options |
module:braintree-web/paypal~createOptions | Object containing configuration options for this module. |
callback |
errback | The second argument, |
- Source:
Type Definitions
createOptions :object
Options for create
Properties:
| Name | Type | Attributes | Default | Description | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
client |
Client | A Client instance. |
||||||||||||||||||||||||||||||||||||||
options.flow |
string | Set to 'checkout' for one-time payment flow, or 'vault' for Vault flow. |
||||||||||||||||||||||||||||||||||||||
options.amount |
string | number |
<optional> |
The amount of the transaction. Required when using the Checkout flow. |
|||||||||||||||||||||||||||||||||||||
options.currency |
string |
<optional> |
The currency code of the amount, such as 'USD'. Required when using the Checkout flow. |
|||||||||||||||||||||||||||||||||||||
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.shippingAddressOverride |
object |
<optional> |
Allows you to pass a shipping address you have already collected into the PayPal payment flow. Properties
|
|||||||||||||||||||||||||||||||||||||
options.shippingAddressEditable |
boolean |
<optional> |
true | Set to false to disable user editing of the shipping address. |
||||||||||||||||||||||||||||||||||||
options.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. |
- Source: