Skip to main content
GET
List payments

๐Ÿ“Œ Endpoint

GET /stores/{storeId}/payments Returns the payments linked to the store.

๐Ÿ” Authentication

  • Private route.
  • Requires header Authorization with your API key and active plan.

๐Ÿงพ Route parameters


โœ… Example request


๐Ÿ”Ž Query params


๐Ÿ”„ Cursor pagination

For large lists (more than ~100 items), prefer cursor pagination instead of page:
  1. Make the first call without cursor.
  2. If hasMore is true, the response contains the nextCursor field.
  3. Send that nextCursor in the cursor parameter of the next request to fetch the next page.
In cursor mode, pagination is returned only with nextCursor, hasMore and limit:
  • cursor and page cannot be used together (400 INVALID_PAGINATION).
  • nextCursor: null with hasMore: false indicate the end of the list (the API responds 200 with an empty array).

Standard snippet (cURL)

Use the cURL example from the Request example section above as the official snippet.

๐Ÿ“ฆ Success response (200)

The first call (without cursor) already returns nextCursor and hasMore in the pagination, allowing cursor pagination to start without extra calls.

โš ๏ธ Possible errors

  • 400 INVALID_DATA โ†’ invalid parameters
  • 400 INVALID_PAGINATION_LIMIT โ†’ limit outside the allowed range (1 to 100)
  • 400 INVALID_PAGINATION_PAGE โ†’ invalid page
  • 400 INVALID_PAGINATION_CURSOR โ†’ invalid or malformed cursor
  • 400 INVALID_PAGINATION โ†’ page and cursor used together
  • 401 API_KEY_NOT_PROVIDED โ†’ missing Authorization header
  • 401 INVALID_API_KEY โ†’ invalid API key
  • 401 UNAUTHENTICATED โ†’ unauthenticated user
  • 403 USER_DISABLED โ†’ user disabled or deleted
  • 403 NO_ACTIVE_SUBSCRIPTION โ†’ inactive or expired plan
  • 404 STORE_NOT_FOUND โ†’ store not found
  • 429 RATE_LIMIT_EXCEEDED โ†’ plan per-minute rate limit exceeded
  • 500 INTERNAL_SERVER_ERROR โ†’ internal error
  • 503 SERVICE_UNAVAILABLE โ†’ service temporarily unavailable

Authorizations

Authorization
string
header
default:YOUR_API_KEY_HERE
required

Path Parameters

storeId
string
required
Required string length: 1 - 50

Query Parameters

page
integer
default:1
Required range: x >= 1
limit
integer
default:20
Required range: 1 <= x <= 100
cursor
string

Opaque cursor from previous page (do not combine with page).

Response

List payments.

code
string
required
Example:

"PAYMENTS_RETRIEVED"

payments
object[]
required
pagination
object
required