Stripe: Test mode: Fail an Outbound Payment

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

Operation stripe.posttesthelperstreasuryoutboundpaymentsidfail

Provider route: POST /v1/test_helpers/treasury/outbound_payments/{id}/fail. 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"]["postTestHelpersTreasuryOutboundPaymentsIdFail"]>[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.postTestHelpersTreasuryOutboundPaymentsIdFail(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_outbound_payments_id_fail(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 Outbound Payment — response body

Referenced models: Cancel an Outbound Payment — response body

Schemas

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

Cancel an Outbound Payment — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://docs.stripe.com/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://docs.stripe.com/api#outbound_transfers). Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects. Related guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)
`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 object can be canceled, and `false` otherwise.
`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
`customer`	JSON	Optional
`customer (anyOf 1)`	string	Alternative	ID of the [customer](https://docs.stripe.com/api/customers) to whom an OutboundPayment is sent. Maximum length: 5000
`customer (anyOf 2)`	null	Alternative
`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
`destination_payment_method`	JSON	Optional
`destination_payment_method (anyOf 1)`	string	Alternative	The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using `destination_payment_method_data`. Maximum length: 5000
`destination_payment_method (anyOf 2)`	null	Alternative
`destination_payment_method_details`	JSON	Optional
`destination_payment_method_details (anyOf 1)`	JSON	Alternative	Details about the PaymentMethod for an OutboundPayment.
`destination_payment_method_details (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Cancel an OutboundPayment — response body — destination_payment_method_details / value / type: financial account, us bank account
`destination_payment_method_details (anyOf 2)`	null	Alternative
`end_user_details`	JSON	Optional
`end_user_details (anyOf 1)`	JSON	Alternative	Details about the end user.
`end_user_details (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Cancel an Outbound Payment — response body — end user details Details about the end user ip address, present
`end_user_details (anyOf 2)`	null	Alternative
`expected_arrival_date`	JSON	Required within parent
`expected_arrival_date (anyOf 1)`	integer	Alternative	The date when funds are expected to arrive in the destination account. Format: unix-time
`expected_arrival_date (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`financial_account`	string	Required within parent	The FinancialAccount that funds were pulled from. 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
`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.outbound_payment
`returned_details`	JSON	Optional
`returned_details (anyOf 1)`	JSON	Alternative	Details about a returned OutboundPayment. Only set when the status is `returned`.
`returned_details (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Cancel an Outbound Payment — response body — returned details value code, transaction
`returned_details (anyOf 2)`	null	Alternative
`statement_descriptor`	string	Required within parent	The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer). Maximum length: 5000
`status`	string	Required within parent	Current status of the OutboundPayment: `processing`, `failed`, `posted`, `returned`, `canceled`. An OutboundPayment is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundPayment has been "confirmed" and funds have left the account, or to `failed` or `canceled`. If an OutboundPayment fails to arrive at its destination, its status will change to `returned`. Known values: canceled, failed, posted, processing, returned
`status_transitions`	Model	Required within parent	Expand Cancel an Outbound Payment — response body — status transitions
`tracking_details`	JSON	Optional
`tracking_details (anyOf 1)`	JSON	Alternative	Details about network-specific tracking information if available.
`tracking_details (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Cancel an OutboundPayment — response body — tracking_details / value / type: ach, us domestic wire
`tracking_details (anyOf 2)`	null	Alternative
`transaction`	JSON	Required within parent	The Transaction associated with this object.
`transaction (anyOf 1)`	string	Alternative	Maximum length: 5000
`transaction (anyOf 2)`	Model	Alternative	Expand Retrieve a Transaction — treasury get Treasury Transactions Id — response body

Referenced models: Cancel an OutboundPayment — response body — destination_payment_method_details / value / type: financial account, us bank account, Retrieve a Transaction — treasury get Treasury Transactions Id — response body, Cancel an Outbound Payment — response body — end user details Details about the end user ip address, present, Cancel an Outbound Payment — response body — status transitions, Cancel an OutboundPayment — response body — tracking_details / value / type: ach, us domestic wire, Cancel an Outbound Payment — response body — returned details value code, transaction

Cancel an OutboundPayment — response body — destination_payment_method_details / value / type: financial account, 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
`financial_account`	Model	Optional	Expand Cancel an Outbound Transfer — response body — destination payment method details financial account
`type`	string	Required within parent	The type of the payment method used in the OutboundPayment. Known values: financial_account, us_bank_account
`us_bank_account`	Model	Optional	Expand Cancel an Outbound Transfer — response body — destination payment method details us bank account

Referenced models: Cancel an Outbound Transfer — response body — destination payment method details financial account, Cancel an Outbound Transfer — response body — destination payment method details us bank account, Retrieve a Received Debit — response body — initiating payment method details billing details

Cancel an Outbound Payment — response body — end user details Details about the end user ip address, present

Field	Type	Presence	Description and constraints
`$`	object	Root
`ip_address`	JSON	Optional
`ip_address (anyOf 1)`	string	Alternative	IP address of the user initiating the OutboundPayment. Set if `present` is set to `true`. IP address collection is required for risk and compliance reasons. This will be used to help determine if the OutboundPayment is authorized or should be blocked. Maximum length: 5000
`ip_address (anyOf 2)`	null	Alternative
`present`	boolean	Required within parent	`true` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`.

Cancel an OutboundPayment — response body — tracking_details / value / type: ach, us domestic wire ach

Field	Type	Presence	Description and constraints
`$`	object	Root
`trace_id`	string	Required within parent	ACH trace ID of the OutboundPayment for payments sent over the `ach` network. Maximum length: 5000

Policy, approvals and errors

SDK function policy ID: stripe.posttesthelperstreasuryoutboundpaymentsidfail. Catalog operation: PostTestHelpersTreasuryOutboundPaymentsIdFail. 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