Retrieve Settlement Details and Current Status by ID

Retrieve the current state of a specific settlement expectation by its UUID. Use this endpoint to check whether a transfer has been matched, or to inspect the settlement details.

Endpoint

GET /api/v1/settlements/{id}

Authorization

Requires an API key with the TRANSACTIONS_READ scope.

Path Parameters

string

required

The UUID of the settlement to retrieve.

Request Example

curl "https://api.your-domain.com/api/v1/settlements/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $IDEM_API_KEY"

Response

string

Settlement UUID.

string

UUID of the receiving account.

string

The stablecoin token being watched for.

string

Expected transfer amount.

string

Wallet address being monitored.

string

Chain being monitored.

string

Expected sender wallet address, if one was provided at registration. null otherwise.

string

Current status: PENDING, SETTLED, UNMATCHED, or CANCELLED.

string

UUID of the ledger transaction this settlement was matched to. null until matched.

string

On-chain transaction hash of the matched transfer. null until matched.

integer

Block number of the matched transfer. null until matched.

string

ISO-8601 timestamp of when the settlement was matched. null until matched.

string

ISO-8601 timestamp after which an unmatched PENDING settlement is considered expired. Only present while the settlement is PENDING.

string

ISO-8601 creation timestamp.

Response Example

{
  "settlementId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "accountId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "expectedToken": "USDC",
  "expectedAmount": "250.00",
  "expectedWalletAddress": "0xYourCustodialWallet...",
  "expectedChainId": "EVM",
  "expectedFromAddress": null,
  "status": "SETTLED",
  "matchedTransactionId": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "txHash": "0xabc123def456...",
  "blockNumber": 19500000,
  "confirmedAt": "2024-01-15T10:42:00Z",
  "expiresAt": null,
  "createdAt": "2024-01-15T09:00:00Z"
}

Error Codes

Code	Meaning
401	Missing or invalid API key
403	API key does not have `TRANSACTIONS_READ` scope
404	Settlement not found for this tenant

Accounts

Transactions

Settlements

Reconciliation

Compliance

Administration

Retrieve Settlement Details and Current Status by ID

Endpoint

Authorization

Path Parameters

Request Example

Response

Response Example

Error Codes

​Endpoint

​Authorization

​Path Parameters

​Request Example

​Response

​Response Example

​Error Codes

Endpoint

Authorization

Path Parameters

Request Example

Response

Response Example

Error Codes