Retrieve a CreditReversal

Changed on

Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list

get/v1/treasury/credit_reversals/{credit_reversal}

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/treasury/credit_reversals/{credit_reversal}
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

credit_reversalstring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Request body application/x-www-form-urlencoded

object required

Response

Successful response.

amountinteger required

Amount (in cents) transferred.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

currencystring currency required

Three-letter ISO currency code, in lowercase. Must be a supported currency.

financial_accountstring required

The FinancialAccount to reverse funds from.

hosted_regulatory_receipt_urlstring nullable

A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject required

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

network'ach' | 'stripe' required

The rails used to reverse the funds.

object'treasury.credit_reversal' required

String representing the object's type. Objects of the same type share the same value.

received_creditstring required

The ReceivedCredit being reversed.

status'canceled' | 'posted' | 'processing' required

Status of the CreditReversal

Changes

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

  • 7b8f614372caRevision changes
    • info

      added the optional property ////////// to the response with the status

Some revisions have not been checked yet.