List Links
Retrieves payment links owned by the authenticated API client with optional filtering and pagination. Returns a summary of each link including status, expiration, and web URL.
Note: Only returns links created by the authenticated API client.
Filtering
Use the filter object to narrow down links by:
status: Filter by payment status (created, completed, failed, etc.)inserted_at_from/inserted_at_to: Filter by creation date range
Pagination
Uses keyset-based pagination for efficient traversal of large result sets.
Use the keyset value from the last link in the current page as the after
parameter in your next request to fetch the next page.
Body Parameters
API client identifier
API client secret for authentication. Required for internal (non-OAuth2) authentication mode (e.g., test-only). Not required when using OAuth2 (Bearer token) authentication.
Filter criteria for listing payment links. All filters are optional and combined with AND logic.
Show child attributes
Pagination parameters for list endpoints using keyset-based pagination. Keyset pagination provides stable, efficient pagination that works well with large datasets and concurrent updates.
Show child attributes
Response
Response Attributes
Name of the API client application
API client identifier
Unique identifier for the API request
List of payment links matching the filter criteria
Show child attributes
Pagination metadata included in list responses
Show child attributes
Response Attributes
Unique identifier for this error instance
Request identifier for tracking and correlation
Machine-readable error code for 400 errors:
bad_request: Generic validation or request errorvalidation_error: Request payload validation failedinvalid_input: Invalid input data providedunprocessable_entity: Valid request but cannot be processedcooldown_failed: Data refresh cooldown period not yet elapsedconsent_not_active: Consent is not usable...
bad_requestvalidation_errorinvalid_inputunprocessable_entitycooldown_failedconsent_not_activemethod_selection_errormethod_input_validation_errorlink_expiredHuman-readable error message
Response Attributes
Unique identifier for this error instance
Request identifier for tracking and correlation
Machine-readable error code for 401 errors:
unauthorized: Authentication failed or insufficient permissions
unauthorizedHuman-readable error message