Skip to main content
GET
USD wallet balance

Overview

GET /wallets/usd-balance is a convenience endpoint that resolves your company’s USD wallet and returns its current balance. The USD wallet is the one used to issue and fund cards and to receive card-termination refunds.

When to use it

  • Check available USD funds before issuing or funding a card.
  • Display the USD balance in your dashboard without listing every wallet.
For the full per-wallet detail (sub-balances, lifetime volumes), use GET /wallets/{id} or GET /wallets.

Prerequisites

  • Your company must have a USD wallet.

Request

Headers

This endpoint takes no path or query parameters — the USD wallet is resolved from your authenticated company.

Response

200 — Success

data fields:

Error responses

Code examples

cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

The company's USD wallet balance.

success
boolean
Example:

true

statusCode
integer
Example:

200

message
string
Example:

"Data retrieved successfully"

data
object