curl --request GET \
--url https://api-sandbox.circle.com/v1/exchange/trades/settlements/{id} \
--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"
}
]
}
}Returns a settlement by ID.
curl --request GET \
--url https://api-sandbox.circle.com/v1/exchange/trades/settlements/{id} \
--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"
}
]
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Universally unique identifier (UUID v4) of a resource.
"b3d9d2d5-4c12-4946-a09d-953e82fae2b0"
Successfully retrieved settlement.
Show child attributes
Unique system generated identifier for the entity.
"b8627ae8-732b-4d25-b947-1df8f4007a29"
Unique system generated identifier for the entity.
"b8627ae8-732b-4d25-b947-1df8f4007a29"
Status of the settlement.
pending, settled ISO-8601 UTC date/time format.
"2020-04-10T02:13:30.000Z"
ISO-8601 UTC date/time format.
"2020-04-10T02:13:30.000Z"
Show child attributes
Unique system generated identifier for the entity.
"b8627ae8-732b-4d25-b947-1df8f4007a29"
payable, receivable pending, completed "FXR1234567"
ISO-8601 UTC date/time format.
"2020-04-10T02:13:30.000Z"
ISO-8601 UTC date/time format.
"2020-04-10T02:13:30.000Z"
Was this page helpful?