PAY.JP Platform 売上・入金の振り分け（Marketplace/Payouts）

プラットフォーマー料金を使ったテナントの売上処理と入金の振り分け

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

上記のリクエストでは以下のような金額の振り分けが行われます

テナントに対する PAY.JP 売上手数料は、amount に指定した満額（platform_fee を差し引かない金額）に対してかかります。

Platform API では以下の点が通常の PAY.JP API と異なります

パラメーター	説明
platform_fee	Platform APIで `platform_fee_rate` での算出額の代わりにプラットフォーマーに振り分けられる入金金額
platform_fee_rate	テナント作成時に指定したプラットフォーム利用料率(%)
tenant	テナントID
total_platform_fee	最終的にプラットフォーマーに振り分けられる入金金額(小数の場合は切捨)

テナント作成時に payjp_fee_included を有効にしている場合、上記のリクエストで以下のような金額の振り分けになります

PAY.JP Platform 経由で作成したテナントによる売上はすべて PAY.JP 側で集計され、入金処理が行われます。

platform_fee はプラットフォーマー向けの入金額として、platform_fee と PAY.JP 売上手数料を差し引いた売上金額はテナント向けの入金額として、プラットフォーマーが登録するプランの入金サイクルに準じて入金が実施されます。

売上の集計と入金の状態は、締め区間を表す Term オブジェクト、集計結果を表す Statement オブジェクト、残高と入金状態を表す Balance オブジェクトで管理されています。プラットフォーマーの API キーを使って、プラットフォーマー自身とテナントの両方の情報を取得できます。

なお、Transfer および TenantTransfer オブジェクトは 2024/06/01 以降、作成と更新が停止されています。詳しくはTransfer 廃止に伴う移行ガイドをご覧ください。

プラットフォーマーの 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

上記の売上は、当該テナントのテストモードの Term と Balance として所定のサイクルで集計されます。