Skip to main content
GET
/
payments
List payments
curl --request GET \
  --url https://api.arcuserp.com/v1/payments \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "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"
    }
  ],
  "count": 123
}

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.

Query Parameters

​
order_id
string<uuid>
​
status
enum<string>
Available options:
pending,
succeeded,
failed,
refunded,
cancelled,
voided,
processing
​
payment_method
string
​
created_after
string<date-time>
​
created_before
string<date-time>
​
starting_after
string<uuid>
​
limit
integer
default:50
Required range: 1 <= x <= 200
​
expand[]
enum<string>[]
Available options:
data.order,
data.refunds,
data.disputes,
data.payment_method,
data.account

Response

List of payments

​
object
enum<string>
Available options:
list
​
data
object[]
​
count
integer