Stripe: Retrieve a Credit Reversal

Stripe treasury.getTreasuryCreditReversalsCreditReversal: arguments, response, policy and SDK examples.

Operation stripe.gettreasurycreditreversalscreditreversal

Provider route: GET /v1/treasury/credit_reversals/{credit_reversal}. 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["treasury"]["getTreasuryCreditReversalsCreditReversal"]>[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.treasury.getTreasuryCreditReversalsCreditReversal(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.treasury.get_treasury_credit_reversals_credit_reversal(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.credit_reversal`	string	Required within parent	Maximum length: 5000
`query`	object	Optional	Additional keys: not allowed
`query.expand`	array	Optional
`query.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 Create a Credit Reversal — response body

Referenced models: Create a Credit Reversal — response body

Schemas

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

Create a Credit Reversal — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	You can reverse some [ReceivedCredits](https://docs.stripe.com/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
`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
`financial_account`	string	Required within parent	The FinancialAccount to reverse funds 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
`network`	string	Required within parent	The rails used to reverse the funds. Known values: ach, stripe
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: treasury.credit_reversal
`received_credit`	string	Required within parent	The ReceivedCredit being reversed. Maximum length: 5000
`status`	string	Required within parent	Status of the CreditReversal Known values: canceled, posted, processing
`status_transitions`	Model	Required within parent	Expand Create a Credit Reversal — 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: Retrieve a Transaction — treasury get Treasury Transactions Id — response body, Create a Credit Reversal — response body — status transitions

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

Create a Credit Reversal — response body — status transitions

Field	Type	Presence	Description and constraints
`$`	object	Root
`posted_at`	JSON	Optional
`posted_at (anyOf 1)`	JSON	Alternative
`posted_at (anyOf 1) (anyOf 1)`	integer	Alternative	Timestamp describing when the CreditReversal changed status to `posted` Format: unix-time
`posted_at (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`posted_at (anyOf 2)`	null	Alternative

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

Field	Type	Presence	Description and constraints
`$`	object	Root
`posted_at`	JSON	Optional
`posted_at (anyOf 1)`	JSON	Alternative
`posted_at (anyOf 1) (anyOf 1)`	integer	Alternative	Timestamp describing when the Transaction changed status to `posted`. Format: unix-time
`posted_at (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`posted_at (anyOf 2)`	null	Alternative
`void_at`	JSON	Optional
`void_at (anyOf 1)`	JSON	Alternative
`void_at (anyOf 1) (anyOf 1)`	integer	Alternative	Timestamp describing when the Transaction changed status to `void`. Format: unix-time
`void_at (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`void_at (anyOf 2)`	null	Alternative

Create a cardholder — response body — company value tax id provided

Field	Type	Presence	Description and constraints
`$`	object	Root
`tax_id_provided`	boolean	Required within parent	Whether the company's business ID number was provided.

Policy, approvals and errors

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