API Conventions
This guide describes how Acclaim structures data across the API and how to interpret responses, work with identifiers, currencies, and timestamps.
Object IDs
Every resource in Acclaim has a unique object ID. These IDs are string values that include a short prefix identifying the object type.
Examples:
po_dlZwQyd0Sn— payoutpyee_KfIuLz83Ya— payeewlt_b0TrsSg91h— walletbapo_r8PxTnQ5Dv— batch payout
Treat these IDs as opaque strings — their internal structure may change over time, but prefixes remain consistent for readability.
When storing Acclaim object IDs in your own database, use a VARCHAR(255) column for full compatibility.
Dates and Datetimes
All timestamps in Acclaim follow the ISO 8601 format in UTC.
Examples:
2025-10-08T18:20:31Z— full datetime with UTC timezone.2025-10-08— date-only value where applicable.
Currency & Amounts
All monetary amounts are represented in the smallest currency unit for that currency:
| Currency | Smallest Unit | Example Value | Meaning |
|---|---|---|---|
| USD | Cents | 100 | $1.00 |
| GBP | Pence | 100 | £1.00 |
| JPY | Yen | 100 | ¥100 |
Acclaim supports any ISO 4217 currency.
When performing calculations, use integers rather than floating point numbers to avoid rounding errors.
Idempotency
You should design your integration to prevent duplicate submissions by reusing identifiers for business objects, such payees and payouts. In the event that you retry the same payout, for example, then the duplicate submission would be rejected.
Updated 25 days ago