Stripe: Test mode: Succeed an Inbound Transfer

Stripe testHelpers.postTestHelpersTreasuryInboundTransfersIdSucceed: arguments, response, policy and SDK examples.

Operation stripe.posttesthelperstreasuryinboundtransfersidsucceed

Provider route: POST /v1/test_helpers/treasury/inbound_transfers/{id}/succeed. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";

async function execute(input: Parameters<StripeIntegration["testHelpers"]["postTestHelpersTreasuryInboundTransfersIdSucceed"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.testHelpers.postTestHelpersTreasuryInboundTransfersIdSucceed(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.test_helpers.post_test_helpers_treasury_inbound_transfers_id_succeed(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.id`	string	Required within parent	Maximum length: 5000
`headers`	object	Optional	Additional keys: not allowed
`headers.Idempotency-Key`	string	Optional	Minimum length: 1 Maximum length: 255
`body`	object	Optional	Additional keys: not allowed
`body.expand`	array	Optional	Specifies which fields in the response should be expanded.
`body.expand[]`	string	Each item	Maximum length: 5000

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Cancel an Inbound Transfer — response body

Referenced models: Cancel an Inbound Transfer — response body

Schemas

746 more schemas are linked from the tables above, on the schema pages.

Cancel an Inbound Transfer — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://docs.stripe.com/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit. Related guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers)
`amount`	JSON	Required within parent
`amount (anyOf 1)`	integer	Alternative	Amount (in cents) transferred.
`amount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`cancelable`	boolean	Required within parent	Returns `true` if the InboundTransfer is able to be canceled.
`created`	JSON	Required within parent
`created (anyOf 1)`	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
`created (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`currency`	string	Required within parent	Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000
`description (anyOf 2)`	null	Alternative
`failure_details`	JSON	Optional
`failure_details (anyOf 1)`	JSON	Alternative	Details about this InboundTransfer's failure. Will be set when `status=failed` or `returned=true`.
`failure_details (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Cancel an Inbound Transfer — response body — failure details value code
`failure_details (anyOf 2)`	null	Alternative
`financial_account`	string	Required within parent	The FinancialAccount that received the funds. Maximum length: 5000
`hosted_regulatory_receipt_url`	JSON	Optional
`hosted_regulatory_receipt_url (anyOf 1)`	string	Alternative	A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. Maximum length: 5000
`hosted_regulatory_receipt_url (anyOf 2)`	null	Alternative
`id`	string	Required within parent	Unique identifier for the object. Maximum length: 5000
`linked_flows`	Model	Required within parent	Expand Cancel an Inbound Transfer — response body — linked flows
`livemode`	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`metadata`	object	Required within parent	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field
`metadata.*`	string	Additional keys	Maximum length: 500
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: treasury.inbound_transfer
`origin_payment_method`	JSON	Optional
`origin_payment_method (anyOf 1)`	string	Alternative	The origin payment method to be debited for an InboundTransfer. Maximum length: 5000
`origin_payment_method (anyOf 2)`	null	Alternative
`origin_payment_method_details`	JSON	Optional
`origin_payment_method_details (anyOf 1)`	JSON	Alternative	Details about the PaymentMethod for an InboundTransfer.
`origin_payment_method_details (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Cancel an InboundTransfer — response body — origin_payment_method_details / value / type: us bank account
`origin_payment_method_details (anyOf 2)`	null	Alternative
`returned`	JSON	Optional
`returned (anyOf 1)`	boolean	Alternative	Returns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state.
`returned (anyOf 2)`	null	Alternative
`statement_descriptor`	string	Required within parent	Statement descriptor shown when funds are debited from the source. Not all payment networks support `statement_descriptor`. Maximum length: 5000
`status`	string	Required within parent	Status of the InboundTransfer: `processing`, `succeeded`, `failed`, and `canceled`. An InboundTransfer is `processing` if it is created and pending. The status changes to `succeeded` once the funds have been "confirmed" and a `transaction` is created and posted. The status changes to `failed` if the transfer fails. Known values: canceled, failed, processing, succeeded
`status_transitions`	Model	Required within parent	Expand Cancel an Inbound Transfer — response body — status transitions
`transaction`	JSON	Optional
`transaction (anyOf 1)`	JSON	Alternative	The Transaction associated with this object.
`transaction (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`transaction (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Retrieve a Transaction — treasury get Treasury Transactions Id — response body
`transaction (anyOf 2)`	null	Alternative

Referenced models: Cancel an InboundTransfer — response body — origin_payment_method_details / value / type: us bank account, Retrieve a Transaction — treasury get Treasury Transactions Id — response body, Cancel an Inbound Transfer — response body — failure details value code, Cancel an Inbound Transfer — response body — linked flows, Cancel an Inbound Transfer — response body — status transitions

Cancel an InboundTransfer — response body — origin_payment_method_details / value / type: us bank account

Field	Type	Presence	Description and constraints
`$`	object	Root
`billing_details`	Model	Required within parent	Expand Retrieve a Received Debit — response body — initiating payment method details billing details
`type`	string	Required within parent	The type of the payment method used in the InboundTransfer. Known values: us_bank_account
`us_bank_account`	Model	Optional	Expand Cancel an InboundTransfer — response body — origin_payment_method_details / value / type: us bank account us bank account

Referenced models: Cancel an InboundTransfer — response body — origin_payment_method_details / value / type: us bank account us bank account, Retrieve a Received Debit — response body — initiating payment method details billing details

Cancel an Inbound Transfer — response body — failure details value code

Field	Type	Presence	Description and constraints
`$`	object	Root
`code`	string	Required within parent	Reason for the failure. Known values: account_closed, account_frozen, bank_account_restricted, bank_ownership_changed, debit_not_authorized, incorrect_account_holder_address, incorrect_account_holder_name, incorrect_account_holder_tax_id, insufficient_funds, invalid_account_number, invalid_currency, no_account, other

Cancel an Inbound Transfer — response body — linked flows

Field	Type	Presence	Description and constraints
`$`	object	Root
`received_debit`	JSON	Optional
`received_debit (anyOf 1)`	string	Alternative	If funds for this flow were returned after the flow went to the `succeeded` state, this field contains a reference to the ReceivedDebit return. Maximum length: 5000
`received_debit (anyOf 2)`	null	Alternative

Cancel an Inbound Transfer — response body — status transitions

Field	Type	Presence	Description and constraints
`$`	object	Root
`canceled_at`	JSON	Optional
`canceled_at (anyOf 1)`	JSON	Alternative
`canceled_at (anyOf 1) (anyOf 1)`	integer	Alternative	Timestamp describing when an InboundTransfer changed status to `canceled`. Format: unix-time
`canceled_at (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`canceled_at (anyOf 2)`	null	Alternative
`failed_at`	JSON	Optional
`failed_at (anyOf 1)`	JSON	Alternative
`failed_at (anyOf 1) (anyOf 1)`	integer	Alternative	Timestamp describing when an InboundTransfer changed status to `failed`. Format: unix-time
`failed_at (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`failed_at (anyOf 2)`	null	Alternative
`succeeded_at`	JSON	Optional
`succeeded_at (anyOf 1)`	JSON	Alternative
`succeeded_at (anyOf 1) (anyOf 1)`	integer	Alternative	Timestamp describing when an InboundTransfer changed status to `succeeded`. Format: unix-time
`succeeded_at (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`succeeded_at (anyOf 2)`	null	Alternative

Create a Payment Method — response body — zip

Field	Type	Presence	Description and constraints
`$`	object	Root

Policy, approvals and errors

SDK function policy ID: stripe.posttesthelperstreasuryinboundtransfersidsucceed. Catalog operation: PostTestHelpersTreasuryInboundTransfersIdSucceed. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source

Report an issue with this page