The DebitReversal object
Attributes
- id string Unique identifier for the object.
- object string, value is "treasury.debit_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 nullable 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.
- linked _ flows nullable object Other flows linked to a DebitReversal.
- 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 _ debit string The ReceivedDebit being reversed.
- status enum Status of the DebitReversal Possible enum values
failedThe network has resolved the DebitReversal against the user.processingThe DebitReversal starting state.succeededThe network has resolved the DebitReversal in the users favour. A crediting Transaction is created. - 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 DebitReversal object
Create a DebitReversal
POST / v1 / treasury / debit_reversals
Reverses a ReceivedDebit and creates a DebitReversal object.
Parameters
- received _ debit string Required The ReceivedDebit 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 DebitReversal object.
Response
Retrieve a DebitReversal
GET / v1 / treasury / debit_reversals /:id
Retrieves a DebitReversal object.
Parameters
No parameters.
Returns
Returns a DebitReversal object.
Response