Payouts 型のテナントは、テナントの作成・継続管理までAPIを利用して実装することができます。
ここではテナントの作成からテナント管理までのプロセスについて説明します。
前提
ここで登録されたテナントは、基本的に PAY.JPを認識しない想定 となります。 テナントを作成・管理するのはあくまでプラットフォーマーであり、テナント側がPAY.JPを認識し、PAY.JP上で自ら売上・返金などの操作をすることは想定されていません。
またテナントはPAY.JPのダッシュボードにログインすることはできません。
一方でプラットフォーマーは、あらゆるPAY.JP APIに付随する操作に加え、テナントの銀行口座および最低入金額などを管理・変更することが可能です。
テナントの新規作成
Platform APIを使ってまずはテナントの作成を行いましょう。
テナントの新規作成
$ curl https://api.pay.jp/v1/tenants \
-u sk_live_xxxxxxxxxxxxxxxxxxxxxx: \
-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_xxxxxxxxxxxxxxxxxxxxxx: \
-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決済手数料を差し引いた金額がプラットフォーマーの入金額になります。
テナント登録時の利用規約について
PAY.JP Platform の利用規約には下記の2種類(※)が存在しています。
1の「PAY.JP Platform（Payouts）プラットフォーマー利用規約」はプラットフォーマーに対して PAY.JP Platform 新規登録時に適用される利用規約です。
対して2の「PAY.JP Platform（Payouts）ユーザー利用規約」はプラットフォーマーに紐づくテナントに適用されることを想定した利用規約です。
PAY.JP Platform（Payouts）ユーザー利用規約については、プラットフォーマー側のWebサイトなどでテナントに同意していただくことが利用条件となっておりますので、サービス実装の際にそちらを考慮したサービス設計としてください。
具体的にはプラットフォーム加盟店向け利用規約のリンクを、当該テナントに適用される御社サービスの規約内に設けていただく、といった方法を推奨いたします。
テナントの管理
テナントの情報更新、削除といった操作を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キーを使ってテストが可能です。
以上でテナントの登録・管理のプロセスを説明しました。最後に実際の決済処理と入金の振り分けの実装と仕組みを確認しましょう。