Endpoint Details
GET
/api/v0/payment-links
Authentication
All requests require API key authentication using the following headers:x-client-key
: Your application’s client keyx-client-secret
: Your application’s client secret
Query Parameters
Number of records to skip (must be non-negative)
Default:
Example:
Default:
0
Example:
10
Number of records to take (must be positive)
Default:
Maximum:
Example:
Default:
10
Maximum:
100
Example:
20
Pagination
The API uses offset-based pagination:- skip: Number of records to skip from the beginning
- take: Maximum number of records to return
- Results are returned in reverse chronological order (newest first)
- For page-based navigation:
skip = (page - 1) * take
Request Examples
Response Format
Success Response (200 OK)
Response Fields
Each payment link in the array contains:Unique payment link identifier
Display title of the payment link
Full checkout URL for the payment link
Description of the payment link
Cover image URL
Type of payment link (PRODUCT, DONATION, SUBSCRIPTION)
Current status (ACTIVE, INACTIVE, EXPIRED)
Fixed amount (null for flexible amounts)
Payment currency (usdc, eurc)
Whether quantity adjustment is allowed
Whether mobile payments are allowed
Whether tax collection is enabled
Whether address collection is enabled
Whether payment count is limited
Maximum number of payments allowed
Custom fields for data collection
Array of associated products
Application identifier
Expiration date (ISO 8601)
Creation timestamp (ISO 8601)
Last update timestamp (ISO 8601)
Error Responses
Use Cases
1. Dashboard Management
Display all payment links in administrative interfaces with pagination and filtering capabilities.2. Performance Analytics
Retrieve payment links to analyze conversion rates, revenue patterns, and usage statistics.3. Bulk Operations
Get all payment links for bulk updates, archival, or migration operations.4. Status Monitoring
Monitor payment link health by checking statuses and expiration dates.5. Customer Support
Quickly find and troubleshoot specific payment links for customer inquiries.Best Practices
Pagination Strategy
- Use reasonable page sizes (10-50 items) to balance performance and usability
- Implement cursor-based pagination for real-time applications
- Cache results when appropriate to reduce API calls
Performance Optimization
- Request only the page size you need
- Use filtering on the client side for simple operations
- Implement proper error handling for network issues
Data Management
- Sort results by creation date (newest first) for better user experience
- Track pagination state in your application
- Handle empty result sets gracefully
Security Considerations
- Never expose API credentials in client-side code
- Implement proper access controls for payment link data
- Use HTTPS for all API requests
Filtering Examples
Support
For additional support with the List Payment Links API:- Ensure proper pagination parameters (skip ≥ 0, take > 0)
- Check API key permissions for payment link access
- Monitor response times for large datasets
- Implement proper error handling for network issues
For more information, see: