Skip to main content

Get Main Wallet Balances

GET 
/api/v1/wallet/balances

Retrieves the balance details of main wallets, including deposits, available balance, total spend, fees, and other balance types.

Request​

Responses​

Successful Response

Schema
  • Array [
    • name Name

    The name of the wallet.

    currency Currencyrequired

    The currency denomination of the wallet (e.g., USD, EUR).

    total_deposit Total Depositrequired

    The total amount of funds deposited into the wallet.

    available_balance Available Balancerequired

    The amount of funds currently available for use in the wallet.

    total_balance Total Balancerequired

    The total balance of the wallet, including reserved and pending balances.

    reserved_balance Reserved Balancerequired

    The portion of the wallet's balance reserved and not immediately available for use.

    total_spend Total Spendrequired

    The total amount spent from the wallet.

    total_fee Total Feerequired

    The cumulative fees applied to transactions from the wallet.

    pending_balance Pending Balancerequired

    The balance awaiting confirmation or processing.

    return_balance Return Balancerequired

    The balance that has been returned or refunded to the wallet.

    decline_balance Decline Balancerequired

    The total balance that has been declined for transactions.

    rolling_balance Rolling Balancerequired

    A reserve for covering potential declines. This feature is not implemented yet.

    purpose object

    An enumeration.

    status object

    An enumeration.

    owner_id object

    The unique identifier of the wallet owner.

    anyOf

    string

    wallet_id Wallet Idrequired

    The unique identifier of the wallet.

    incoming_balance Incoming Balance
  • ]
Loading...