Skip to content

Stripe: Retrieve a Debit Reversal

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

← Treasury operations · Get started

Operation stripe.gettreasurydebitreversalsdebitreversal

Provider route: GET /v1/treasury/debit_reversals/{debit_reversal}. Alter supplies the connection’s credentials and routing.

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"]["getTreasuryDebitReversalsDebitReversal"]>[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.getTreasuryDebitReversalsDebitReversal(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_debit_reversals_debit_reversal(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.debit_reversalstringRequired within parentMaximum length: 5000
queryobjectOptionalAdditional keys: not allowed
query.expandarrayOptional
query.expand[]stringEach itemMaximum length: 5000

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Create a Debit Reversal — response body

Referenced models: Create a Debit Reversal — response body

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

Create a Debit Reversal — response body
FieldTypePresenceDescription and constraints
$objectRootYou can reverse some [ReceivedDebits](https://docs.stripe.com/api#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeAmount (in cents) transferred.
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentThree-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_accountJSONOptional
financial_account (anyOf 1)stringAlternativeThe FinancialAccount to reverse funds from.
Maximum length: 5000
financial_account (anyOf 2)nullAlternative
hosted_regulatory_receipt_urlJSONOptional
hosted_regulatory_receipt_url (anyOf 1)stringAlternativeA [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)nullAlternative
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
linked_flowsJSONOptional
linked_flows (anyOf 1)JSONAlternativeOther flows linked to a DebitReversal.
linked_flows (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a Debit Reversal — response body — linked flows Other flows linked to a Debit Reversal issuing dispute
linked_flows (anyOf 2)nullAlternative
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataobjectRequired within parentSet 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.*stringAdditional keysMaximum length: 500
networkstringRequired within parentThe rails used to reverse the funds.
Known values: ach, card
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: treasury.debit_reversal
received_debitstringRequired within parentThe ReceivedDebit being reversed.
Maximum length: 5000
statusstringRequired within parentStatus of the DebitReversal
Known values: failed, processing, succeeded
status_transitionsModelRequired within parentExpand Create a Debit Reversal — response body — status transitions
transactionJSONOptional
transaction (anyOf 1)JSONAlternativeThe Transaction associated with this object.
transaction (anyOf 1) (anyOf 1)stringAlternativeMaximum length: 5000
transaction (anyOf 1) (anyOf 2)ModelAlternativeExpand Retrieve a Transaction — treasury get Treasury Transactions Id — response body
transaction (anyOf 2)nullAlternative

Referenced models: Retrieve a Transaction — treasury get Treasury Transactions Id — response body, Create a Debit Reversal — response body — linked flows Other flows linked to a Debit Reversal issuing dispute, Create a Debit Reversal — response body — status transitions

Retrieve a Transaction — treasury get Treasury Transactions Id — response body
FieldTypePresenceDescription and constraints
$objectRootTransactions represent changes to a [FinancialAccount's](https://docs.stripe.com/api#financial_accounts) balance.
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeAmount (in cents) transferred.
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
balance_impactModelRequired within parentExpand Retrieve a Transaction Entry — response body — balance impact
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentThree-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
descriptionstringRequired within parentAn arbitrary string attached to the object. Often useful for displaying to users.
Maximum length: 5000
entriesJSONOptional
entries (anyOf 1)objectAlternativeA list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints.
entries (anyOf 1).dataarrayRequired within parentDetails about each object.
entries (anyOf 1).data[]ModelEach itemExpand Retrieve a Transaction Entry — response body
entries (anyOf 1).has_morebooleanRequired within parentTrue if this list has another page of items after this one that can be fetched.
entries (anyOf 1).objectstringRequired within parentString 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).urlstringRequired within parentThe URL where this list can be accessed.
Maximum length: 5000
Pattern: ^/v1/treasury/transaction_entries
entries (anyOf 2)nullAlternative
financial_accountstringRequired within parentThe FinancialAccount associated with this object.
Maximum length: 5000
flowJSONOptional
flow (anyOf 1)stringAlternativeID of the flow that created the Transaction.
Maximum length: 5000
flow (anyOf 2)nullAlternative
flow_detailsJSONOptional
flow_details (anyOf 1)JSONAlternativeDetails of the flow that created the Transaction.
flow_details (anyOf 1) (anyOf 1)ModelAlternativeExpand 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)nullAlternative
flow_typestringRequired within parentType 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
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: treasury.transaction
statusstringRequired within parentStatus of the Transaction.
Known values: open, posted, void
status_transitionsModelRequired within parentExpand 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 Debit Reversal — response body — linked flows Other flows linked to a Debit Reversal issuing dispute
FieldTypePresenceDescription and constraints
$objectRoot
issuing_disputeJSONOptional
issuing_dispute (anyOf 1)stringAlternativeSet if there is an Issuing dispute associated with the DebitReversal.
Maximum length: 5000
issuing_dispute (anyOf 2)nullAlternative
Create a Debit Reversal — response body — status transitions
FieldTypePresenceDescription and constraints
$objectRoot
completed_atJSONOptional
completed_at (anyOf 1)JSONAlternative
completed_at (anyOf 1) (anyOf 1)integerAlternativeTimestamp describing when the DebitReversal changed status to `completed`.
Format: unix-time
completed_at (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
completed_at (anyOf 2)nullAlternative
Create a Payment Method — response body — zip
FieldTypePresenceDescription and constraints
$objectRoot

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

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.