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の末尾には return_to というクエリーパラメーターを付与し、申請情報のsubmit後にリダイレクト遷移する先を指定してください。
テナントの審査申請ページのURLを作成
curl https://api.pay.jp/v1/tenants/ten_121673955bd7aa144de5a8f6c262/application_urls \
-u sk_live_xxx: \
-XPOST
取得した審査申請ページのURLにURLエンコード済みのリダイレクトURLを付与
https://pay.jp/_/applications/start/32e1ed9eb0484c0fab997fd844475d60?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_121673955bd7aa144de5a8f6c262 \
-u sk_live_xxx: \
-d platform_fee_rate=30
テナントの削除
既存のテナント情報を削除します
curl https://api.pay.jp/v1/tenants/ten_121673955bd7aa144de5a8f6c262 \
-u sk_live_xxx: \
-XDELETE
テナントが本番環境の決済を利用している場合、クレジットカード決済の当該利用契約を停止します。
削除時に未振込の売上金額が振込手数料である250円以上残っている場合には、次回確定分入金時に基本情報として登録済みの銀行口座へ入金します。
テナントAPIのテスト
テナントAPIは基本的にプラットフォーマーのAPIキーを使ってテストが可能です。
以上でテナントの登録・管理のプロセスを説明しました。最後に実際の決済処理と入金の振り分けの実装と仕組みを確認しましょう。