The CreditReversal object
Attributes
- id string Unique identifier for the object.
- object string, value is "treasury.credit_reversal" String representing the object’s type. Objects of the same type share the same value.
- amount integer Amount (in cents) transferred.
- created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
- currency enum Three-letter ISO currency code, in lowercase. Must be a supported currency.
- financial _ account string The FinancialAccount to reverse funds from.
- hosted _ regulatory _ receipt _ url nullable string A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.
- livemode boolean If the object exists in live mode, the value is
true. If the object exists in test mode, the value isfalse. - metadata map 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 enum The rails used to reverse the funds.
- received _ credit string The ReceivedCredit being reversed.
- status enum Status of the CreditReversal Possible enum values
canceledThe CreditReversal has been canceled before it has been sent to the network and no funds have left the account. (Currently not supported).postedThe CreditReversal has been sent to the network and funds have left the account (with the Transaction posting)processingThe CreditReversal starting state. Funds are “held” by a pending Transaction (but they are still part of the current balance). - status _ transitions object Hash containing timestamps of when the object transitioned to a particular
status. - transaction nullable string Expandable The Transaction associated with this object.
The CreditReversal object
Create a CreditReversal
POST / v1 / treasury / credit_reversals
Reverses a ReceivedCredit and creates a CreditReversal object.
Parameters
- received _ credit string Required The ReceivedCredit to reverse.
- metadata map 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
Returns
Returns a CreditReversal object.
Response
Retrieve a CreditReversal
GET / v1 / treasury / credit_reversals /:id
Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list
Parameters
No parameters.
Returns
Returns a CreditReversal object.
Response