Skip to main content
POST
Create a quick check (one-time payment without bill)

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_ Test keys use ark_test_ent_. Both are issued per entity via Settings > Developers > API Keys.

Body

application/json
vendor_id
string<uuid>
required
amount
number
required
gl_account_id
string<uuid>
required
memo
string
payment_date
string<date>

Response

Created quick check

A check printed by Arcus (paper AP payment).

id
string<uuid>
object
enum<string>
Available options:
printed_check
entity_id
string<uuid>
read-only
check_number
integer
read-only

Sequential per bank account.

bank_account_id
string<uuid>
vendor_id
string<uuid>
amount
number
memo
string | null
status
enum<string>
read-only
Available options:
printed,
reprinted,
voided,
cleared
printed_at
string<date-time>
read-only
voided_at
string<date-time> | null
read-only
cleared_at
string<date-time> | null
read-only
cleared_source
enum<string> | null
read-only

The EVIDENCE CLASS behind status=cleared. register_only means the payment leg already credited a bank account and no journal entry was posted for the clear, so the row is a register truth and NOT a bank fact. Null on a check cleared before migration 20260915a, when nothing recorded the class.

Available options:
bank_match,
manual_clear,
register_only,
migrated
cleared_bank_transaction_id
string<uuid> | null
read-only

The bank line that paid this check. Written when the clear is driven by a matched bank row; null for a manual clear and for every check cleared before 2026-09-18. When it is null the pairing may still be recorded on the bank side.

cleared_bank_txn_id
string<uuid> | null
read-only

RETRIEVE ONLY (GET /v1/printed-checks/{id}); absent from the list response. The RESOLVED bank line: cleared_bank_transaction_id when this check carries the forward stamp, otherwise the bank row whose matched_printed_check_id names this check. A check that is still printed has no forward stamp by definition, so this is the only field that can answer "which line will pay it" before the clear. Pass it as bank_transaction_id on POST /v1/printed-checks/{id}/clear and the relief is dated the day the BANK paid rather than today.

drawn_on_bank_name
string | null
read-only

RETRIEVE ONLY (GET /v1/printed-checks/{id}). The LIST response, GET /v1/printed-checks, does NOT carry it and carries no live-drawee field under any name: that door answers from the stored row, so the only bank name on a list item is the issue-time snapshot bank_account_name, and a list item can therefore name a bank this check is no longer drawn on. Retrieve the check to get this field. The name of the bank this check is CURRENTLY drawn on, resolved from printed_checks.bank_account_id (falling back to the linked AP payment's bank) and falling back to the issue-time snapshot bank_account_name only when no drawee resolves. It is a different fact from bank_account_name, which is what the PAPER said at issue time and is what a re-print reproduces: after the drawee is moved with PATCH /v1/printed-checks/{id}/bank the two disagree, and this field is the one that names the bank whose statement the check belongs on and whose GL its clearing relief will credit. Null only when the check has no resolvable drawee AND carries no snapshot.

RETRIEVE ONLY. WHICH pairing answered for cleared_bank_txn_id: forward_stamp is the check's own column (written by the clear that relieved it) and reverse_link is the bank row pointing back at the check. Null when nothing pairs.

Available options:
forward_stamp,
reverse_link

RETRIEVE ONLY. True when the check names one bank line AND a DIFFERENT bank row also points at this check. Two lines claiming one check is the shape of a double relief, so it is surfaced rather than silently resolved; cleared_bank_txn_id still answers with the forward stamp.

cleared_bank_date
string<date> | null
read-only

RETRIEVE ONLY. The resolved bank line's own transaction date: the day the relief is dated when this line drives the clear.

cleared_bank_amount
number | null
read-only

RETRIEVE ONLY. The resolved bank line's signed amount, so a caller can compare it with the check before clearing.

cleared_bank_description
string | null
read-only

RETRIEVE ONLY. The resolved bank line's description as the bank sent it.