Essentials
IDs and versions
IDs
Every ID starts with a prefix that names its object, followed by 26 characters. Store them as opaque strings.
| Prefix | Object |
|---|---|
usr_ | User |
wal_ | Wallet |
trf_ | Transfer |
da_ | Deposit account |
dep_ | Deposit |
pa_ | Payout account |
qt_ | Quote |
we_ | Webhook endpoint |
evt_ | Event |
Object versions
Every object that can change has an integer version that goes up by one with each change. Webhook events carry the version of the snapshot they hold in object_version. Events can arrive out of order, so keep the highest version you've applied for each object and ignore anything older.
API versions
The API version is the path segment /v1. New fields, new enum values and new error codes can be added to v1 at any time, so your code should ignore fields it doesn't know and treat unknown values gracefully. Anything that would break an existing integration ships as a new version.