Banking

Retrieve Account Balance

Retrieve the balance of your Ivy account. The balance is the money currently available on your Ivy account. It is broken down by currency.

post/api/service/balance/retrieve

Request body

currency'USD' | 'EUR' | 'GBP' | 'USDC'

The currency to retrieve the balance for. Default account balance for that currency will be retrieved

accountIdstring uuid

The account id to retrieve the balance for. You can find it in the Merchant Dashboard -> Accounts -> Details. If currency is provided it will be ignored.

Response

The account balance

Changes

Changed in 3 of the 52 revisions of this API.327

  • 2d2a3975882233See the full diff
    • ▲

      removed the enum value DKK of the request property

      request-property-enum-value-removed

    • ▲

      removed the enum value PLN of the request property

      request-property-enum-value-removed

    • ▲

      removed the enum value SEK of the request property

      request-property-enum-value-removed

    • ○

      removed the DKK enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PLN enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the SEK enum value from the // response property for the response status

      response-property-enum-value-removed

  • 257fc3f4d45313See the full diff
    • ●

      added the new USD enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      the request property became optional

      request-property-became-optional

    • ○

      added the new USD enum value to the request property

      request-property-enum-value-added

  • 8db8d1e5025b11See the full diff
    • ●

      added the new USDC enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the new USDC enum value to the request property

      request-property-enum-value-added