Skip to main content

Balances

GET 
/balances

Retrieve all balances for the Business User's account.

Request​

Query Parameters

    PageSize integer
    Default value: 20
    Example: 10
    PageToken string

Header Parameters

    Api-Signature string

    Digitally signed JWT.

Responses​

List of balances
Schema
    Itemsobject[]required

  • Array [

    • AccountType AccountType (string)required

    Type of account:

    • Current
    Example: Current
    CryptoCurrency CryptoCurrencyCode (string)required

    Cryptocurrency (main/sandbox):

    • BTC/BTC_TEST
    • USDC/USDC_TEST
    Example: BTC
    Available PositiveDecimal (string)required

    Amount available to spend.

    Possible values: non-empty and <= 38 characters, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$

    Example: 10.1
    Total PositiveDecimal (string)required

    Amount including outflows that have not yet settled.

    Possible values: non-empty and <= 38 characters, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$

    Example: 10.1

  • ]

    • PageToken string
Loading...