Skip to main content
GET
List payments

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