Skip to main content
POST
/
orders
/
{id}
/
payments
Create a payment (charge) on an order
curl --request POST \
  --url https://api.arcuserp.com/v1/orders/{id}/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payment_method": "card",
  "payment_method_id": "<string>",
  "amount": 123,
  "reference": "<string>",
  "notes": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "payment",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "method": "cash",
  "amount": 123,
  "amount_applied": 123,
  "amount_refunded": 123,
  "currency": "USD",
  "reference": "<string>",
  "stripe_payment_intent_id": "<string>",
  "payment_method_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "received_at": "2023-11-07T05:31:56Z",
  "notes": "<string>",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

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

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

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
​
created_at
string<date-time>
read-only
​
updated_at
string<date-time>
read-only