レスポンス拡張のユースケース

API レスポンスを拡張して一般的な決済の詳細を返すようにします。

API がデフォルトのレスポンスで返さない詳細を取得するには、API リクエストで expand パラメーターを使用します。以下のユースケースは、よく要求される情報に関しての説明です。

特定の支払いに対する Stripe 手数料を確認する

決済が処理され、Stripe が Balance Transaction (取引残高) を作成した後で、決済の処理手数料を確認できます。charge.updated イベントは、balance_transaction プロパティ (txn_123 など) を参照し、使用する準備ができたことを示します。

取引残高を個別に検索する代わりに、expand を使用して 1 回のコールで取得できます。

注

IC+ ユーザーは、取引残高から支払い手数料の情報を取得できません。代わりに、決済手数料レポートを使用してください。

API バージョン 2022-08-01 以前のユーザー:

注

PaymentIntent がキャプチャーされ、ステータスが succeeded になると、Stripe 手数料が表示されます。

入金に含まれる支払いを確認する

各自動入金は、Stripe アカウントの残高の履歴変更に結びついています。この API はこれらの履歴変更を Balance Transaction (取引残高) として記録します。これは、List Balance Transactions API を使用して取得できます。取引残高のリストから、source プロパティを展開し、何 (支払い、返金、送金など) がアカウント残高の変化を引き起こしたのか、情報を集めることができます。以下に例を挙げます。

注

「自動」入金に関してのみ、取引残高履歴を取得できます。手動の入金が有効になっている場合には、ご自身で残高履歴を追跡する必要があります。

入金の照合で詳細をご覧ください。

デスティネーション支払いで Connect を使用している場合、連結アカウントの代わりに同じ情報を取得することができます。唯一の違いは、デスティネーション支払いでは、売上を連結アカウントに移動するために、送金および関連付けられた支払い (Charge オブジェクトの形式で) の両方が関与します。このため、連結アカウントの入金にバンドルされた取引残高をリストアップする際、各取引のソースは元の Charge ではなく、送金の支払いに関連付けられます。元の Charge を取得するには、source_transfer プロパティを使用して、支払いに関連付けられた送金を拡張する必要があります。そこから、送金の source_transaction プロパティを拡張します。