Skip to main content
GET
Get a wallet

Authorizations

Authorization
string
header
required

Your secret key: sk_test_… on the sandbox host, sk_live_… on live. A key on the wrong host gets a 401 wrong_environment. Keys are secret. Keep them on your server, never in a browser or app.

Path Parameters

id
string
required
Example:

"wallet_7t4m9k2qx8d3hn5r"

Response

The wallet.

id
string
required

Pass it as wallet_id to quote or create payouts.

Example:

"wallet_7t4m9k2qx8d3hn5r"

currency
string
required

The wallet's currency, lowercase ISO 4217.

Example:

"usd"

total
string
required

All funds in the wallet, including reserved funds.

Example:

"5752.00"

reserved
string
required

Set aside for payouts on hold or in flight.

Example:

"14.00"

available
string
required

total minus reserved. What new payouts can use.

Example:

"5738.00"