Check Floats

Request your current Monies on Account (MOA) and Credit balance information across all configured floats.

Floats represent the available funds in your account and can be scoped to:

  • Universal Float: Partner-level float available for all brands
  • Brand-specific Float: Float restricted to a specific brand
  • Brand Company Float: Float for a specific brand company relationship

Each float returns:

  • available_balance: The current funds available for transactions
  • pending_payments: The total amount of payments that have been requested but not yet processed

Currency Filter:
When the optional currency parameter is provided, only floats for that specific currency will be returned. Without the parameter, all floats across all currencies are returned.

Caching:
Float data is cached for 15 minutes on the server side. The last_refreshed_at timestamp indicates when the data was last calculated. It is expected that this endpoint will be called periodically to monitor account balances.

International Payments:
Floats that are mapped and enabled for international payment sales will be excluded from the response.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
length between 3 and 3
^[A-Z]{3}$

Optional filter to return floats for a specific currency only. Provide the three-character ISO 4217 currency code (eg. GBP, EUR, USD). Must be uppercase.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json