Public preview
Deprecates legacy payout type for balance transfers in the ReceivedCredit API Public preview
What’s new
The balance_transfer hash on the ReceivedCredit object now uses payout as the type value for payout-initiated balance transfers. This change adds the payout enum value to balance_transfer.type and a corresponding payout property to the balance_transfer hash. The legacy payout_v1 property and enum value are deprecated.
Impact
If you previously read balance_transfer.type as payout_v1, update your code to use payout instead. Integrations on earlier API versions aren’t affected.
Changes
| Parameters | Change | Resources or endpoints |
|---|---|---|
| payout | Added | V2. MoneyManagement. ReceivedCredit. balance_transfer |
| payout_v1 | Removed | V2. MoneyManagement. ReceivedCredit. balance_transfer |
| Value | Change | Enum |
| payout | Added | V2. MoneyManagement. ReceivedCredit. balance_transfer. type |
Upgrade
- View your current API version in Workbench.
- If you use an SDK, upgrade to the corresponding SDK version for this API version.
- If you don’t use an SDK, update your API requests to include Stripe-Version: 2026-07-29. preview
- Upgrade the API version used for webhook endpoints .
- Test your integration against the new version.
- If you use Connect, test your Connect integration .
- In Workbench, perform the upgrade . You can roll back the version for 72 hours.
Learn more about Stripe API upgrades.