List accounts
Lists all your accounts, newest first, with bank details and balances. Only the single-account read returns status reasons. The API rejects unknown query parameters with a 400. A bad filter value is an error, not an empty page.
Query Parameters
Filter by customer
Leave out this customer's accounts
Possible values: pending, active, frozen, closed, rejected, failed, deleted, manual_review
Possible values: main, sub_account, virtual, multi_currency
Three-letter ISO 4217 code
Blockchain network, in lower case. Gravv supports stellar, polygon, ethereum, avalanche_c_chain and solana.
Possible values: stellar, polygon, ethereum, avalanche_c_chain, solana
Exact label. Use search for part of a label.
Account type, such as operating
Case-insensitive search across label, currency, status, type and wallet address
Created at or after, as RFC 3339 or YYYY-MM-DD (inclusive)
Created before, as RFC 3339 or YYYY-MM-DD (exclusive)
Page size, 1 to 200. The API uses 50 for a value out of range.
Responses
| Status | Description |
|---|---|
200 |
A page of accounts |
400 |
Invalid request |
200 response
The account's wallet address
Account type, such as operating. Accounts not opened with POST /v2/accounts can carry other types, such as card.
pending while opening, then active. rejected means the bank declined and failed means opening failed. deleted and manual_review appear only on older accounts.
Possible values: pending, active, frozen, closed, rejected, failed, deleted, manual_review
A stable code that explains a status other than active. Branch on it. You act on tos_pending and kyc_pending by sending the customer to required_action_url, and on awaiting_customer_document and awaiting_customer_data by updating the application. Other codes need no action, or mean the account cannot be opened. The API returns it only when you read a single account.
Explanation in words. The wording can change, so branch on status_reason.
Document types to upload with the application update
Field names to send with the application update
Page the end customer must open, for terms or verification
True when the application is waiting on you
Possible values: negative_balance
Possible values: main, sub_account, virtual, multi_currency
Possible values: fbo_account, subledger
Name of the bank that holds the account
Balance in major units. Gravv takes it from the wallet first, then the bank's last known figure, then the ledger. balance_source says which. The API omits it when there is no figure, which means unknown, not zero.
Possible values: institution, wallet, ledger
The bank's figures, in major units
The Gravv ledger position, in minor units (see scale)
Settled and spendable
Settled plus in flight. Show this to the customer.
Possible values: synced, stale, cooling_down, syncing, failed, simulated, deferred
Deposit bank name. Some banks leave it out. In that case, use bank_name.
Extra bank details, such as bic and swift_code
Whether a settlement wallet is attached. Always present.
The application to update when the account waits on you
Hash of the bank's reference, for support correlation only
The page size used
400 response
Error message. When several fields fail, it names the first and says how many others are in details. Branch on the HTTP status and the details codes, not on this text.
Field problems, keyed by field path. Each value is CODE: message, such as REQUIRED: Customer ID is required. The API joins several problems on one field with ; .
{
"data": null,
"error": "invalid request payload: unknown field \"sort\""
}
Authorization
- ApiKeyAuth