Skip to main content
GET
/
api
/
v1
/
settlements
/
{id}
curl https://api.settlx.io/api/v1/settlements/d4e5f6a7-b8c9-0123-def0-456789012345 \
  -H "Authorization: Bearer pk_live_your_api_key"
{
  "data": {
    "id": "d4e5f6a7-b8c9-0123-def0-456789012345",
    "invoiceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "amount": "98.49",
    "grossAmount": "99.99",
    "currency": "USDT",
    "chain": "ethereum",
    "transactionHash": "0xdeadbeef1234567890...",
    "merchantWallet": "0xYourWallet...",
    "status": "completed",
    "initiatedAt": "2024-01-15T10:05:00.000Z",
    "completedAt": "2024-01-15T10:06:30.000Z",
    "failedAt": null,
    "createdAt": "2024-01-15T10:04:30.000Z",
    "updatedAt": "2024-01-15T10:06:30.000Z"
  }
}

Get Settlement

Retrieves a single settlement by its ID, including the destination wallet, transaction hash, and current status.

Path Parameters

id
string
required
UUID of the settlement.

Response

data
object
Settlement object. Same fields as listed in List Settlements.
curl https://api.settlx.io/api/v1/settlements/d4e5f6a7-b8c9-0123-def0-456789012345 \
  -H "Authorization: Bearer pk_live_your_api_key"
{
  "data": {
    "id": "d4e5f6a7-b8c9-0123-def0-456789012345",
    "invoiceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "amount": "98.49",
    "grossAmount": "99.99",
    "currency": "USDT",
    "chain": "ethereum",
    "transactionHash": "0xdeadbeef1234567890...",
    "merchantWallet": "0xYourWallet...",
    "status": "completed",
    "initiatedAt": "2024-01-15T10:05:00.000Z",
    "completedAt": "2024-01-15T10:06:30.000Z",
    "failedAt": null,
    "createdAt": "2024-01-15T10:04:30.000Z",
    "updatedAt": "2024-01-15T10:06:30.000Z"
  }
}