Skip to content

Latest commit

 

History

History
197 lines (159 loc) · 6.82 KB

README.md

File metadata and controls

197 lines (159 loc) · 6.82 KB
Raw

react-native-apple-pay

npm version npm downloads Code Climate

react-native-apple-pay is a React Native library for accepting payments with Apple Pay.

Note: This library is still in progress.

react-native-apple-pay

Documentation

Install

npm i --save react-native-apple-pay

Supported Payment Processors

  • Adyen
  • Authorize.Net
  • Bank of America Merchant Services
  • Braintree
  • Chase Paymentech
  • CyberSource
  • DataCash
  • First Data
  • Global Payments
  • Judo Payments
  • Simplify
  • Stripe
  • TSYS
  • Vantiv
  • Worldpay

Methods

canMakePayments()

Checks if Apple Pay is available.

Example

ApplePay.canMakePayments()
  .then(() => {
    // Success code
  })
  .catch(err => {
    // Failure code
  });

canMakePaymentsWithNetworks(supportedNetworks)

Checks if the user's card is supported by the merchant.

Arguments

  • supportedNetworks - An Array of Strings representing the payment processing protocols you support.

Example

var merchantOptions = {
  paymentProcessor: 'stripe',
  paymentProcessorPublicKey: 'pk_test_QsubAYNpjqwertyAogowi9r7',
  merchantIdentifier: 'merchant.yourapp.you',
  merchantName: "Company, Inc.",
  supportedNetworks: ['PKPaymentNetworkAmex', 'PKPaymentNetworkMasterCard', 'PKPaymentNetworkVisa'],
  merchantCapabilities: ['PKMerchantCapability3DS', 'PKMerchantCapabilityEMV'],
  countryCode: 'US',
  currencyCode: 'USD'
};

ApplePay.canMakePaymentsWithNetworks(merchantOptions.supportedNetworks)
  .then(() => {
    // Success code
  })
  .catch(err => {
    // Failure code
  });

paymentRequest(merchantOptions, paymentItems)

Initializes Apple Pay. NOTE that paymentRequest adds one entry to the paymentItems array - summary, where label is set to merchantName and amount is sum of all amount values in the original array.

Arguments

  • merchantOptions - An Object that will be served to setup the payment request.
  • summaryItems - An Array containing the items the customer will be purchasing.

merchantOptions

  • paymentProcessor - A String representing your payment processor.
  • paymentProcessorPublicKey - A String representing your public key.
  • merchantIdentifier - A String representing your merchant identifier.
  • supportedNetworks - An Array of Strings representing the payment processing protocols you support.
  • merchantCapabilities -An Array of Strings representing the payment networks that you support.
  • countryCode - A String representing the two-letter ISO 3166 country code for the country where the payment will be processed.
  • currencyCode - A String representing the three-letter ISO 4217 currency code of the currency you will use to charge the customer.

summaryItem

  • label - A String representing the summary name.
  • amount - A Number with two decimal places representing the summary price.

Example

var merchantOptions = {
  paymentProcessor: 'stripe',
  paymentProcessorPublicKey: 'pk_test_QsubAYNpjqwertyAogowi9r7',
  merchantIdentifier: 'merchant.yourapp.you',
  merchantName: "Company, Inc.",
  supportedNetworks: ['PKPaymentNetworkMasterCard', 'PKPaymentNetworkVisa'],
  merchantCapabilities: ['PKMerchantCapability3DS', 'PKMerchantCapabilityEMV'],
  countryCode: 'US',
  currencyCode: 'USD'
};

var summaryItems = [
  {
    label: 'Hockey Stick',
    amount: 88.88
  }
];

ApplePay.paymentRequest(merchantOptions, summaryItems)
  .then(chargeTokenOnServer)
  .then(ApplePay.success)
  .catch(error => {
    // Log error
    ApplePay.failure();
  });

function chargeTokenOnServer(token) {...}

success()

Displays a success animation to the user and dismisses the Apple Pay view.

Example

ApplePay.success()
  .then(() => {
    this.props.navigator.push(successRoute);
  });

failure()

Displays a failure animation to the user and dismisses the Apple Pay view.

Example

ApplePay.failure()
  .then(() => {
    AlertIOS.alert('Payment Failed');
  });

getTotal(summaryItems)

Returns the total charge of the summary items.

Example

var summaryItems = [
  {
    label: 'Adult Batman Costume',
    amount: 79.99
  },
  {
    label: 'Child Batman Costume',
    amount: 59.99
  },
  {
    label: 'Discount',
    amount: -40
  },
];

ApplePay.getTotal(summaryItems) // 99.98

License

Copyright (c) 2015, Naoufal Kadhom, Igor Shmukler

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.