Add a bank account to a vendor

curl --request POST \
  --url https://api.public.every.io/company/v1/vendors/{vendorId}/bank-accounts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "idempotency_key": "<string>",
  "type": "ach",
  "bank_name": "<string>",
  "routing_number": "<string>",
  "account_number": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    idempotency_key: '<string>',
    type: 'ach',
    bank_name: '<string>',
    routing_number: '<string>',
    account_number: '<string>'
  })
};

fetch('https://api.public.every.io/company/v1/vendors/{vendorId}/bank-accounts', 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"

payload = {
    "idempotency_key": "<string>",
    "type": "ach",
    "bank_name": "<string>",
    "routing_number": "<string>",
    "account_number": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, 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"
}

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

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

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

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "ach",
  "is_default": true,
  "created_at": "2023-12-25"
}

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

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

Bank accounts

Add a bank account to a vendor

Attaches a US bank account to one of the calling company’s vendors, so that POST /v1/payments can pay into it.

Only ACH accounts are supported, which is why type accepts ach alone — it is the rail payments created through this API go out on. An account added here is never made the vendor’s default: every payment names the account it pays into.

There is no update endpoint. Correcting an account means creating the new one and deleting the old one.

idempotency_key is required. Repeating a request with a key already used answers 409 with the account the first request created, instead of attaching a second one to the vendor. Keys are scoped to the vendor in the path: the same key under another vendor is a new request and creates an account there.

POST

vendors

{vendorId}

bank-accounts

Add a bank account to a vendor

curl --request POST \
  --url https://api.public.every.io/company/v1/vendors/{vendorId}/bank-accounts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "idempotency_key": "<string>",
  "type": "ach",
  "bank_name": "<string>",
  "routing_number": "<string>",
  "account_number": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    idempotency_key: '<string>',
    type: 'ach',
    bank_name: '<string>',
    routing_number: '<string>',
    account_number: '<string>'
  })
};

fetch('https://api.public.every.io/company/v1/vendors/{vendorId}/bank-accounts', 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"

payload = {
    "idempotency_key": "<string>",
    "type": "ach",
    "bank_name": "<string>",
    "routing_number": "<string>",
    "account_number": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, 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"
}

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

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

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

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "ach",
  "is_default": true,
  "created_at": "2023-12-25"
}

{
  "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 is attached to

Body

application/json

idempotency_key

string

required

Caller-chosen key that makes a retry of this request safe.

Minimum string length: 1

type

enum<string>

required

The rail the account is paid over. ach is the only value this version accepts: ACH is the only rail payments created through this API go out on.

Available options:

ach

bank_name

string

required

The name of the bank holding the account.

Minimum string length: 1

routing_number

string

required

The account's ABA routing number. Nine digits, and refused when its check digit does not match — which is what catches most mistyped numbers before the bank is asked.

Pattern: ^[0-9]{9}$

account_number

string

required

The account number at that bank, up to 17 digits.

Pattern: ^[0-9]{1,17}$

account_type

enum<string>

required

Available options:

checking,

savings

Response

The account, attached to the vendor

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

Overview

Company

Vendors

Bank accounts

Payments

Reference data

Add a bank account to a vendor

Authorizations

Path Parameters

Body

Response