FAfax
Shop

Get account balance

Get your account balance. (Permitted scopes: fax:all:read, fax:shop:read)

get/shop/balance

Request

  • Base URL
    https://restapi.fax.plus/v3
  • URL
    https://restapi.fax.plus/v3/shop/balance
  • Auth
    • OAuth 2
      Authorization code: https://accounts.fax.plus/login?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=http://localhost&scope=all
      Token URL: https://accounts.fax.plus/token scopes: all
    • or HTTP bearer

Response

Object containing balance information

amountnumber required

Current account balance

currencystring required

Currency of the balance

Example response

{
  "amount": 100,
  "currency": "USD"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.