List settlement advances
Returns the maker’s settlement advances with their lifecycle status, filterable by status and date range. Supports cursor-based pagination.
Authorizations
Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.
Query Parameters
Filter by advance credit status. Omit to return advances in any status.
Lifecycle status of the credit advanced against a settlement.
funds_reserved-- credit reserved on the line, awaiting maker action.requested-- maker submitted the request; Circle is moving funds.disbursed-- funds delivered to the funder passthrough wallet.past_due-- repayment window has elapsed without full repayment.paid-- credit fully repaid.rejected-- credit line rejected the advance request.expired-- reservation expired before being consumed.canceled-- maker or Circle canceled the advance.failed-- Circle could not deliver the advance onchain before the trade matured. No credit was extended and the reserved credit is released.
funds_reserved, requested, disbursed, past_due, paid, rejected, expired, canceled, failed Queries items created since the specified date-time (inclusive) in ISO 8601 format.
"2023-01-01T12:04:05Z"
Queries items created before the specified date-time (inclusive) in ISO 8601 format.
"2023-01-01T12:04:05Z"
Cursor -- return advances strictly before this id.
Cursor -- return advances strictly after this id.
1 <= x <= 100Response
List of settlement advances.
List of settlement advances.