List Payments
Retrieve a paginated list of payment transactions with filtering and sorting options.
Overview
This endpoint retrieves a list of payment transactions with support for pagination, filtering, and sorting. Results are ordered by creation date in descending order by default.
Query Parameters
Filter by payment status.
- Available values:
pending
,captured
,settled
,failed
- Example:
status=settled
Cursor for fetching records before a specific position.
- Use for backward pagination
- Example:
before=pay_123xyz
Cursor for fetching records after a specific position.
- Use for forward pagination
- Example:
after=pay_456abc
Number of records to return per page (max: 100).
- Example:
limit=25
Filter payments created after this timestamp (ISO 8601).
- Example:
created_after=2024-01-01T00:00:00Z
Filter payments created before this timestamp (ISO 8601).
- Example:
created_before=2024-03-31T23:59:59Z
Response Format
Array of payment objects. Each payment object contains:
Examples
Basic List Request
Response Examples
Pagination
The API uses cursor-based pagination to handle large collections of payments:
- Initial request: Specify
limit
(default: 15) - Subsequent requests: Use the
after
cursor from the previous response - Previous page: Use the
before
cursor if available
For optimal performance:
- Use reasonable page sizes (15-50 records)
- Cache results when possible
- Implement progressive loading in your UI
Filtering Tips
Rate Limits
This endpoint has the following rate limits:
- 1000 requests per hour per API key
- Maximum of 100 records per request
- Burst limit: 100 requests per minute
Best Practices
-
Efficient Filtering
- Use filters to reduce response size
- Combine filters for precise results
- Cache frequently accessed data
-
Pagination Handling
- Store cursors temporarily for navigation
- Implement infinite scroll for large lists
- Show loading states during fetches
-
Error Handling
- Implement proper retry logic
- Handle rate limits gracefully
- Log pagination errors
Need Help?
For additional assistance:
- Check our Error Handling Guide
- Contact Support