Skip to main content
GET
Retrieve an AP payment

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.

Path Parameters

id
string<uuid>
required

Query Parameters

expand[]
enum<string>[]
Available options:
vendor,
check,
journal_entry,
bills,
bank_account

Response

AP payment

A payment Arcus made to a vendor (AP-side).

id
string<uuid>
object
enum<string>
Available options:
ap_payment
entity_id
string<uuid>
read-only
vendor_id
string<uuid>
bill_id
string<uuid> | null

Set when payment is applied to a single bill; null for batch/on-account.

batch_id
string<uuid> | null
method
enum<string>
Available options:
check,
ach,
wire,
credit_card,
cash,
other
amount
number
currency
string
default:USD
reference
string | null

Check number, ACH trace, etc.

status
enum<string>
read-only
Available options:
pending,
sent,
cleared,
voided,
returned
payment_date
string<date>
cleared_date
string<date> | null
notes
string | null
metadata
object | null
created_at
string<date-time>
read-only