Marketplace 型のテナントでは、API を利用してテナントの作成・クレジットカード審査依頼・継続管理までを実装できます。
このドキュメントでは、テナントの作成からクレジットカード審査依頼の方法、そしてテナント管理のプロセスについて説明します。
前提条件
テナントを作成・管理するのはプラットフォーマーの役割です。テナント自身が PAY.JP 上で売上・返金などの操作を行うことは想定されていません。
また、テナントは PAY.JP のダッシュボードにログインできません。
一方、プラットフォーマーは、PAY.JP API に付随するすべての操作に加え、テナントの銀行口座や最低入金額などを管理・変更することが可能です。
テナントの新規作成
まずは、Platform API を使ってテナントを作成しましょう。
テナントの新規作成
$ curl https://api.pay.jp/v1/tenants \
-u sk_live_xxx: \
-d id=test \
-d name=test \
-d platform_fee_rate=10.15 \
-d minimum_transfer_amount=1000 \
-d bank_account_holder_name=ペイタロウ \
-d bank_code=0001 \
-d bank_branch_code=001 \
-d bank_account_type=普通 \
-d bank_account_number=0001000 \
テナントの表示名称である name など、必須のパラメーターを設定してテナントを新規作成します。
通常、プラットフォーム利用者の店子（以下、テナント）の情報を元に新規テナントを作成します。そのため、プラットフォーマー側で専用の入力フォームなどを用意する必要があります。
プラットフォーム利用料に PAY.JP 決済手数料を含める
通常、テナントへの入金額は、決済金額からプラットフォーム利用料と PAY.JP 決済手数料を差し引いた金額になります。PAY.JP 決済手数料はカードブランド毎に異なるため、差し引かれる金額は決済毎に変動します。プラットフォーム利用料に PAY.JP 決済手数料を含むよう設定することで、テナントから差し引かれる金額を platform_fee_rate に設定した料率に固定できます。
テナントの作成時に payjp_fee_included を指定することで設定します。payjp_fee_included は後から変更できません。
$ curl https://api.pay.jp/v1/tenants \
-u sk_live_xxx: \
-d id=test \
-d name=test \
-d platform_fee_rate=10.15 \
-d payjp_fee_included=true \
-d minimum_transfer_amount=1000 \
-d bank_account_holder_name=ペイタロウ \
-d bank_code=0001 \
-d bank_branch_code=001 \
-d bank_account_type=普通 \
-d bank_account_number=0001000 \
この場合、カードブランドに関わらず、決済金額から 10.15% を差し引いた金額がテナントに入金されます。そして、10.15% から PAY.JP 決済手数料を差し引いた金額がプラットフォーマーの入金額になります。
本番利用申請
テナントが本番環境を利用するには、プラットフォーマー自身の本番利用申請が必要です。
本番利用申請は、Platform 用の専用管理画面から行うことができます。
テナントの基本情報の申請
Visa/MasterCard/JCB/American Express/Discoverの審査
Marketplace 型のテナントでは、Visa/Mastercard/JCB/American Express/Discover などのカードブランド別の本番利用申請が必要となります。 この申請はテナント自身で行いますが、申請用のフォームはプラットフォーマー側で PAY.JP の API を利用して払い出す必要があります。
流れとしては、プラットフォーマー側で PAY.JP API 経由でワンタイムの審査申請ページ URL を取得し、その URL をテナントに提供します。
テナントはこの申請ページで、プラットフォームを利用するにあたっての基本情報を入力します。
取得した審査申請ページ URL の末尾には return_to というクエリーパラメーターを付与し、申請情報の submit 後にリダイレクト遷移する先を指定してください。
テナントの審査申請ページの URL を作成
curl https://api.pay.jp/v1/tenants/ten_xxxxx/application_urls \
-u sk_live_xxx: \
-XPOST
取得した審査申請ページの URL に URL エンコード済みのリダイレクト URL を付与
https://pay.jp/_/applications/start/xxxxx?return_to=https%3A%2F%2Fexample.com
詳細は、API リファレンスの テナントの審査申請ページのURLを作成 をご参照ください。
テナントからこの申請が行われると、自動的に PAY.JP / クレジットカード会社側で Visa/Mastercard/JCB/American Express/Discover の審査が実施されます。
注意: テナントがクレジットカード審査を通過するまでは売上作成ができません。
また、審査の際に確認が必要な情報がある場合、PAY.JP からプラットフォーマーのメールアドレス宛にテナント情報の修正依頼または確認の連絡をすることがあります。
修正が必要な場合は、以下のステップで修正を行ってください。
- プラットフォーマーがテナントの審査申請ページを払い出す API を利用して申請ページを取得し、その払い出された URL に対してテナント自身で対象項目を修正する
- テナント側での修正が完了したら、プラットフォーマーから PAY.JP 宛に修正の連絡を行う
Visa/Mastercard の審査結果は最短 2 営業日でご連絡いたします。
JCB/American Express/Discover は、審査結果までに 15 営業日ほどのお時間をいただいております。
テナント登録時の利用規約について
PAY.JP Platform の利用規約には以下の 2 種類があります。
1 の「PAY.JP Platform（Marketplace）プラットフォーマー利用規約」は、プラットフォーマーに対して PAY.JP Platform 新規登録時に適用される利用規約です。
一方、2 の「PAY.JP Platform（Marketplace）加盟店利用規約」は、プラットフォーマーに紐づくテナントに適用されることを想定した利用規約です。
PAY.JP Platform（Marketplace）加盟店利用規約については、テナントから PAY.JP への本番申請時に、PAY.JP の本番申請ページから同意いただく流れとなっております。
審査結果の通知
テナントの本番申請後、審査結果が反映されるとイベントが生成されます。イベントは、Webhook を設定して通知するように設定できます。 Webhook の詳しい仕様についてはこちらからご覧ください。
審査結果の詳細は、イベントのテナントオブジェクトの reviewed_brand で確認できます。詳しくはこちらからご覧ください。
テナントの管理
テナントの情報更新や削除といった操作を API で行うことができます。
テナントの情報更新
テナントから取得する料率（platform_fee_rate）や最低入金額（minimum_transfer_amount）、銀行情報を更新できます。
curl https://api.pay.jp/v1/tenants/ten_xxxxx \
-u sk_live_xxx: \
-d platform_fee_rate=30
テナントの削除
既存のテナント情報を削除します。
curl https://api.pay.jp/v1/tenants/ten_xxxxx \
-u sk_live_xxx: \
-XDELETE
テナントが本番環境の決済を利用している場合、クレジットカード決済の当該利用契約を停止します。
削除時に残高がある場合は、直近の締め日で集計を行い、振込を実施します。 振込先の口座は、削除前に登録されていたテナントの口座宛となります。
残高が1,000円に満たない場合は、テナントへの振込は実施せず、プラットフォーマーの利用料に合算し振込します。
※残高の合算の際は振り込み手数料を差し引かず、残っている残高をすべて合算します。その後、プラットフォーマーへの振り込みの際に、通常どおり振り込み手数料を差し引きます。
テナントAPIのテスト
テナント API は基本的にプラットフォーマーの API キーを使ってテストが可能です。
以上で、テナントの登録・管理のプロセスを説明しました。最後に、実際の決済処理と入金の振り分けの実装と仕組みを確認しましょう。