Skip to main content
POST
Create a payment (charge) on an order

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.

Headers

Idempotency-Key
string

Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours.

Maximum string length: 255

Path Parameters

id
string<uuid>
required

Body

application/json
payment_method
enum<string>
required
Available options:
card,
ach,
cash,
check,
credit,
terms,
external
payment_method_id
string

Stripe PM id for card/ach

amount
number

Partial payment in dollars; omit for full balance

reference
string

Check number, external reference, etc.

notes
string
skip_revision_ack
boolean

When true, bypasses the revision acknowledgment gate. Requires the caller to have the orders.revision_override permission; returns 403 otherwise. Equivalent to the ?override=true query parameter.

Response

Payment created

A customer-side payment applied to one or more orders. AR-facing.

id
string<uuid>
object
enum<string>
Available options:
payment
entity_id
string<uuid>
read-only
account_id
string<uuid>
order_id
string<uuid> | null

Set when payment is applied to a single order; null for unapplied/on-account payments.

method
enum<string>
Available options:
cash,
check,
ach,
wire,
credit_card,
debit_card,
store_credit,
stripe,
other
amount
number

Gross amount received (always positive).

amount_applied
number
read-only

Portion applied to orders so far.

amount_refunded
number
read-only

Total refunded against this payment.

currency
string
default:USD
reference
string | null

Check number, ACH trace, Stripe charge id, etc.

stripe_payment_intent_id
string | null
read-only
payment_method_id
string<uuid> | null
status
enum<string>
read-only
Available options:
pending,
succeeded,
failed,
refunded,
partially_refunded,
voided
received_at
string<date-time>
notes
string | null
metadata
object | null
created_at
string<date-time>
read-only
updated_at
string<date-time>
read-only