Returns a list of CreditReversals.
Parameters
- financial_
accountstring Returns objects associated with this FinancialAccount.
- received_
creditstring Only return CreditReversals for the ReceivedCredit ID.
- statusenum
Only return CreditReversals for a given status.
Possible enum valuescanceled
The CreditReversal has been canceled before it has been sent to the network and no funds have left the account. (Currently not supported).
posted
The CreditReversal has been sent to the network and funds have left the account (with the Transaction posting)
processing
The CreditReversal starting state. Funds are “held” by a pending Transaction (but they are still part of the current balance).
More parameters
- ending_
beforestring A cursor for use in pagination.
ending_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withbefore obj_
, your subsequent call can includebar ending_
in order to fetch the previous page of the list.before=obj_ bar - limitinteger
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_
afterstring A cursor for use in pagination.
starting_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withafter obj_
, your subsequent call can includefoo starting_
in order to fetch the next page of the list.after=obj_ foo
Returns
A dictionary with a data
property that contains an array of up to limit
CreditReversals, starting after CreditReversal starting_
. Each entry in the array is a separate CreditReversal object. If no more CreditReversal are available, the resulting array will be empty.
{ "object": "list", "url": "/v1/treasury/credit_reversals", "has_more": false, "data": [ { "id": "credrev_1Mtklw2eZvKYlo2CJG2MWJM7", "object": "treasury.credit_reversal", "amount": 1000, "created": 1680756608, "currency": "usd", "financial_account": "fa_1Mtklw2eZvKYlo2CNHscZzs2", "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKICfuaEGMgYv0T_PcXU6NpP_n6wAfI9LKta3LkDRNQT8oLGdQf7JcXsskGjrq1LICpYVy5a3oOBI5gaVvTy8MtwpT1PTpQ", "livemode": false, "metadata": {}, "network": "ach", "received_credit": "rc_1Mtklw2eZvKYlo2CxuluQFPR", "status": "processing", "status_transitions": { "posted_at": null }, "transaction": "trxn_1Mtklw2eZvKYlo2CKkbNA2TS" } ]}