Create payment

curl --request POST \
  --url https://api.public.every.io/company/v1/payments \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 1.01,
  "idempotency_key": "<string>",
  "memo": "<string>",
  "to_bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "every_category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "every_department_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    vendor_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    amount: 1.01,
    idempotency_key: '<string>',
    memo: '<string>',
    to_bank_account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    every_category_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    every_department_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.public.every.io/company/v1/payments', 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/payments"

payload = {
    "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amount": 1.01,
    "idempotency_key": "<string>",
    "memo": "<string>",
    "to_bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "every_category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "every_department_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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",
  "status": "pending",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": "<string>",
  "memo": "<string>",
  "every_category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "every_department_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "from_every_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "to_bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "approver_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

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

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

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

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": "<string>",
  "memo": "<string>",
  "every_category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "every_department_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "from_every_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "to_bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "approver_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

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

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

Payments

Create payment

Creates a payment (only ACH for now) from the calling company’s Every account to one of its own vendors.

The payment is created awaiting approval by the company’s signatory and is not sent to the bank until that approval happens, exactly as a payment created in the Every dashboard. Poll GET /v1/payments/{id} to follow it.

idempotency_key is required. Repeating a request with a key already used answers 409 with the payment the first request created, so a retry can never send the money twice. Its status is the payment’s current one, so a repeat reports where the payment got to just as GET /v1/payments/{id} does.

POST

payments

Create payment

curl --request POST \
  --url https://api.public.every.io/company/v1/payments \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 1.01,
  "idempotency_key": "<string>",
  "memo": "<string>",
  "to_bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "every_category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "every_department_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    vendor_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    amount: 1.01,
    idempotency_key: '<string>',
    memo: '<string>',
    to_bank_account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    every_category_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    every_department_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.public.every.io/company/v1/payments', 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/payments"

payload = {
    "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amount": 1.01,
    "idempotency_key": "<string>",
    "memo": "<string>",
    "to_bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "every_category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "every_department_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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",
  "status": "pending",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": "<string>",
  "memo": "<string>",
  "every_category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "every_department_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "from_every_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "to_bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "approver_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

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

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

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

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": "<string>",
  "memo": "<string>",
  "every_category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "every_department_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "from_every_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "to_bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "approver_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

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

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

Authorizations

x-api-key

string

header

required

Body

application/json

vendor_id

string<uuid>

required

A vendor of the calling company, whose account named in to_bank_account_id receives the payment.

amount

number

required

Amount in US dollars, at least 0.01 and to at most two decimal places. A more precise amount is refused rather than rounded, so that the payment sent matches the amount asked for.

Required range: x >= 0.01

idempotency_key

string

required

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

Minimum string length: 1

memo

string

required

Description carried on the payment and shown under Transactions in the Every dashboard. It is also the description the bank puts on the ACH transfer, which is why it cannot be blank.

Required string length: 1 - 50

to_bank_account_id

string<uuid>

required

The vendor's bank account to pay into, from GET /v1/vendors/{vendorId}/bank-accounts. It must belong to the vendor named in vendor_id.

every_category_id

string<uuid>

required

What the payment is for, from GET /v1/every-categories.

every_department_id

string<uuid>

required

Which department the payment is for, from GET /v1/every-departments.

Response

The payment, awaiting approval

string<uuid>

required

status

enum<string>

required

pending — created, waiting on its approval. processing — approved and on its way to the bank. completed — the money has moved. failed — it will not move; see failure_reason. returned — the money moved and the receiving bank sent it back; see failure_reason.

Available options:

pending,

processing,

completed,

failed,

returned

vendor_id

string<uuid>

required

amount

string

required

memo

string

required

every_category_id

string<uuid>

required

every_department_id

string<uuid>

required

from_every_account_id

string<uuid>

The calling company's Every account the payment is drawn from — its default one.

to_bank_account_id

string<uuid>

The vendor's bank account the payment is paid into.

approval

object

The approval the payment is waiting on before it is sent.

Show child attributes

Overview

Company

Vendors

Bank accounts

Payments

Reference data

Create payment

Authorizations

Body

Response