Skip to main content
GET
Get settlement advance detail

Authorizations

Authorization
string
header
required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.

Path Parameters

advanceId
string<uuid>
required

The settlement advance identifier. System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

Response

Settlement advance detail.

Full detail of a single settlement advance.

advanceId
string<uuid>
required

Settlement advance identifier.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

tradeId
string
required

Trade identifier.

Example:

"trade-abc-123"

advance
object
required

Currency and amount for settlement advance flows.

collateral
object
required

Currency and amount for settlement advance flows.

status
enum<string>
required

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.
Available options:
funds_reserved,
requested,
disbursed,
past_due,
paid,
rejected,
expired,
canceled
Example:

"disbursed"

createDate
string<date-time>
required

Date and time when the resource was created

Example:

"2023-01-01T12:04:05Z"

fees
object

Fee projection for this advance.

updateDate
string<date-time>

Date and time when the resource was last updated

Example:

"2023-01-01T12:04:05Z"

paidDate
string<date-time> | null

When the settlement advance was paid. Null until paid.

dueDate
string<date-time> | null

When the advance is due to be repaid in full. Null until paid.

repayments
object[]

Repayments applied against this advance.