Data Formats

The Flowbrite API formats its data in a consistent way to ensure that it is easy to work with and understand.

Object IDs

All object IDs in the Flowbrite API are represented as ULID strings with an entity prefix and environment identifier.

For example, a ULID for a Client in the Sandbox environment might look like this:

Example Client ID

cli_X01JTK7H3R1HY5EKJEQ5W3MGRF6

cli_ is the entity prefix for Client
The X after the underscore indicates the Sandbox environment
The rest is a ULID.

You will receive a 400 Bad Request response if you attempt to use an ID from one environment in another.

Environment	Code
Sandbox	`X`
Production	`P`

Entity	Prefix
ApiKey	`ak_`
Beneficiary	`ben_`
Beneficiary Snapshot	`bss_`
Client	`cli_`
Client User	`cu_`
Collection Account	`ca_`
Conversion	`con_`
Inbound Funds	`if_`
Jwt	`jwt_`
Linked Funding Account	`lfa_`
Payment	`pmt_`
Transaction	`txn_`
Transfer	`tfr_`
User	`usr_`
Wallet	`wa_`

Dates

Assume all dates and times are in ISO 8601 format and in UTC unless otherwise specified.

Format Type	Format Example	Description
Dates Only	`2024-09-30`	Date, no time (YYYY-MM-DD)
Dates and Times	`2024-09-30T10:48:51`	Date and time (YYYY-MM-DDTHH:mm:ss)
Timestamps	`2025-06-16T15:30:27.1473615Z`	Date and time with fractional seconds (YYYY-MM-DDTHH:mm:ss.fffffffZ)

Amounts

Amounts are represented as decimal numbers with a fixed number of decimal places based on the currency (see below).

Currencies

Currency codes (CcyCode) use the 3-letter ISO 4217 standard. Use the Get Currencies endpoint to get additional information about the list of supported currencies.

Code	Name	Decimal Places
AED	United Arab Emirates Dirham	2
AUD	Australian Dollar	2
BGN	Bulgarian Lev	2
BHD	Bahraini Dinar	2
CAD	Canadian Dollar	2
CHF	Swiss Franc	2
CNY	Chinese Yuan	2
CZK	Czech Koruna	2
DKK	Danish Krone	2
EUR	Euro	2
GBP	British Pound	2
HKD	Hong Kong Dollar	2
HUF	Hungarian Forint	2
IDR	Indonesian Rupiah	0
ILS	Israeli New Sheqel	2
INR	Indian Rupee	2
JPY	Japanese Yen	0
KES	Kenyan Shilling	2
KWD	Kuwaiti Dinar	2
MXN	Mexican Peso	2
MYR	Malaysian Ringgit	2
NOK	Norwegian Krone	2
NZD	New Zealand Dollar	2
OMR	Omani Rial	2
PHP	Philippine Peso	2
PLN	Polish Zloty	2
QAR	Qatari Rial	2
RON	Romanian New Leu	2
SAR	Saudi Riyal	2
SEK	Swedish Krona	2
SGD	Singapore Dollar	2
THB	Thai Baht	2
TRY	Turkish Lira	2
UGX	Ugandan Shilling	0
USD	United States Dollar	2
ZAR	South African Rand	2

Countries

Country codes use the 2-letter ISO 3166-1 alpha-2 standard. Use the Get Countries endpoint to get additional information about the list of supported countries.