Balance and wallets¶

Your USDC balance and the wallets that hold it.

Endpoint
`GET /balance`	Your USDC balance
`GET /wallets`	Your wallets
`GET /wallets/:walletId`	One of your wallets
`GET /wallets/:walletId/balances`	What the wallet provider reports a wallet holds
`GET /issuers/accounts`	Issuer accounts held for you
`GET /issuers`	The stablecoin issuers this environment supports
`POST /wallets/:walletId/transfers`	Move funds between your wallets
`POST /issuers/:issuerId/mint`	Mint a stablecoin at par
`POST /banking/wire-transfers`	Send an outbound wire

GET /balance¶

Your USDC balance.

Auth: API key · Rate limit: read

available is what you can spend now; settling is USDC that arrived on another network and is on its way to your home wallet; total is both. complete: false means a read failed and the figures are a floor.

Read the guide

Responses

Status	Meaning	`error` codes
`200`	OK
`401`	Missing or invalid credentials	`unauthorized`
`429`	Rate limited	`rate_limited`
`501`	Not available on this environment	`not_implemented`

200 body

Field	Type	Always present
`currency`	string	yes
`scale`	`6`	yes
`available`	string	yes
`settling`	string	yes
`total`	string	yes
`complete`	boolean	yes
`reportedAt`	string	yes

GET /wallets¶

Your wallets.

Auth: API key · Rate limit: read

The wallets registered to your organization. No balances: those are a separate read.

Read the guide

Responses

Status	Meaning	`error` codes
`200`	OK
`401`	Missing or invalid credentials	`unauthorized`
`429`	Rate limited	`rate_limited`

200 body

Field	Type	Always present
`accounts`	object[]	yes
`accounts[].id`	string	yes
`accounts[].kind`	AccountKindName	yes
`accounts[].provider`	string	yes
`accounts[].externalId`	string	yes
`accounts[].label`	string or null	yes
`accounts[].currencies`	string[]	yes
`accounts[].address`	string or null	yes
`accounts[].chain`	string or null	yes
`accounts[].status`	`"active"`, `"disabled"`	yes
`accounts[].createdAt`	string	yes
`count`	number	yes

GET /wallets/:walletId¶

One of your wallets.

Auth: API key · Rate limit: read

By our id or the wallet's externalId. A wallet that is not yours is 404.

Read the guide

Path parameters

Name	Type
`walletId`	string

Responses

Status	Meaning	`error` codes
`200`	OK
`401`	Missing or invalid credentials	`unauthorized`
`404`	Not found, or not yours	`not_found`
`429`	Rate limited	`rate_limited`

200 body

Field	Type	Always present
`id`	string	yes
`kind`	AccountKindName	yes
`provider`	string	yes
`externalId`	string	yes
`label`	string or null	yes
`currencies`	string[]	yes
`address`	string or null	yes
`chain`	string or null	yes
`status`	`"active"`, `"disabled"`	yes
`createdAt`	string	yes

GET /wallets/:walletId/balances¶

What the wallet provider reports a wallet holds.

Auth: API key · Rate limit: read

A provider report, stamped with when it was read. 501 when no wallet provider is configured, which is not the same answer as an empty wallet.

Read the guide

Path parameters

Name	Type
`walletId`	string

Responses

Status	Meaning	`error` codes
`200`	OK
`401`	Missing or invalid credentials	`unauthorized`
`404`	Not found, or not yours	`not_found`
`429`	Rate limited	`rate_limited`
`501`	Not available on this environment	`not_implemented`

200 body

Field	Type	Always present	Notes
`walletId`	string	yes
`balances`	ReportedBalance[]	yes

GET /issuers/accounts¶

Issuer accounts held for you.

Auth: API key · Rate limit: read

Read the guide

Responses

Status	Meaning	`error` codes
`200`	OK
`401`	Missing or invalid credentials	`unauthorized`
`429`	Rate limited	`rate_limited`

200 body

Field	Type	Always present
`accounts`	object[]	yes
`accounts[].id`	string	yes
`accounts[].kind`	AccountKindName	yes
`accounts[].provider`	string	yes
`accounts[].externalId`	string	yes
`accounts[].label`	string or null	yes
`accounts[].currencies`	string[]	yes
`accounts[].address`	string or null	yes
`accounts[].chain`	string or null	yes
`accounts[].status`	`"active"`, `"disabled"`	yes
`accounts[].createdAt`	string	yes
`count`	number	yes

GET /issuers¶

The stablecoin issuers this environment supports.

Auth: API key · Rate limit: read

Read the guide

Responses

Status	Meaning	`error` codes
`200`	OK
`401`	Missing or invalid credentials	`unauthorized`
`429`	Rate limited	`rate_limited`
`501`	Not available on this environment	`not_implemented`

200 body

Field	Type	Always present	Notes
`issuers`	IssuerCatalogEntry[]	yes
`count`	number	yes

POST /wallets/:walletId/transfers¶

Move funds between your wallets.

Auth: API key · Rate limit: write

Not available: Not offered yet. Answers 501 with a reason on every environment.

Path parameters

Name	Type
`walletId`	string

Responses

Status	Meaning	`error` codes
`401`	Missing or invalid credentials	`unauthorized`
`429`	Rate limited	`rate_limited`
`501`	Not available on this environment	`not_implemented`

POST /issuers/:issuerId/mint¶

Mint a stablecoin at par.

Auth: API key · Rate limit: write

Not available: Not offered yet. Answers 501 with a reason on every environment.

Path parameters

Name	Type
`issuerId`	string

Responses

Status	Meaning	`error` codes
`401`	Missing or invalid credentials	`unauthorized`
`429`	Rate limited	`rate_limited`
`501`	Not available on this environment	`not_implemented`

POST /banking/wire-transfers¶

Send an outbound wire.

Auth: API key · Rate limit: write

Not available: Not offered. To pay fiat out of your balance, use an off-ramp (POST /treasury/offramp).

Responses

Status	Meaning	`error` codes
`401`	Missing or invalid credentials	`unauthorized`
`429`	Rate limited	`rate_limited`
`501`	Not available on this environment	`not_implemented`