Skip to main content
GET
List Collections

Overview

Retrieve a paginated list of your collections with optional filtering.

Query Parameters

Response

Collection Object (Summary)

Pagination Object

Example Usage

Example Response

Filtering Tips

By Date Range

Pending Payments

Search by Order ID

Paginate Large Results

Use date filtering to reduce response size and improve performance when you have many collections.

Authorizations

Authorization
string
header
required

JWT access token obtained from /auth/token

Query Parameters

page
integer
default:1
limit
integer
default:20
Required range: x <= 100
status
enum<string>
Available options:
PENDING,
COMPLETED,
EXPIRED,
FAILED,
REFUNDED,
PARTIALLY_REFUNDED
orderId
string
dateFrom
string<date>
dateTo
string<date>

Response

Collections retrieved successfully

success
boolean
Example:

true

status
integer
Example:

200

message
string
data
object
meta
object