Skip to main content
GET
/
v1
/
exchange
/
trades
/
settlements
Get all settlements
curl --request GET \
  --url https://api-sandbox.circle.com/v1/exchange/trades/settlements \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
      "entityId": "b8627ae8-732b-4d25-b947-1df8f4007a29",
      "status": "pending",
      "createDate": "2020-04-10T02:13:30.000Z",
      "updateDate": "2020-04-10T02:13:30.000Z",
      "details": [
        {
          "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
          "type": "payable",
          "amount": {
            "amount": "3.14",
            "currency": "USDC"
          },
          "status": "pending",
          "reference": "FXR1234567",
          "createDate": "2020-04-10T02:13:30.000Z",
          "updateDate": "2020-04-10T02:13:30.000Z"
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
from
string<date-time>

Queries items created since the specified date-time (inclusive).

Example:

"2020-04-10T02:13:30.000Z"

​
to
string<date-time>

Queries items created before the specified date-time (inclusive).

Example:

"2020-04-10T02:13:30.000Z"

​
pageBefore
string

A collection ID value used for pagination.

It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize.

The items will be returned in the natural order of the collection.

The resource will return the first page if neither pageAfter nor pageBefore are specified.

SHOULD NOT be used in conjuction with pageAfter.

​
pageAfter
string

A collection ID value used for pagination.

It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize.

The items will be returned in the natural order of the collection.

The resource will return the first page if neither pageAfter nor pageBefore are specified.

SHOULD NOT be used in conjuction with pageBefore.

​
pageSize
integer

Limits the number of items to be returned.

Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used.

If avoided, the collection will determine the page size itself.

Required range: x >= 1
Example:

5

​
type
enum<string>

The type of settlement.

Available options:
account_payable,
account_receivable
​
status
enum<string>

Status of the settlement.

Available options:
pending,
settled
​
currency
enum<string>

Currency of the settlement

Available options:
MXN,
BRL

Response

Successfully retrieved settlements.

​
data
object[]