PayPal

Improve this doc

PayPal plugin for Cordova/Ionic Applications

Repo: https://github.com/paypal/PayPal-Cordova-Plugin

Installation

1. Install the Cordova and Ionic Native plugins:
   

   $ ionic cordova plugin add com.paypal.cordova.mobilesdk
   $ npm install --save @ionic-native/paypal@4
   

2. Add this plugin to your app's module

Supported platforms

• Android
• iOS

Usage

import { PayPal, PayPalPayment, PayPalConfiguration } from '@ionic-native/paypal';

constructor(private payPal: PayPal) { }

...


this.payPal.init({
  PayPalEnvironmentProduction: 'YOUR_PRODUCTION_CLIENT_ID',
  PayPalEnvironmentSandbox: 'YOUR_SANDBOX_CLIENT_ID'
}).then(() => {
  // Environments: PayPalEnvironmentNoNetwork, PayPalEnvironmentSandbox, PayPalEnvironmentProduction
  this.payPal.prepareToRender('PayPalEnvironmentSandbox', new PayPalConfiguration({
    // Only needed if you get an "Internal Service Error" after PayPal login!
    //payPalShippingAddressOption: 2 // PayPalShippingAddressOptionPayPal
  })).then(() => {
    let payment = new PayPalPayment('3.33', 'USD', 'Description', 'sale');
    this.payPal.renderSinglePaymentUI(payment).then(() => {
      // Successfully paid

      // Example sandbox response
      //
      // {
      //   "client": {
      //     "environment": "sandbox",
      //     "product_name": "PayPal iOS SDK",
      //     "paypal_sdk_version": "2.16.0",
      //     "platform": "iOS"
      //   },
      //   "response_type": "payment",
      //   "response": {
      //     "id": "PAY-1AB23456CD789012EF34GHIJ",
      //     "state": "approved",
      //     "create_time": "2016-10-03T13:33:33Z",
      //     "intent": "sale"
      //   }
      // }
    }, () => {
      // Error or render dialog closed without being successful
    });
  }, () => {
    // Error in configuration
  });
}, () => {
  // Error in initialization, maybe PayPal isn't supported or something else
});

Instance Members

version()

Retrieve the version of the PayPal iOS SDK library. Useful when contacting support.

init(clientIdsForEnvironments:)

You must preconnect to PayPal to prepare the device for processing payments. This improves the user experience, by making the presentation of the UI faster. The preconnect is valid for a limited time, so the recommended time to preconnect is on page load.

prepareToRender(environment:, configuration:)

You must preconnect to PayPal to prepare the device for processing payments. This improves the user experience, by making the presentation of the UI faster. The preconnect is valid for a limited time, so the recommended time to preconnect is on page load.

renderSinglePaymentUI(payment)

Start PayPal UI to collect payment from the user. See https://developer.paypal.com/webapps/developer/docs/integration/mobile/ios-integration-guide/ for more documentation of the params.

clientMetadataID()

Once a user has consented to future payments, when the user subsequently initiates a PayPal payment from their device to be completed by your server, PayPal uses a Correlation ID to verify that the payment is originating from a valid, user-consented device+application. This helps reduce fraud and decrease declines. This method MUST be called prior to initiating a pre-consented payment (a “future payment”) from a mobile device. Pass the result to your server, to include in the payment request sent to PayPal. Do not otherwise cache or store this value.

renderFuturePaymentUI()

Please Read Docs on Future Payments at https://github.com/paypal/PayPal-iOS-SDK#future-payments

renderProfileSharingUI(scopes)

Please Read Docs on Profile Sharing at https://github.com/paypal/PayPal-iOS-SDK#profile-sharing

PayPalPayment

Instance Members

amount()

The amount of the payment.

currency()

The ISO 4217 currency for the payment.

shortDescription()

A short description of the payment.

intent()

“Sale” for an immediate payment.

bnCode()

Optional Build Notation code (“BN code”), obtained from partnerprogram@paypal.com, for your tracking purposes.

invoiceNumber()

Optional invoice number, for your tracking purposes. (up to 256 characters)

custom()

Optional text, for your tracking purposes. (up to 256 characters)

softDescriptor()

Optional text which will appear on the customer’s credit card statement. (up to 22 characters)

items()

Optional array of PayPalItem objects.

payeeEmail()

Optional payee email, if your app is paying a third-party merchant. The payee’s email. It must be a valid PayPal email address.

shippingAddress()

Optional customer shipping address, if your app wishes to provide this to the SDK.

details()

Optional PayPalPaymentDetails object

PayPalItem

Instance Members

name()

Name of the item. 127 characters max

quantity()

Number of units. 10 characters max.

price()

Unit price for this item 10 characters max.

currency()

ISO standard currency code.

sku()

The stock keeping unit for this item. 50 characters max (optional)

PayPalPaymentDetails

Instance Members

subtotal()

Sub-total (amount) of items being paid for. 10 characters max with support for 2 decimal places.

shipping()

Amount charged for shipping. 10 characters max with support for 2 decimal places.

tax()

Amount charged for tax. 10 characters max with support for 2 decimal places.

PayPalShippingAddress

Instance Members

recipientName()

Name of the recipient at this address. 50 characters max.

line1()

Line 1 of the address (e.g., Number, street, etc). 100 characters max.

line2()

Line 2 of the address (e.g., Suite, apt #, etc). 100 characters max. Optional.

city()

City name. 50 characters max.

state()

2-letter code for US states, and the equivalent for other countries. 100 characters max. Required in certain countries.

postalCode()

ZIP code or equivalent is usually required for countries that have them. 20 characters max. Required in certain countries.

countryCode()

2-letter country code. 2 characters max.

PayPalEnvironment

PayPalConfigurationOptions