Account queries

Less than 1 minute to read

Provider APIProvider -> Banking Service

The /accountqueries POST endpoint allows a provider to request the BankAccountId and status based on their own external ID.

POST/v1/accountqueries

Request

The following headers should be provided with your request.

Headers	Description
`x-api-key`	This value required in validating calls to the Provider API. It should be handled as a secret and not shared. Individual keys of the API may be throttled depending on usage agreements.
`Authorization`	This is the value returned from your call to the /oauth/token endpoint.
`Content-Type`	This should be set as application/json.

Example request body:

{
  "data": {
    "bankId": "30a36e6b-4ce6-409a-8471-fa29e9999b3a",
    "externalId": "string"
  }
}

Banking Service will respond with a 200 along with the following example body.

{
  "data": {
    "bankAccountId": "5b26b598-a880-4e32-8c41-126aa0206857",
    "status": "active",
    "requestedStartDate": "string"
  }
}