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_id": "<string>",
  "amount": 123,
  "reference": "<string>",
  "notes": "<string>",
  "skip_revision_ack": true
}
'

import requests

url = "https://api.arcuserp.com/v1/orders/{id}/payments"

payload = {
    "payment_method_id": "<string>",
    "amount": 123,
    "reference": "<string>",
    "notes": "<string>",
    "skip_revision_ack": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    payment_method_id: '<string>',
    amount: 123,
    reference: '<string>',
    notes: '<string>',
    skip_revision_ack: true
  })
};

fetch('https://api.arcuserp.com/v1/orders/{id}/payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.arcuserp.com/v1/orders/{id}/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'payment_method_id' => '<string>',
    'amount' => 123,
    'reference' => '<string>',
    'notes' => '<string>',
    'skip_revision_ack' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.arcuserp.com/v1/orders/{id}/payments"

	payload := strings.NewReader("{\n  \"payment_method_id\": \"<string>\",\n  \"amount\": 123,\n  \"reference\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"skip_revision_ack\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/orders/{id}/payments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payment_method_id\": \"<string>\",\n  \"amount\": 123,\n  \"reference\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"skip_revision_ack\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/orders/{id}/payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payment_method_id\": \"<string>\",\n  \"amount\": 123,\n  \"reference\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"skip_revision_ack\": true\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

Orders

Create a payment (charge) on an order

Apply a payment to an invoice/order. Routes by payment_method: card/ach -> Stripe PaymentIntent; cash/check/credit/terms -> manual record. Overpayment automatically creates a credit memo. Requires both orders:write AND payments:write scopes. R4: raw card credentials (card_number, cvc) are rejected. Idempotent via Idempotency-Key header.

Revision acknowledgment gate (HTTP 409 revision_unacknowledged). If the order was revised after the customer received their copy and the customer has not yet acknowledged the new total, this endpoint returns HTTP 409 with code: revision_unacknowledged. Lift the gate via POST /v1/orders/{id}/customer-acknowledge-revision, or bypass with ?override=true / {"skip_revision_ack": true} (requires orders.revision_override permission). Disable entity-wide via entities.settings.require_customer_ack_on_revision = false.

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_id": "<string>",
  "amount": 123,
  "reference": "<string>",
  "notes": "<string>",
  "skip_revision_ack": true
}
'

import requests

url = "https://api.arcuserp.com/v1/orders/{id}/payments"

payload = {
    "payment_method_id": "<string>",
    "amount": 123,
    "reference": "<string>",
    "notes": "<string>",
    "skip_revision_ack": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    payment_method_id: '<string>',
    amount: 123,
    reference: '<string>',
    notes: '<string>',
    skip_revision_ack: true
  })
};

fetch('https://api.arcuserp.com/v1/orders/{id}/payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.arcuserp.com/v1/orders/{id}/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'payment_method_id' => '<string>',
    'amount' => 123,
    'reference' => '<string>',
    'notes' => '<string>',
    'skip_revision_ack' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.arcuserp.com/v1/orders/{id}/payments"

	payload := strings.NewReader("{\n  \"payment_method_id\": \"<string>\",\n  \"amount\": 123,\n  \"reference\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"skip_revision_ack\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/orders/{id}/payments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payment_method_id\": \"<string>\",\n  \"amount\": 123,\n  \"reference\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"skip_revision_ack\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/orders/{id}/payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payment_method_id\": \"<string>\",\n  \"amount\": 123,\n  \"reference\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"skip_revision_ack\": true\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

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

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.

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

Overview

All Endpoints

Create a payment (charge) on an order

Authorizations

Headers

Path Parameters

Body

Response