capacitorcapacitor-community/stripe

Logo Github GitHub

ガイド

Apple Pay

Apple Payを使えば、ワンフローで即時決済が可能です。詳しい設定は以下をご確認ください:

https://stripe.com/docs/apple-pay

Image from Gyazo

🐾 実装ガイド

Prepare settings

Apple Payを利用するためには、いくつかの設定が必要です。

  • AppleマーチャントIDの登録
  • Apple Payの証明書を新規に作成する
  • Xcodeと統合する

詳細はこちらをご覧ください:

https://stripe.com/docs/apple-pay#merchantid

もしこれらが正しく行われず、 createApplePay に与えられたオプションと異なる場合、このメソッドは実行することができません。

1. isApplePayAvailable

まず、ユーザのデバイスでApple Payが使えるかどうか確認します。

import { Stripe, ApplePayEventsEnum } from '@capacitor-community/stripe';

(async() => {
  // Check to be able to use Apple Pay on device
  const isAvailable = Stripe.isApplePayAvailable().catch(() => undefined);
  if (isAvailable === undefined) {
    // disable to use GooglePay
    return;
  }
})();

このメソッドは resolve(): voidreject('Not implemented on Device.') を返却します。

method isApplePayAvailable()

isApplePayAvailable() => Promise<void>

2. createApplePay

バックエンドエンドポイントに接続し、それぞれのキーを取得する必要があります。これは本プラグインでは「できない」機能です。そのため、 HTTPClientAxiosAjax などの機能を利用することができます。

Stripeは、バックエンドの実装方法を提供します:

https://stripe.com/docs/payments/accept-a-payment?platform=ios#add-server-endpoint

その後、これらのキーを createApplePay メソッドに設定します。

(async() => {
  // Connect to your backend endpoint, and get paymentIntent.
  const { paymentIntent } = await this.http.post<{
    paymentIntent: string;
  }>(environment.api + 'payment-sheet', {}).pipe(first()).toPromise(Promise);

  // Prepare ApplePay
  await Stripe.createApplePay({
    paymentIntentClientSecret: paymentIntent,
    paymentSummaryItems: [{
      label: 'Product Name',
      amount: 1099.00
    }],
    merchantDisplayName: 'rdlabo',
    countryCode: 'US',
    currency: 'USD',
  });
})();

method createApplePay(...)

createApplePay(options: CreateApplePayOption) => Promise<void>

createApplePay では、 CreateApplePayOption のオプションを使用することができます。 merchantIdentifierApple Developer Website で登録した値と同じである必要があります。

interface CreateApplePayOption

Prop Type
paymentIntentClientSecret string
paymentSummaryItems { label: string; amount: number; }[]
merchantIdentifier string
countryCode string
currency string

3. presentApplePay

createApplePay はシングルフローです。 confirm メソッドを必要としません。

(async() => {
  // Present Apple Pay
  const result = await Stripe.presentApplePay();
  if (result.paymentResult === ApplePayEventsEnum.Completed) {
    // Happy path
  }
})();

method presentApplePay()

presentApplePay() => Promise<{ paymentResult: ApplePayResultInterface; }>

presentApplePay の返り値から ApplePayResultInterface を取得することができます。
ApplePayResultInterfaceApplePayEventsEnum から作成されています。したがって、インポートして結果を確認する必要があります。

type alias ApplePayResultInterface

ApplePayEventsEnum.Completed | ApplePayEventsEnum.Canceled | ApplePayEventsEnum.Failed

4. addListener

Apple Payのメソッドはリスナーを通知します。もし、支払い処理が完了したときのイベントを取得したい場合は、 Stripe オブジェクトに ApplePayEventsEnum.Completed リスナーを追加する必要があります。

// be able to get event of ApplePay
Stripe.addListener(ApplePayEventsEnum.Completed, () => {
  console.log('ApplePayEventsEnum.Completed');
});

使用できるイベント名は ApplePayEventsEnum にあります。

enum ApplePayEventsEnum

Members Value
Loaded "applePayLoaded"
FailedToLoad "applePayFailedToLoad"
Completed "applePayCompleted"
Canceled "applePayCanceled"
Failed "applePayFailed"

📖 Reference

詳しくはStripeのドキュメントをご覧ください。このプラグインはラッパーなので、詳しい情報はStripeのドキュメンテーションが役立ちます。

Apple Pay(iOS)

このプラグインの STPApplePayContext は pod 'Stripe' を利用しています。

https://stripe.com/docs/apple-pay

"Merchant name" on the apple pay payment sheet #115

This is good issue for setting "Merchant name".

https://github.com/capacitor-community/stripe/issues/115

import { Stripe, ApplePayEventsEnum } from '@capacitor-community/stripe';

(async() => {
  // Check to be able to use Apple Pay on device
  const isAvailable = Stripe.isApplePayAvailable().catch(() => undefined);
  if (isAvailable === undefined) {
    // disable to use Google Pay
    return;
  }

  // be able to get event of Apple Pay
  Stripe.addListener(ApplePayEventsEnum.Completed, () => {
    console.log('ApplePayEventsEnum.Completed');
  });
  
  // Connect to your backend endpoint, and get paymentIntent.
  const { paymentIntent } = await this.http.post<{
    paymentIntent: string;
  }>(environment.api + 'payment-sheet', {}).pipe(first()).toPromise(Promise);

  // Prepare Apple Pay
  await Stripe.createApplePay({
    paymentIntentClientSecret: paymentIntent,
    paymentSummaryItems: [{
      label: 'Product Name',
      amount: 1099.00
    }],
    merchantDisplayName: 'rdlabo',
    countryCode: 'US',
    currency: 'USD',
  });

  // Present Apple Pay
  const result = await Stripe.presentApplePay();
  if (result.paymentResult === ApplePayEventsEnum.Completed) {
    // Happy path
  }
})();