GET
/v1/treasury/received_creditsList received credits
Lists received credits associated with a financial account. Use financial_account to scope the results, status and linked_flows to filter them, and cursor parameters to paginate the list.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
ending_beforestringoptional
An object ID cursor that returns results preceding the specified item.
expandarray<string>optional
Fields to expand in each returned object.
financial_accountstringrequired
The FinancialAccount that received the funds.
limitintegeroptional
Maximum number of objects to return, from 1 to 100. Defaults to 10 when omitted.
linked_flowsobjectoptional
Filters received credits by their linked flow; `source_flow_type` is required inside this object.
starting_afterstringoptional
An object ID cursor that returns results following the specified item.
statusstringoptional
Filters results by status: `failed` or `succeeded`.
200Returns a list object containing received credits in `data`, a `has_more` pagination flag, the list object type, and the list URL.
dataarray<ReceivedCredit>required
Details about each object.
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
urlstringrequired
The URL where this list can be accessed.
defaultError response.
errorobjectrequired
Error handling
financial_account must identify the FinancialAccount whose received credits you want to retrieve. status must be failed or succeeded, and linked_flows.source_flow_type must be one of credit_reversal, other, outbound_payment, outbound_transfer, or payout. limit ranges from 1 to 100 and defaults to 10 when omitted.