Finances API ドキュメント
財務 API（Finances API）
Finances API は、販売者の支払い（Payout）と、その支払いに関連する金銭取引の詳細を取得するために使用されます。支払いの一覧・詳細・サマリー、取引の一覧・サマリー、振替の詳細、セラー資金サマリーの取得をサポートします。
重要: EU および UK の支払い規制要件により、EU/UK の販売者に代わって行われる Finances API 呼び出しには、デジタル署名による追加のセキュリティ検証が必要です。
バージョン: v1.18.0
ベースURL: https://api.ebay.com/sell/finances/v1
認証（OAuth スコープ）
この API は 認可コード（Authorization Code） フローを使用します。
| スコープ | 説明 |
|---|---|
https://api.ebay.com/oauth/api_scope/sell.finances | 支払いおよび注文情報の表示と管理 |
リソース一覧
Finances API は以下の 5 リソース、合計 8 エンドポイント（すべて GET）で構成されています。
| リソース | 説明 | 数 |
|---|---|---|
| billing_activity | 請求アクティビティの取得 | 1 |
| payout | 支払い情報の取得 | 3 |
| seller_funds_summary | セラー資金サマリーの取得 | 1 |
| transaction | 金銭取引の取得 | 2 |
| transfer | 振替の詳細取得 | 1 |
billing_activity（1 エンドポイント）
GET /billing_activity
getBillingActivities — 請求アクティビティを取得します（OpenAPI 仕様のみ定義）。
レスポンス: 200 / 400 / 500
payout — 支払い情報（3 エンドポイント）
GET /payout
getPayouts — 1 つ以上の販売者支払いの詳細を取得します。日付範囲、支払いステータスでフィルタリング可能。ページ区切りと並べ替えをサポート。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | eBay マーケットプレイス ID。デフォルト: EBAY_US |
filter | クエリ | 任意 | フィルター。payoutDate（日付範囲）、lastAttemptedPayoutDate（失敗時）、payoutStatus（ステータス） |
sort | クエリ | 任意 | 並べ替え。デフォルト: 支払い日降順。値: payoutDate、lastAttemptedPayoutDate |
limit | クエリ | 任意 | 最大: 200、デフォルト: 20 |
offset | クエリ | 任意 | デフォルト: 0。5000 未満を推奨。 |
レスポンス: 200 / 204 / 400 / 500
GET /payout/{payout_Id}
getPayout — 特定の販売者支払いの詳細を取得します。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
payout_Id | パス | 必須 | 支払いの一意の識別子。 |
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | eBay マーケットプレイス ID。 |
レスポンス: 200 / 400 / 404 / 500
GET /payout_summary
getPayoutSummary — 支払いの累積値（合計支払い額、取引数、合計金額）を取得します。ステータスや日付範囲でフィルタリング可能。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | eBay マーケットプレイス ID。 |
filter | クエリ | 任意 | payoutDate（日付範囲）、payoutStatus（ステータス） |
レスポンス: 200 / 400 / 500
seller_funds_summary（1 エンドポイント）
GET /seller_funds_summary
getSellerFundsSummary — 支払いを通じてまだ分配されていないすべての保留中の資金を取得します。利用可能な資金、処理中の資金、保留中の資金の合計を返します。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | eBay マーケットプレイス ID。 |
レスポンス: 200 / 204 / 500
transaction — 金銭取引（2 エンドポイント）
GET /transaction
getTransactions — 1 つ以上の金銭取引に関する情報を取得します。多数のフィルター（日付、種類、ステータス、購入者名、注文 ID 等）で絞り込み可能。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | eBay マーケットプレイス ID。 |
filter | クエリ | 任意 | transactionDate、transactionType、transactionStatus、buyerUsername、salesRecordReference、payoutId、transactionId、orderId |
sort | クエリ | 任意 | 並べ替え。デフォルト: 取引日降順。値: transactionDate |
limit | クエリ | 任意 | 最大: 1000、デフォルト: 20 |
offset | クエリ | 任意 | デフォルト: 0。5000 未満を推奨。 |
レスポンス: 200 / 204 / 400 / 500
GET /transaction_summary
getTransactionSummary — 金銭取引の累積情報を取得します。transactionStatus フィルターが必須。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | eBay マーケットプレイス ID。 |
filter | クエリ | 必須 | transactionStatus（必須）、transactionDate、transactionType、buyerUsername、salesRecordReference、payoutId、transactionId、orderId |
レスポンス: 200 / 400 / 500
transfer — 振替（1 エンドポイント）
GET /transfer/{transfer_Id}
getTransfer — TRANSFER トランザクションタイプの詳細情報を取得します。TRANSFER は、販売者が料金の払い戻しのために eBay に送金する金銭取引です。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
transfer_Id | パス | 必須 | TRANSFER の一意の識別子。getTransactions で transactionType=TRANSFER として取得。 |
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | eBay マーケットプレイス ID。 |
レスポンス: 200 / 400 / 404 / 500
エンドポイント一覧（全 8 エンドポイント）
| メソッド | エンドポイント | operationId | 説明 |
|---|---|---|---|
| GET | /billing_activity | getBillingActivities | 請求アクティビティを取得 |
| GET | /payout | getPayouts | 支払い一覧を取得 |
| GET | /payout/{payout_Id} | getPayout | 支払い詳細を取得 |
| GET | /payout_summary | getPayoutSummary | 支払いサマリーを取得 |
| GET | /seller_funds_summary | getSellerFundsSummary | セラー資金サマリーを取得 |
| GET | /transaction | getTransactions | 取引一覧を取得 |
| GET | /transaction_summary | getTransactionSummary | 取引サマリーを取得 |
| GET | /transfer/{transfer_Id} | getTransfer | 振替詳細を取得 |
スキーマ数: 26（詳細は OpenAPI 仕様を参照）