logoOPEN BANKING DOCS

Get accounts by wallet ID

Retrieve all accounts associated with a wallet

GET
/accounts/wallet/{walletId}
X-API-Key<token>

In: header

Path Parameters

walletIdstring

Wallet UUID

Formatuuid

Query Parameters

accountType?string

Filter by account type

Value in"VIRTUAL_ACCOUNT" | "TRANSIENT_ACCOUNT"
state?string

Filter by account state

Value in"ACTIVE" | "INACTIVE" | "SUSPENDED"

Header Parameters

X-API-Keystring

API key for the application

X-App-Idstring

UUID of the application

Formatuuid

Response Body

curl -X GET "https://virtual-accounts-api.vantacrest.com/company/v1/accounts/wallet/497f6eca-6276-4993-bfeb-53cbbbba6f08?accountType=VIRTUAL_ACCOUNT&state=ACTIVE" \  -H "X-API-Key: string" \  -H "X-App-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "data": [
    {
      "accountName": "string",
      "accountNumber": "string",
      "state": "ACTIVE",
      "accountType": "VIRTUAL_ACCOUNT",
      "metadata": {
        "overfillAmount": 0,
        "overfilled": true,
        "settled": true,
        "collectionsAccountId": "fb32ea18-8c9e-4af9-80c5-0fc8d779c454"
      }
    }
  ]
}
{
  "success": true,
  "message": "string",
  "data": {},
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": true,
  "message": "string",
  "data": {},
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": true,
  "message": "string",
  "data": {},
  "timestamp": "2019-08-24T14:15:22Z"
}