Stripe: Create a test-mode settlement

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

Operation stripe.posttesthelpersissuingsettlements

Provider route: POST /v1/test_helpers/issuing/settlements. 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"]["postTestHelpersIssuingSettlements"]>[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.postTestHelpersIssuingSettlements(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_issuing_settlements(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`headers`	object	Optional	Additional keys: not allowed
`headers.Idempotency-Key`	string	Optional	Minimum length: 1 Maximum length: 255
`body`	object	Required within parent	Additional keys: not allowed
`body.bin`	string	Required within parent	The Bank Identification Number reflecting this settlement record. Maximum length: 5000
`body.clearing_date`	integer	Required within parent	The date that the transactions are cleared and posted to user’s accounts.
`body.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
`body.expand`	array	Optional	Specifies which fields in the response should be expanded.
`body.expand[]`	string	Each item	Maximum length: 5000
`body.interchange_fees_amount`	integer	Optional	The total interchange received as reimbursement for the transactions.
`body.net_total_amount`	integer	Required within parent	The total net amount required to settle with the network.
`body.network`	string	Optional	The card network for this settlement. One of [“visa”, “maestro”, “mastercard”] One of: maestro, visa
`body.network_settlement_identifier`	string	Optional	The Settlement Identification Number assigned by the network. Maximum length: 5000
`body.transaction_amount`	integer	Optional	The total transaction amount reflected in this settlement.
`body.transaction_count`	integer	Optional	The total number of transactions reflected in this settlement.

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 Update a settlement — response body

Referenced models: Update a settlement — response body

Schemas

Update a settlement — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	When a non-stripe BIN is used, any use of an [issued card](https://docs.stripe.com/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object.
`bin`	string	Required within parent	The Bank Identification Number reflecting this settlement record. Maximum length: 5000
`clearing_date`	JSON	Required within parent
`clearing_date (anyOf 1)`	integer	Alternative	The date that the transactions are cleared and posted to user's accounts. Format: unix-time
`clearing_date (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`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
`id`	string	Required within parent	Unique identifier for the object. Maximum length: 5000
`interchange_fees_amount`	JSON	Required within parent
`interchange_fees_amount (anyOf 1)`	integer	Alternative	The total interchange received as reimbursement for the transactions.
`interchange_fees_amount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`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
`net_total_amount`	JSON	Required within parent
`net_total_amount (anyOf 1)`	integer	Alternative	The total net amount required to settle with the network.
`net_total_amount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`network`	string	Required within parent	The card network for this settlement report. One of ["visa", "maestro", "mastercard"] Known values: maestro, mastercard, visa
`network_fees_amount`	JSON	Required within parent
`network_fees_amount (anyOf 1)`	integer	Alternative	The total amount of fees owed to the network.
`network_fees_amount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`network_settlement_identifier`	string	Required within parent	The Settlement Identification Number assigned by the network. Maximum length: 5000
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: issuing.settlement
`settlement_service`	string	Required within parent	One of `international` or `uk_national_net`. Maximum length: 5000
`status`	string	Required within parent	The current processing status of this settlement. Known values: complete, pending
`transaction_amount`	JSON	Required within parent
`transaction_amount (anyOf 1)`	integer	Alternative	The total transaction amount reflected in this settlement.
`transaction_amount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`transaction_count`	JSON	Required within parent
`transaction_count (anyOf 1)`	integer	Alternative	The total number of transactions reflected in this settlement.
`transaction_count (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

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