Skip to content
Navigation

Get balance

Requires an active API credential with the wallet:read permission.

GET
https://cardzone.ai/api/b2b/v1/balance

Authorization

  • BearerAuth
    HTTP
    required

Returns

200

Current store wallet balance

JSON
  • balance
    string
    required
  • currency
    string
    required

401

Missing, revoked, or unknown API key. A live key also gets this while its store is inactive, or until the store's business verification is approved and its primary user's email is verified.
JSON
  • error
    object
    required
    • code
      string
      required
    • message
      string
      required
    • details
      optional
      unknown

      Optional field-level validation details

    • product_status
      optional
      out_of_stock
      or
      unavailable

      Present on 404 product errors when the product exists but cannot be ordered: out_of_stock or unavailable, with the same meaning as the catalog status. Absent when the product id is unknown or deleted.

403

The API credential is valid but does not include the required permission.
JSON
  • error
    object
    required
    • code
      string
      required
    • message
      string
      required
    • details
      optional
      unknown

      Optional field-level validation details

    • product_status
      optional
      out_of_stock
      or
      unavailable

      Present on 404 product errors when the product exists but cannot be ordered: out_of_stock or unavailable, with the same meaning as the catalog status. Absent when the product id is unknown or deleted.

Type to search…

↑↓ navigate↵ selectEsc close