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
List all CreditReversals
GET / v1 / treasury / credit_reversals
Returns a list of CreditReversals.
Parameters
- financial _ account string Returns objects associated with this FinancialAccount.
- received _ credit string Only return CreditReversals for the ReceivedCredit ID.
- status enum Only return CreditReversals for a given status. 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).
More parameters
- ending _ before string
- limit integer
- starting _ after string
Returns
A dictionary with a data property that contains an array of up to limit CreditReversals, starting after CreditReversal starting_after. Each entry in the array is a separate CreditReversal object. If no more CreditReversal are available, the resulting array will be empty.
Response