Get balance

Retrieves the current balance of the enterprise. It will include both available and pending amounts.

[!tip] The pending amount is the sum of all committed pending payouts.

get/me/balance

Request

Base URL
https://api.enterprise.airtm.com/v2
Auth
HTTP basic
TypeScript
https://skmtc.dev/airtm/apis/airtm-enterprise-api-v2/docs/me/balance/get.ts
A function with typed inputs. Its response is checked against the schema.

availablenumber double required

Amount available in the account.

pendingnumber double required

Amount committed to pending payouts in the account.

{
  "available": 1234.56,
  "pending": 123.45
}

No recorded changes to this operation across all 1 revision of this API.