API Reference

Get settlement

gethttps://api-sandbox.circle.com/v1/exchange/trades/settlements/{id}

Reference
Playground

Returns a settlement by ID.

Path parameters

uuid

Required

Universally unique identifier (UUID v4) of a resource.

Response

200GetSettlementIdResponse

Response Body

object

data

object

Show 6 properties

string

Unique system generated identifier for the entity.

entityId

string

Unique system generated identifier for the entity.

status

string

Status of the settlement.

Allowed valuespendingsettled

createDate

string

ISO-8601 UTC date/time format.

updateDate

string

ISO-8601 UTC date/time format.

details

array of objects

Show 7 properties

string

Unique system generated identifier for the entity.

type

string

Allowed valuespayablereceivable

amount

object

Show 2 properties

amount

string

Required

Magnitude of the amount, in units of the currency, with a ..

currency

string

Required

Allowed valuesUSDCEURCMXNBRL

status

string

Allowed valuespendingcompleted

reference

string

createDate

string

ISO-8601 UTC date/time format.

updateDate

string

ISO-8601 UTC date/time format.

401NotAuthorized

404NotFound

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
4    "entityId": "b8627ae8-732b-4d25-b947-1df8f4007a29",
5    "status": "pending",
6    "createDate": "2020-04-10T02:13:30.000Z",
7    "updateDate": "2020-04-10T02:13:30.000Z",
8    "details": [
9      {
10        "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
11        "type": "payable",
12        "amount": {
13          "amount": "3.14",
14          "currency": "USDC"
15        },
16        "status": "pending",
17        "reference": "FXR1234567",
18        "createDate": "2020-04-10T02:13:30.000Z",
19        "updateDate": "2020-04-10T02:13:30.000Z"
20      }
21    ]
22  }
23}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy