👛

【Shopify.dev和訳】Apps/Payments/Merchant onboarding

2021/09/30に公開

Shopify

apps

tech

この記事について

この記事は、Apps/Payments/Merchant onboardingの記事を和訳したものです。

記事内で使用する画像は、公式ドキュメント内の画像を引用して使用させていただいております。

Shopify アプリのご紹介

Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。

Shopify アプリである、「らくらく日本語フォント設定｜リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。

マーチャントをペイメントアプリにオンボーディングする

マーチャントエクスペリエンス

マーチャントは、あなたのアプリとインタラクトする際に、以下の重要なタスクを完了します。

発見:決済ペイメントアプリを発見し、インストールします。
インストール：OAuth フローを使用してアプリをインストールします。
設定：アプリの設定を行います。
起動：アプリを起動します。

次の図は、構築プロセスのすべての側面がどのように組み合わされ、ペイメントアプリのマーチャントエクスペリエンスをサポートするかを示しています。

ペイメントアプリは、ペイメント開発者が共有するインストールリンクを介してマーチャントが直接インストールすることも、Shopify の管理画面にある Shopify のペイメントゲートウェイの公開リストを介してインストールすることもできます。
マーチャントは、OAuth を使ってアプリに接続します。
マーチャントは設定を行うためにペイメントアプリのページにリダイレクトされます。この間、プロバイダがまだ支払いを処理する準備ができていないことを示すバナーが表示されます。
マーチャントがペイメントアプリを設定します。
アプリは Shopify API を呼び出すことで、準備ができていることを示します。
Shopify は Shopify 管理画面でマーチャントがアプリを有効化できるようにします。
マーチャントはアプリをアクティブにします。

発見

マーチャントがペイメントアプリを発見するには 2 つの方法があります。

直接のインストールリンクを通じて。
直接インストールする方法と、Shopify が公開している代替決済方法の下にある決済ゲートウェイのリストから。

Shopify の管理画面でペイメントゲートウェイのリストに追加されるには、ペイメントアプリが少なくとも 50 の Shopify ストアで使用され、1,000,000 米ドル以上を処理している必要があります。

インストール方法

OAuth を使用して、マーチャントからペイメントアプリをインストールする許可を得ます。マーチャントはアプリをインストールするためのリンクをクリックすると、Shopify の OAuth 画面にリダイレクトされます。

マーチャントが OAuth の許可に同意した後、アプリは API アクセスのためのアクセストークンを要求します。

ステップ 1：アプリへの接続

初めてペイメントアプリを選択した後、マーチャントには説明とConnectボタンが表示されます。Connectをクリックすると、マーチャントは［ペイメントアプリ］の URL にリダイレクトされます。これにより、OAuth によるインストールが開始されます。

ステップ 2：アプリ URL のホスト

マーチャントがアプリに許可を与えることができるように、サーバー上に OAuth アプリ URL をホストします。

https://{shop}.myshopify.com/admin/oauth/authorize?client_id={api_key}&scope={scopes}&redirect_uri={redirect_uri}&state={nonce}&grant_options[]={access_mode}。

アプリの URL プロパティの定義については、OAuthを参照してください。

アクセス許可

以下の OAuth アクセススコープをマーチャントに要求できます。

write_payment_gateways:マーチャントのオンボーディングとレディネス管理に関連する API へのアクセスを許可します。
- PaymentsAppConfigure のミューテーションに必要です。
write_payment_sessions:支払い要求とコールバック API に関連する API へのアクセスを許可します。
- PaymentSessionResolve、PaymentSessionReject、RefundSessionResolve、および RefundSessionReject に必要です。

より詳細な情報は、「OAuth での認証」を参照してください。

ステップ 3：ショップのトークンを取得する

コードをトークンに交換することで、ショップのトークンを取得できます。マーチャントがあなたのアプリに許可を与えると、アクセストークンと交換できるコードを含む以下のリダイレクト URL があなたのアプリサーバーに返されます。

https://example.org/some/redirect/uri?code={authorization_code}&hmac=da9d83c171400a41f8db91a950508985&timestamp=1409617544&state={nonce}&shop={hostname}

ステップ 4：ユーザーをアプリのオンボーディングにリダイレクトする

マーチャントがリダイレクト URLにリダイレクトされて、インストールフローが終了します。

プロバイダの承認と設定

インストールが完了すると、マーチャントは構成を完了するためにペイメントアプリにリダイレクトされます。このページに何が書かれているかは、アプリの開発者に任されています。マーチャントは、このステップの一環として、必要な認証や構成を行います。

例えば、以下のようになります。

マーチャントにペイメントプロバイダーへのログインまたはアカウントの作成を促す。
マーチャントに課金プラン、ペイアウト、または通知の設定を完了するよう求める。

プロバイダの準備

アプリは Shopify にマーチャントのために支払いを処理する準備ができていることを知らせる必要があります。それまでは、Shopify はマーチャントへのリマインダーとして、Shopify admin に警告バナーを表示します。

GraphQL ミューテーション

paymentsAppConfigure mutation を呼び出すことで、アプリを支払い処理の準備ができた状態にすることができます。

このミューテーションには、2 つの必須引数があります。

externalHandle:マーチャントがパートナーで使用しているアカウントに関連するユーザー名または識別子。これは Shopify admin の Settings の Payments セクションに表示されます。これにより、マーチャントは接続されたペイメントプロバイダーのアカウントを識別することができます。
ready: プロバイダーが支払いを処理する準備ができていることを示すシグナルです。受け入れられる値は true または false です。
- true :アプリの支払い処理を許可します。
- false:アプリがまだ支払いを処理できないことを示します。

ready: false と externalHandle を設定すると、マーチャントにアカウント接続は確立されているが、支払いを処理するた最終確認と承認を待っていることを知らせることができます。

POST https://{shop_domain}/payments_apps/api/2021-07/graphql.json

mutation PaymentsAppConfigure($externalHandle: String, $ready: Boolean!) {
  paymentsAppConfigure(externalHandle: $externalHandle, ready: $ready) {
    userErrors {
      field
      message
    }
  }
}

マーチャントがあなたのアプリのオンボーディングに必要なアクションをすべて完了したら、次の URL を使って Shopify 管理者にリダイレクトしなければなりません。

https://{shop}.myshopify.com/services/payments_partners/gateways/${api_key}/settings

アクティベーション

認証と設定が完了すると、マーチャントは Shopify 管理画面に戻り、提供する支払い方法を選択します。これらの支払い方法は、チェックアウト時に支払いアイコンとして顧客に表示されます。

マーチャントは Shopify 管理画面の代替決済方法の設定を使用して、決済アプリを有効にしたり無効にしたりします。

詳しくは、代替決済アプリについてをご覧ください。

無効化

マーチャントがペイメントアプリを必要としなくなった場合は、アプリを非アクティブにすることができます。マーチャントがペイメントアプリを非アクティブにすると、顧客はチェックアウト時にペイメントアプリを選択できなくなります。ただし、非アクティブにしたペイメントアプリで作成した注文の返金やキャプチャは管理できます。詳しくは、代替決済アプリをご参照ください。

次のステップ

その他の情報

Shopify アプリのご紹介

Discussion

ログインするとコメントできます