Skip to content
Create account
 or
Sign in
The Stripe Docs logo
/
Create account
Sign in
Overview

Payments

Show a list of payments with export, refund, and dispute capabilities.

Payments renders a transaction list for direct charges, destination charges, and separate charges and transfers on the connected account.

By default, the embedded components offer limited information for destination charges and separate charges and transfers. They don’t provide access to customer information, payment methods, and some charge amount details. The destination_on_behalf_of_charge_management feature allows a connected account to see additional information with destination charges, as well as perform refunds and manage disputes.

Create an Account Session

When creating an Account Session, enable the payments embedded component by specifying payments in the components parameter. You can turn on or off an individual feature of the payments component by specifying the features parameter under payments:

Command Line
curl https://api.stripe.com/v1/account_sessions \
  -u "
sk_test_4eC39HqLyjWDarjtT1zdp7dc
:" \
  -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

The payments component shows different information and supports different features for different charge types:

  • For direct charges, your connected accounts can view the complete set of information. They can also manage refunds, manage disputes, and capture payments if you enable the corresponding features when creating an account session.
  • For destination charges and separate charges and transfers, your connected accounts can only see the transfer object associated with the selected charge, which contains limited information.
  • For destination charges with the on_behalf_of attribute, your connected accounts can view the complete set of information when the destination_on_behalf_of_charge_management feature is enabled. When this feature is turned on, you can also enable refund and disputes management by enabling the corresponding features.

Allow your connected accounts to manage destination charges

When you set the destination_on_behalf_of_charge_management feature to true, your connected accounts can use the payments component to view and manage destination charges that have the on_behalf_of attribute. If you also turn on the dispute_management feature, your connected accounts can participate directly in handling their disputes.

Enabling the destination_on_behalf_of_charge_management feature has the following limitations:

  1. You can’t filter by charge status or payment methods.
  2. You can’t export certain data columns.

Render the payments component

After creating the account session and initializing ConnectJS, you can render the payments component in the front end:

payments.js
// 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',});
MethodTypeDescriptionDefault
setDefaultFiltersPaymentsListDefaultFiltersOn load, show the payments matching the filter criteria. See the possible PaymentsListDefaultFilters properties.none

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.

NameTypeDescriptionExample value
amount{equals: number} | {greaterThan: number} | {lessThan: number} | {between: {lowerBound: number, upperBound: number}}Filter by the payment amount (to the nearest hundredth).{greaterThan: 100}
date{before: Date} | {after: Date} | {between: {start: Date; end: Date} Provide Date objects to filter by date. It accepts any date format allowed by a JavaScript Date object. Only the year, month, and day are taken into consideration.{before: new Date(2024, 0, 1)}

status

Status[]

Provide one or more statuses. The valid status options are:

'blocked' | 'canceled' | 'disputed' | 'early_fraud_warning' | 'failed' | 'incomplete' | 'partially_refunded' | 'pending' | 'refund_pending' | 'refunded' | 'successful' | 'uncaptured'

This filter is ignored if the destination_on_behalf_of_charge_management feature is enabled.

['disputed', 'canceled']

paymentMethod

PaymentMethod

The full list of payment methods is available under the type enum for the PaymentMethod object. To see which payment methods are available to you, check your payment method settings.

This filter is ignored if the destination_on_behalf_of_charge_management feature is enabled.

'card'

Dispute management for destination charges

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.

Common mistake

Retransferring a previous reversal is subject to cross-border transfer restrictions, meaning you might have no means to repay your connected account. Instead, wait to recover disputed cross-border payment transfers for destination charges with on_behalf_of until after a dispute is lost.

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.

Customize the description

If you’re using the destination_on_behalf_of_charge_management option, the payment information (including the description) shown for destination charges with the on_behalf_of attribute corresponds to the original created payment. To display a custom description within the payment detail view for destination charges and separate charges and transfers when this feature is off, follow these steps:

Destination charges

To update the description on a payment object that’s visible to your platform’s users, you need to use the Stripe API. This applies to all platforms that use destination charges.

  1. Find the existing transfer object you created for an account by finding the latest charge created on the PaymentIntent.
  2. Use the charge object to find the transfer object associated with the charge.
  3. Use the transfer object to find the destination_payment ID that exists on the transfer.
  4. Call the Update Charge API to update the description on the destination payment using the destination_payment ID.

Note

The destination_payment object belongs to the connected account, so you’ll need to set the Stripe-Account header to the connected account’s ID to make this call.

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

This description becomes visible on the charge after you’ve written this field.

Learn more about creating destination charges on your platform.

Separate charges and transfers

To update the description on a payment object that’s visible to your platform’s users, you need to use the Stripe API. This applies to platforms that use separate charges and transfers.

  1. Use the transfer object to find the destination_payment ID that exists on the transfer.
  2. Call the Update Charge API to update the description on the destination payment using the destination_payment ID found in the previous step.

Note

The destination_payment object belongs to the connected account, so you’ll need to set the Stripe-Account header to the connected account’s ID to make this call.

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

This description becomes visible on the charge after you’ve written this field.

Learn more about creating separate charges and transfers.

Was this page helpful?
YesNo
Need help? Contact Support.
Join our early access program.
Check out our product changelog.
Questions? Contact Sales.
Powered by Markdoc