Get a vendor's bank account

curl --request GET \
  --url https://api.public.every.io/company/v1/vendors/{vendorId}/bank-accounts/{id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.public.every.io/company/v1/vendors/{vendorId}/bank-accounts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.public.every.io/company/v1/vendors/{vendorId}/bank-accounts/{id}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "ach",
  "is_default": true,
  "created_at": "2023-12-25",
  "bank_name": "Chase",
  "routing_number": "021000021",
  "account_number_last4": "6789",
  "account_type": "checking"
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

Bank accounts

Get a vendor's bank account

Retrieves one of the vendor’s bank accounts by its id, together with the bank it is held at. Deleted accounts are never returned.

The bank fields are read live for the one account, which is why they are served here and not by GET /v1/vendors/{vendorId}/bank-accounts: an ach account’s come from the bank network record Every holds for it, a wire account’s from the wire instructions it was saved with. They are null for a check or international account, and when they could not be read; the account itself is returned either way.

GET

vendors

{vendorId}

bank-accounts

{id}

Get a vendor's bank account

curl --request GET \
  --url https://api.public.every.io/company/v1/vendors/{vendorId}/bank-accounts/{id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.public.every.io/company/v1/vendors/{vendorId}/bank-accounts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.public.every.io/company/v1/vendors/{vendorId}/bank-accounts/{id}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "ach",
  "is_default": true,
  "created_at": "2023-12-25",
  "bank_name": "Chase",
  "routing_number": "021000021",
  "account_number_last4": "6789",
  "account_type": "checking"
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

Authorizations

x-api-key

string

header

required

Path Parameters

vendorId

string<uuid>

required

A vendor of the calling company, the one the account belongs to

string<uuid>

required

The bank account, from GET /v1/vendors/{vendorId}/bank-accounts

Response

The bank account

An external bank account of a vendor: the account at the vendor's own bank that Every pays it into. Not an Every account of the calling company.

string<uuid>

required

vendor_id

string<uuid>

required

type

enum<string>

required

The rail the account is paid over. ach is the only type an account created through this API has, and the only one POST /v1/payments can pay into; the others appear on accounts added in the Every dashboard. The single-account endpoint reports bank fields for ach and wire accounts and null for the rest.

Available options:

ach,

wire,

check,

international

Example:

"ach"

is_default

boolean

required

Whether the Every dashboard pays this vendor into this account unless told otherwise. A payment created through this API always names its account.

created_at

string<date>

required

The date the account was attached to the vendor

bank_name

string | null

required

The name of the bank holding the account

Example:

"Chase"

routing_number

string | null

required

The account's ABA routing number

Example:

"021000021"

account_number_last4

string | null

required

The last four digits of the account number. The full number is never served, for an ach or a wire account alike: an account added outside this API was never disclosed to the caller.

Example:

"6789"

account_type

string | null

required

The kind of account at the bank, in lower case: checking or savings for an account created through this API.

Example:

"checking"

Overview

Company

Vendors

Bank accounts

Payments

Reference data

Get a vendor's bank account

Authorizations

Path Parameters

Response