Sample - Stripe API
POST/v1/treasury/credit_reversals

Create a CreditReversal

Reverses a ReceivedCredit and creates a CreditReversal object.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 body fields
expandarray<string>optional
Specifies which fields in the response should be expanded.
metadataobjectoptional
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
received_creditstringrequired
The ReceivedCredit to reverse.

2 status codes
200Successful response.
amountintegerrequired
Amount (in cents) transferred.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
currencystringrequired
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).
financial_accountstringrequired
The FinancialAccount to reverse funds from.
hosted_regulatory_receipt_urlstringoptional
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.
idstringrequired
Unique identifier for the object.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataobjectrequired
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.
networkstringrequired
The rails used to reverse the funds.
Allowed:achstripe
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:treasury.credit_reversal
received_creditstringrequired
The ReceivedCredit being reversed.
statusstringrequired
Status of the CreditReversal
Allowed:canceledpostedprocessing
status_transitionsobjectrequired
transactionstringoptional
The Transaction associated with this object.
defaultError response.
errorobjectrequired

Error handling

Any other status is an error: Error response.