Stripe: Test mode: Create a Received Credit

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

Operation stripe.posttesthelperstreasuryreceivedcredits

Provider route: POST /v1/test_helpers/treasury/received_credits. 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"]["postTestHelpersTreasuryReceivedCredits"]>[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.postTestHelpersTreasuryReceivedCredits(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_received_credits(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.amount`	integer	Required within parent	Amount (in cents) to be transferred.
`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.description`	string	Optional	An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000
`body.expand`	array	Optional	Specifies which fields in the response should be expanded.
`body.expand[]`	string	Each item	Maximum length: 5000
`body.financial_account`	string	Required within parent	The FinancialAccount to send funds to.
`body.initiating_payment_method_details`	object	Optional	Initiating payment method details for the object.
`body.initiating_payment_method_details.type`	string	Required within parent	One of: us_bank_account
`body.initiating_payment_method_details.us_bank_account`	object	Optional
`body.initiating_payment_method_details.us_bank_account.account_holder_name`	string	Optional	Maximum length: 5000
`body.initiating_payment_method_details.us_bank_account.account_number`	string	Optional	Maximum length: 5000
`body.initiating_payment_method_details.us_bank_account.routing_number`	string	Optional	Maximum length: 5000
`body.network`	string	Required within parent	Specifies the network rails to be used. If not set, will default to the PaymentMethod’s preferred network. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. One of: ach, rtp, us_domestic_wire

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 Retrieve a Received Credit — response body

Referenced models: Retrieve a Received Credit — response body

Schemas

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

Retrieve a Received Credit — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	ReceivedCredits represent funds sent to a [FinancialAccount](https://docs.stripe.com/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.
`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]+)?$
`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`	string	Required within parent	An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000
`failure_code`	JSON	Optional
`failure_code (anyOf 1)`	string	Alternative	Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen. Known values: account_closed, account_frozen, international_transaction, other
`failure_code (anyOf 2)`	null	Alternative
`financial_account`	JSON	Optional
`financial_account (anyOf 1)`	string	Alternative	The FinancialAccount that received the funds. Maximum length: 5000
`financial_account (anyOf 2)`	null	Alternative
`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
`initiating_payment_method_details`	Model	Required within parent	Expand Retrieve a Received Debit — response body — initiating payment method details
`linked_flows`	Model	Required within parent	Expand Retrieve a Received Credit — 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`.
`network`	string	Required within parent	The rails used to send the funds. Known values: ach, card, rtp, stripe, us_domestic_wire
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: treasury.received_credit
`reversal_details`	JSON	Optional
`reversal_details (anyOf 1)`	JSON	Alternative	Details describing when a ReceivedCredit may be reversed.
`reversal_details (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Retrieve a Received Credit — response body — reversal details value deadline, restricted reason
`reversal_details (anyOf 2)`	null	Alternative
`status`	string	Required within parent	Status of the ReceivedCredit. ReceivedCredits are created either `succeeded` (approved) or `failed` (declined). If a ReceivedCredit is declined, the failure reason can be found in the `failure_code` field. Known values: failed, succeeded
`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: Retrieve a Transaction — treasury get Treasury Transactions Id — response body, Retrieve a Received Credit — response body — linked flows, Retrieve a Received Credit — response body — reversal details value deadline, restricted reason, Retrieve a Received Debit — response body — initiating payment method details

Retrieve a Transaction — treasury get Treasury Transactions Id — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Transactions represent changes to a [FinancialAccount's](https://docs.stripe.com/api#financial_accounts) balance.
`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]+)?$
`balance_impact`	Model	Required within parent	Expand Retrieve a Transaction Entry — response body — balance impact
`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`	string	Required within parent	An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000
`entries`	JSON	Optional
`entries (anyOf 1)`	object	Alternative	A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints.
`entries (anyOf 1).data`	array	Required within parent	Details about each object.
`entries (anyOf 1).data[]`	Model	Each item	Expand Retrieve a Transaction Entry — response body
`entries (anyOf 1).has_more`	boolean	Required within parent	True if this list has another page of items after this one that can be fetched.
`entries (anyOf 1).object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Always has the value `list`. Known values: list
`entries (anyOf 1).url`	string	Required within parent	The URL where this list can be accessed. Maximum length: 5000 Pattern: ^/v1/treasury/transaction_entries
`entries (anyOf 2)`	null	Alternative
`financial_account`	string	Required within parent	The FinancialAccount associated with this object. Maximum length: 5000
`flow`	JSON	Optional
`flow (anyOf 1)`	string	Alternative	ID of the flow that created the Transaction. Maximum length: 5000
`flow (anyOf 2)`	null	Alternative
`flow_details`	JSON	Optional
`flow_details (anyOf 1)`	JSON	Alternative	Details of the flow that created the Transaction.
`flow_details (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Retrieve a Transaction Entry — response body — flow details value credit reversal, debit reversal, inbound transfer, issuing authorization, outbound payment, outbound transfer, received credit, received debit, type
`flow_details (anyOf 2)`	null	Alternative
`flow_type`	string	Required within parent	Type of the flow that created the Transaction. Known values: credit_reversal, debit_reversal, inbound_transfer, issuing_authorization, other, outbound_payment, outbound_transfer, received_credit, received_debit
`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`.
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: treasury.transaction
`status`	string	Required within parent	Status of the Transaction. Known values: open, posted, void
`status_transitions`	Model	Required within parent	Expand Retrieve a Transaction — treasury get Treasury Transactions Id — response body — status transitions

Referenced models: Retrieve a Transaction Entry — response body, Retrieve a Transaction — treasury get Treasury Transactions Id — response body — status transitions, Retrieve a Transaction Entry — response body — balance impact, Retrieve a Transaction Entry — response body — flow details value credit reversal, debit reversal, inbound transfer, issuing authorization, outbound payment, outbound transfer, received credit, received debit, type

Retrieve a Received Credit — response body — reversal details value deadline, restricted reason

Field	Type	Presence	Description and constraints
`$`	object	Root
`deadline`	JSON	Optional
`deadline (anyOf 1)`	JSON	Alternative
`deadline (anyOf 1) (anyOf 1)`	integer	Alternative	Time before which a ReceivedCredit can be reversed. Format: unix-time
`deadline (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`deadline (anyOf 2)`	null	Alternative
`restricted_reason`	JSON	Optional
`restricted_reason (anyOf 1)`	string	Alternative	Set if a ReceivedCredit cannot be reversed. Known values: already_reversed, deadline_passed, network_restricted, other, source_flow_restricted
`restricted_reason (anyOf 2)`	null	Alternative

Policy, approvals and errors

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