支払い

支払いは、連結アカウントのダイレクト支払い、デスティネーション支払い、支払いと送金別方式の取引リストを表示します。

デフォルトでは、埋め込みコンポーネントでの、デスティネーション支払いと支払いと送金別方式についての情報の表示は限定的です。顧客情報、支払い方法、支払い金額の詳細へはアクセスできません。 destination_on_behalf_of_charge_management機能により、連結アカウントはデスティネーション支払いによる追加情報を確認でき、返金の実行や不審請求の申請の管理を行います。

アカウントセッションを作成する

アカウントセッションの作成時に、components パラメーターで payments を指定して、支払いの埋め込みコンポーネントを有効にします。payments で features パラメーターを指定することにより、支払いのコンポーネントの個々の機能を有効または無効にすることができます。

curl https://api.stripe.com/v1/account_sessions \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d account=
{{CONNECTED_ACCOUNT_ID}} \
  -d "components[payments][enabled]"=true \
  -d "components[payments][features][refund_management]"=true \
  -d "components[payments][features][dispute_management]"=true \
  -d "components[payments][features][capture_payments]"=true \
  -d "components[payments][features][destination_on_behalf_of_charge_management]"=false

payments コンポーネントは、支払いタイプごとに異なる情報を示し、異なる機能をサポートします。

• ダイレクト支払いの場合、連結アカウントはすべての情報を表示できます。アカウントセッションの作成時に対応する機能を有効にした場合は、返金の管理、不審請求の申請の管理、支払いのキャプチャーも行うことができます。
• デスティネーション支払いと支払いと送金別方式の場合、連結アカウントはこの選択された支払いに関連付けられた送金オブジェクトのみを表示でき、これに含まれる情報は限定的です。
• on_behalf_of 属性が指定されたデスティネーション支払いの場合、連結アカウントは destination_on_behalf_of_charge_management 機能が有効な場合にすべての情報を表示できます。この機能が有効になっている場合、対応する機能を有効にすることで、返金および不審請求の申請の管理を有効にすることもできます。

連結アカウントによるデスティネーション支払いの管理を許可する

destination_on_behalf_of_charge_management 機能を true に設定すると、連結アカウントは支払いコンポーネントで on_behalf_of 属性が設定されているデスティネーション支払いを表示および管理できます。dispute_management 機能も有効にすると、連結アカウントは不審請求の申請の処理に直接参加することもできます。

destination_on_behalf_of_charge_management 機能を有効にすることには、次の制限があります。

1. 支払いのステータスや支払い方法で絞り込むことはできません。
2. 特定のデータ列のエクスポートはできません。

支払いコンポーネントを表示する

アカウントセッションを作成して、ConnectJS を初期化すると、フロントエンドに支払いのコンポーネントを表示できます。

// Include this element in your HTML
const payments = stripeConnectInstance.create('payments');
container.appendChild(payments);

// Optional: specify filters to apply on load
// payments.setDefaultFilters({
//   amount: {greaterThan: 100},
//   date: {before: new Date(2024, 0, 1)},
//   status: ['partially_refunded', 'refund_pending', 'refunded'],
//   paymentMethod: 'card',});

Setting default filters

Setting default filters for the payments list is optional. If set, it applies any valid filters and ignores invalid filters. If the destination_on_behalf_of_charge_management feature is enabled, then you can’t filter by status or payment method so it ignores these filters automatically.

You can specify any combination of payment filters of your choice using the PaymentsListDefaultFilters object.

The PaymentsListDefaultFilters object

If you want to specify default filters, pass a PaymentsListDefaultFilters object into the setDefaultFilters setter. The object has the following properties. All properties are optional.

デスティネーション支払いに対する不審請求の申請を管理する

For destination charges, with or without on_behalf_of, Stripe debits dispute amounts and fees from your platform account.

We recommend setting up a webhook to listen to dispute created events. When that happens, you can attempt to recover funds from the connected account by reversing the transfer through the Dashboard or by creating a transfer reversal.

If the connected account has a negative balance, Stripe attempts to debit its external account if debit_negative_balances is set to true.

If you challenge the dispute and win, you can transfer the funds that you previously reversed back to the connected account. If your platform has an insufficient balance, the transfer fails. Prevent insufficient balance errors by adding funds to your Stripe balance.

When both dispute_management and destination_on_behalf_of_charge_management are enabled, the connected accounts can update and modify dispute evidence, counter disputes, and accept disputes for destination charges with the on_behalf_of attribute set to the connected account.

説明をカスタマイズする

destination_on_behalf_of_charge_management オプションを使用している場合、on_behalf_of 属性が指定されたデスティネーション支払いに対して表示される支払い情報 (説明を含む) は、元の作成済みの支払いに対応しています。この機能が無効に設定されている場合に、デスティネーション支払いおよび支払いと送金別方式の支払いの詳細ビュー内にカスタムの説明を表示するには、以下の手順に従います。

デスティネーション支払い

プラットフォームのユーザーに表示される Payment (支払い) オブジェクトの description を更新するには、Stripe API を使用する必要があります。これは、デスティネーション支払いを使用するすべてのプラットフォームに適用されます。

1. アカウントに対して作成した既存の Transfer オブジェクトを見つけます。これには、PaymentIntent (支払いインテント) オブジェクトで作成された最新の charge を見つけます。
2. Charge (支払い) オブジェクトを使用して、その支払いに関連付けられている transfer オブジェクトを見つけます。
3. Transfer オブジェクトを使用して、その送金に存在する destination_payment ID を見つけます。
4. Update Charge API を呼び出して、destination_payment ID を使用してデスティネーション支払いの description を更新します。

curl https://api.stripe.com/v1/charges/
{{PAYMENT_ID}} \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -H "Stripe-Account: 
{{CONNECTED_ACCOUNT_ID}}
" \
  -d description="My custom description"

この説明は、このフィールドの入力後に支払いで表示されるようになります。

プラットフォームでのデスティネーション支払いの作成の詳細をご覧ください。

支払いと送金別方式

プラットフォームのユーザーに表示される Payment (支払い) オブジェクトの description を更新するには、Stripe API を使用する必要があります。これは、支払いと送金別方式を使用するプラットフォームに適用されます。

1. Transfer オブジェクトを使用して、その送金に存在する destination_payment ID を見つけます。
2. Update Charge API を呼び出して、前のステップで見つかった destination_payment ID を使用してデスティネーション支払いの description を更新します。

curl https://api.stripe.com/v1/charges/
{{PAYMENT_ID}} \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -H "Stripe-Account: 
{{CONNECTED_ACCOUNT_ID}}
" \
  -d description="My custom description"

この説明は、このフィールドの入力後に支払いで表示されるようになります。

支払いと送金別方式の作成の詳細をご覧ください。