List settlements by reference
GET /uda/settlements/by-reference
Look up settlements by a reference you already know. The reference is currently the on-chain deposit transaction id that funded the settlement — useful when you know what you paid with but not the internal settlement id. A single deposit transaction can fund multiple settlements, so the response is always a list (empty when nothing matches).
Query parameters
| Name | Type | Description |
|---|---|---|
| referencerequired | string | Lookup reference (on-chain deposit transaction id). |
Responses
Matching settlements.
- referencestring
The reference that was looked up.
- countinteger
- 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.