Get a settlement
GET /uda/settlements/{id}
Fetch a single settlement by id. A settlement is created per confirmed deposit on a UDA address and carries the lifecycle state, scenario, and routing transaction ids.
Path parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string | Settlement id. |
Responses
The settlement.
- idstring
- uda_idstring
- statusstringenum: created · routing · completed · failed · retrying
- created_atstringformat: date-time
- updated_atstringformat: date-time
- errorstring
Failure reason when `status` is `failed`; empty otherwise.
- addressstring
- amountstring
- asset_symbolstring
- asset_addressstring
- network_idinteger
- network_namestring
- tx_hashstring
- confirmed_atstringformat: date-time
- addressstring
- amountstring
- asset_symbolstring
- asset_addressstring
- network_idinteger
- network_namestring
- tx_hashstring
- settled_atstringformat: date-time
- totalstring
- platformstring
- providerstring
- fee_amountstring
Equal to `total` (back-compat field).
- providerstring
- typestring
- time_msinteger