PayPal

This page is part of Supported Payment Methods. View all payment methods →

PayPal enables customers to pay using their PayPal account balance, linked bank accounts, or saved cards. The payment flow redirects customers to PayPal for authentication.

Availability

PayPal is available on all browsers and devices.

Platform	Availability
Desktop browsers	Yes
Mobile browsers	Yes
iOS apps	Yes
Android apps	Yes

const available = await engine.checkAvailability();
if (available.includes('PayPal')) {
  // Show PayPal button
}

Requirements

PayPal requires:

A PayPal Business account (see PayPal Setup), configured as a PayPal eWallet account in Orchestra Portal

// Server-side session creation
const session = {
  operation: 'CHARGE',
  paymentGatewayAccountId: 'yourPspAccount',
  allowedeWalletAccountIds: ['your-paypal-account'],
  amount: 25.00,
  currencyCode: 'USD',
  countryCode: 'US',
  mode: 'LIVE'
};

PayPal does not require a separate PSP account. Payments are processed directly through PayPal. However, paymentGatewayAccountId is still required in the session for other payment methods.

Button Setup

<div id="paypal-button"></div>

engine.payBy(
  [{ name: 'PayPal', domEntitySelector: '#paypal-button' }],
  handleResult,
  { color: 'Dark', text: 'Pay' }
);

How It Works

Customer clicks the PayPal button
A popup window opens with PayPal login
Customer logs into their PayPal account
Customer reviews and confirms the payment
PayPal redirects back to the popup
On completion, the popup closes and results are returned to the client, ready to be sent to your server for validation

Supported Operations

Operation	Supported	Description
`CHARGE`	Yes	Process payment immediately
`TOKENIZE`	No	Not supported
`CHARGE_AND_TOKENIZE`	No	Not supported

PayPal only supports immediate charges. Tokenization is not available for PayPal payments.

Address Collection

PayPal can provide the customer’s shipping address from their PayPal account:

const requiredAncillaryInfo = {
  shippingInfo: {
    phoneRequired: false,
    emailAddressRequired: true
  }
};

const engine = new eWallet.Engine(sessionToken, requiredAncillaryInfo);

PayPal Setup

Configure PayPal credentials

Result Handling

Parse payment results

Start Here

Beyond the Quickstart

Concepts

Orchestra Payments Library Guides

Orchestra REST API Guides

Utilities

Merchant Account Setup

Support

Changelog

Availability

Requirements

Button Setup

How It Works

Supported Operations

Address Collection

PayPal Setup

Result Handling

​Availability

​Requirements

​Button Setup

​How It Works

​Supported Operations

​Address Collection

​Related

PayPal Setup

Result Handling

Availability

Requirements

Button Setup

How It Works

Supported Operations

Address Collection

Related