テナントごとの売上処理に対して、プラットフォーマーの自身の取り分である料金をセットすることができます。
これにより、プラットフォーマーとテナントへの入金額の振り分けをコントロールすることができます。
ここではプラットフォーマー料金を使ったテナントの売上処理と入金振り分けまでのプロセスについて説明します。
前提
テナントの売上処理はプラットフォーマーのAPIキーを使って、通常のPAY.JP APIを利用します。
PAY.JP APIの利用方法については、下記チュートリアルを参考にしてください。
プラットフォーム利用料を使ったテナントの売上処理
テナントによるCharge作成の際に対象の tenant ID を指定して platform_fee に料金をセットするだけで、プラットフォーマーの取り分を徴収することができます。
プラットフォーム利用料をセットしてテナントの売上処理を行う
$ curl https://api.pay.jp/v1/charges -u sk_live_... \
-d amonut=500 \
-d card=token \
-d currency=jpy \
-d platform_fee=100 \
-d tenant=ten_xxxxxxxxxxxxxxx
上記のリクエストで下記のような金額の振り分けが完了しました。
- テナント:
400円 - PAY.JP 売上手数料(500円に対する売上手数料)の入金 - プラットフォーマー:
100円の入金 - 消費者:
500円の請求
テナントに対するPAY.JP 売上手数料は amount に指定した満額(platform_feeを差し引かない金額)に対してかかります。
なお Platform では、下記の点が通常の PAY.JP API と異なります。
- Charge 作成時に tenant の指定が必要
- Charge 毎にプラットフォーマーの入金金額として platform_fee を指定可能
- 各 Charge API のレスポンスに以下のパラメータが追加される
| パラメータ | 説明 |
|---|---|
| platform_fee | Platform APIでplatform_fee_rateでの算出額の代わりにプラットフォーマーに振り分けられる入金金額 |
| platform_fee_rate | テナント作成時に指定したプラットフォーム利用料率(%) |
| tenant | テナントID |
| total_platform_fee | 最終的にプラットフォーマーに振り分けられる入金金額(小数の場合は切捨) |
プラットフォーム利用料にPAY.JP決済手数料を含むテナントの売上処理
テナント作成時にpayjp_fee_includedを有効にしている場合、上記のリクエストで下記のような金額の振り分けになります。
- テナント:
400円 - 100円(プラットフォーム利用料)の入金 - プラットフォーマー:
100円 - PAY.JP 売上手数料(500円に対する売上手数料)の入金 - 消費者:
500円の請求
入金の振り分け
PAY.JP Platform 経由で作成したテナントによる売上はすべてPAY.JP側で集計され、入金処理が行われます。
platform_fee はプラットフォーマー向けの入金額として、 platform_fee とPAY.JP売上手数料を差し引いた売上金額はテナント向けの入金額として、プラットフォーマーが登録するプランの入金サイクルに準じて、入金が実施されます。
入金状況はAPI・管理画面から確認が可能です。 プラットフォーマー/テナントの入金情報については、プラットフォーマーのAPIキーを使って、Platform APIを利用して閲覧します。
テナントの入金情報
テナントの入金情報を取得
curl https://api.pay.jp/v1/tenants/ten_121673955bd7aa144de5a8f6c262/transfers/ten_tr_23748b8c95c79edff22a8b7b795xx \
-u sk_live_xxx:
テナントの入金リストを取得
curl https://api.pay.jp/v1/tenants/ten_121673955bd7aa144de5a8f6c262/transfers?limit=3 \
-u sk_live_xxx:
プラットフォーマーの入金情報
プラットフォームの入金に紐つくテナントの入金情報を取得
curl https://api.pay.jp/v1/transfers/tr_8f0c0fe2c9f8a47f9d18f03959ba1/tenant_transfers/ten_tr_23748b8c95c79edff22a8b7b795xx \
-u sk_live_xxx:
プラットフォームの入金に紐つくテナントの入金リストを取得
curl https://api.pay.jp/v1/transfers/tr_8f0c0fe2c9f8a47f9d18f03959ba1/tenant_transfers?limit=3 \ \
-u sk_live_xxx:
管理画面からプラットフォーマーの入金情報を確認
また同画面から各テナント・売上ごとの内訳CSVをダウンロードできます:
売上処理のAPIテスト
プラットフォーマーのAPIキーを利用してリクエストを行うPAY.JP APIでは、通常のPAY.JP同様にテスト用のキーを使ってテストが可能です。
Platform API経由で作成したテナントでは platform_fee をセットしたテストリクエストも可能です。
platform_fee をセットしてテナントの売上テスト:
$ curl https://api.pay.jp/v1/charges -u sk_test... \
-d amonut=500 \
-d card=token \
-d currency=jpy \
-d platform_fee=100 \
-d tenant=ten_xxxxxxxxxxxxxxx
上記売上は当該テナントのテスト Transfer として所定のサイクルで入金が生成されます。
以上でプラットフォーマー利用料をセットした売上処理と入金の振り分けまでの流れを説明しました。