Skip to main content
GET
List payments

Authorizations

X-Suby-Api-Key
string
header
required

Secret API key. sk_live_… (production) or sk_sandbox_… (sandbox).

Query Parameters

limit
integer
default:20

Page size (1–100).

Required range: 1 <= x <= 100
cursor
string

Opaque pagination cursor from a previous pagination.nextCursor.

status
enum<string>
Available options:
PENDING,
AUTHORIZED,
PENDING_3DS,
PENDING_REDIRECT,
BRIDGING,
RECEIVED,
PARTIAL,
COMPLETED,
FAILED,
DECLINED,
REFUNDED,
PARTIALLY_REFUNDED,
CANCELED,
EXPIRED
customerId
string

One cus_xxx id, or a comma-separated list to match several customers.

Example:

"cus_abc123"

externalRef
string

Exact-match filter on the merchant business reference set at create.

Maximum string length: 120
productId
string
Example:

"pro_abc123"

bundleId
string
Example:

"pl_abc123"

discountCode
string
Maximum string length: 64
since
integer

Inclusive createdAt lower bound, in ms epoch.

Required range: x >= 0
Example:

1743638400000

until
integer

Inclusive createdAt upper bound, in ms epoch.

Required range: x >= 0
Example:

1751414400000

Response

Payments retrieved

success
boolean
required
Example:

true

data
object
required

Endpoint-specific payload.

message
string