PAY.JP Platform では、テナントごとの売上処理に対して、プラットフォーマー自身の取り分である料金を設定できます。これにより、プラットフォーマーとテナントへの入金額の振り分けをコントロールできます。
本ドキュメントでは、プラットフォーマー料金を使ったテナントの売上処理と入金振り分けまでのプロセスについて説明します。
前提条件
テナントの売上処理は、プラットフォーマーの API キーを使って通常の PAY.JP API を利用します。
PAY.JP API の利用方法については、以下のドキュメントを参考にしてください。
プラットフォーム利用料を使ったテナントの売上処理
テナントが Charge 作成時に対象の tenant ID を指定し、platform_fee に料金を設定するだけで、プラットフォーマーの取り分を徴収できます。
プラットフォーム利用料を設定してテナントの売上処理を行う例
$ curl https://api.pay.jp/v1/charges -u sk_live_... \
-d amount=500 \
-d card=token \
-d currency=jpy \
-d platform_fee=100 \
-d tenant=ten_xxxxx
上記のリクエストでは以下のような金額の振り分けが行われます
- テナント：
400円 - PAY.JP 売上手数料(500円に対する売上手数料)の入金 - プラットフォーマー:
100円の入金 - 消費者：
500円の請求
テナントに対する PAY.JP 売上手数料は、amount に指定した満額（platform_fee を差し引かない金額）に対してかかります。
Platform API では以下の点が通常の 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_xxxxx/transfers/ten_tr_yyyyy \
-u sk_live_xxx:
テナントの入金リストを取得
curl https://api.pay.jp/v1/tenants/ten_xxxxx/transfers?limit=3 \
-u sk_live_xxx:
プラットフォーマーの入金情報
プラットフォームの入金に紐づくテナントの入金情報を取得
curl https://api.pay.jp/v1/transfers/tr_xxxxx/tenant_transfers/ten_tr_yyyyy \
-u sk_live_xxx:
プラットフォームの入金に紐づくテナントの入金リストを取得
curl https://api.pay.jp/v1/transfers/tr_xxxxx/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 amount=500 \
-d card=token \
-d currency=jpy \
-d platform_fee=100 \
-d tenant=ten_xxxxx
上記の売上は、当該テナントのテスト Transfer として所定のサイクルで入金が生成されます。