PayPal Node SDK

Global

Members

checkExpiredToken

Checks if access token for client id has expired
Source:

configure

Set up configuration globally such as client_id and client_secret, by merging user provided configurations otherwise use default settings
Source:

executeHttp

Makes a PayPal REST API call. Reuses valid access tokens to reduce round trips, handles 401 error and token expiration.
Source:

generateToken

Generate new access token by making a POST request to /oauth2/token by exchanging base64 encoded client id/secret pair or valid refresh token. Otherwise authorization code from a mobile device can be exchanged for a long living refresh token used to charge user who has consented to future payments.
Source:

invoke

Wraps the http client, handles request parameters, populates request headers, handles response
Source:

merge

Merges two Objects recursively, setting property of obj1 to those of obj2 and creating property as necessary. Implementation suggested by @kobalicek on https://github.com/paypal/PayPal-node-SDK/issues/69
Source:

restFunctions :Object

restFunctions Object containing the REST CRUD methods and paypal specific REST methods that are shared between at least two of the REST endpoints, otherwise the function will be defined within the resource definition itself
Type:
  • Object
Source:

token_persist :Object

token_persist client id to access token cache, used to reduce access token round trips
Type:
  • Object
Source:

Methods

authorization()

Retrieving, capturing, voiding, and reauthorizing previously created authorizations
Source:
Returns:
authorization functions
Type
Object

authorizeUrl(data, config)

Obtain a user’s consent to make Identity API calls on their behalf by redirecting them to authorization endpoint
Parameters:
Name Type Description
data Data Payload associated with API request
config Object Configurations for settings and Auth
Source:
Returns:
authorize url
Type
String

billingAgreement()

The billing agreements allows merchants to have users agree to be billed for billing plans
Source:
Returns:
billing agreement functions
Type
Object

billingPlan()

Create planned sets of future recurring payments at periodic intervals (sometimes known as “subscriptions”).
Source:
Returns:
billing plan functions
Type
Object

capture()

Look up and refund captured payments
Source:
Returns:
capture functions
Type
Object

clone(v)

Recursively copies given object into a new object. Helper method for merge
Parameters:
Name Type Description
v Object
Source:
Returns:
Type
Object

creditCard()

Store credit cards information securely in vault
Source:
Returns:
Credit Card functions
Type
Object

getClientId(config)

Parameters:
Name Type Description
config Object Configurations for settings and Auth
Source:
Returns:
client id
Type
String

getClientSecret(config)

Parameters:
Name Type Description
config Object Configurations for settings and Auth
Source:
Returns:
client secret
Type
String

getRedirectUri()

Configurations for settings and Auth
Source:
Returns:
redirect uri
Type
String

invoice()

Create, send and manage invoices, PayPal emails the customer with link to invoice on PayPal's website. Customers can pay with PayPal, check, debit or credit card.
Source:
Returns:
Invoice functions
Type
Invoice

logoutUrl(data, config)

Direct user to logout url to end session
Parameters:
Name Type Description
data Data Payload associated with API request
config Object Configurations for settings and Auth
Source:
Returns:
logout url
Type
String

mixin(destObject, operations)

Attach REST operations from restFunctions as required by a PayPal API resource e.g. create, get and list are attahed for Payment resource
Parameters:
Name Type Description
destObject Object A PayPal resource e.g. Invoice
operations Array Rest operations that the destObject will allow e.g. get
Source:
Returns:
Type
Object

notification()

Exposes the namespace for webhook and webhook event functionalities https://developer.paypal.com/webapps/developer/docs/api/#notifications
Source:
Returns:
notification functions
Type
Object

openIdConnect()

Use log in with PayPal to avoid storing user data on the system
Source:
Returns:
openidconnect functions
Type
Object

openIdConnectRequest(path, data, config, cb)

Sets up request body for open id connect module requests
Parameters:
Name Type Description
path String url endpoint
data Object Payload for HTTP Request
config Object | function Configuration parameters such as authorization code or refresh token
cb function
Source:

order()

Take action on a payment with the intent of order
Source:
Returns:
order functions
Type
Object

payment()

Create or get details of payments
Source:
Returns:
Payment functions
Type
Object

payout()

Make payouts to multiple PayPal accounts, or multiple payments to same PayPal account
Source:
Returns:
payout functions
Type
Object

payoutItem()

An individual Payout item
Source:
Returns:
payout object functions
Type
Object

refund()

Refunds on direct and captured payments
Source:
Returns:
refund functions
Type
Object

sale()

Completed payments are referred to as sale transactions
Source:
Returns:
sale functions
Type
Object

tokenInfoRequest(data, config, cb)

Grant a new access token, using a refresh token
Parameters:
Name Type Description
data Object Payload associated with API request
config Object | function Configurations for settings and Auth
cb function Callback function
Source:

updateToken(http_options, error_callback, callback)

Updates http Authorization header to newly created access token
Parameters:
Name Type Description
http_options Object Configuration parameters such as authorization code or refresh token
error_callback function
callback function
Source:

userInfoRequest(data, config, cb)

Retrieve user profile attributes
Parameters:
Name Type Description
data Object Payload associated with API request
config Object | function Configurations for settings and Auth
cb function Callback function
Source:

webhook()

Exposes REST endpoints for creating and managing webhooks
Source:
Returns:
webhook functions
Type
Object

webhookEvent()

Exposes REST endpoints for working with subscribed webhooks events https://developer.paypal.com/webapps/developer/docs/integration/direct/rest-webhooks-overview/#events
Source:
Returns:
webhook event functions
Type
Object

webhookEventType()

Exposes REST endpoint for listing available event types for webhooks
Source:
Returns:
webhook event type functions
Type
Object

webProfile()

Exposes REST endpoints for providing a customizing Paypal checkout flow for users, supports features such as noshipping. https://developer.paypal.com/webapps/developer/docs/integration/direct/rest-experience-overview/
Source:
Returns:
web profile functions
Type
Object