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
テナントが本番環境の決済を利用している場合、クレジットカード決済の当該利用契約を停止します。
削除時に残高がある場合は、直近の締め日で集計を行い、振込を実施します。 振込先の口座は、削除前に登録されていたテナントの口座宛となります。
残高が1,000円に満たない場合はテナントへの振込は実施せず、プラットフォーマーの利用料に合算し振込します。
※残高の合算の際は振り込み手数料は差し引かず、残っている残高をすべて合算します。その後、プラットフォーマーへの振り込みの際に、通常どおり振り込み手数料を差し引きます。
テナントAPIのテスト
テナント API は基本的にプラットフォーマーの API キーを使ってテストが可能です。
以上で、テナントの登録・管理のプロセスを説明しました。最後に、実際の決済処理と入金の振り分けの実装と仕組みを確認しましょう。