logoOPEN BANKING DOCS

Get account details by number

Retrieve detailed information for an account by account number

GET
/accounts/details/{accountNumber}
X-API-Key<token>

In: header

Path Parameters

accountNumberstring

10-digit account number

Match^[0-9]{10}$

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/details/string" \  -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"
}