List PayPal Pay Links
GET/api/paypal/integrations/:id/pay-links
Lists the pay links created for one PayPal integration, newest first, with paging, sorting, search and filters.
Authentication: Requires Bearer token.
link_reference and link_route identify the sales order each link collects payment for. pay_url is the full customer-facing pay page address on the tenant's own domain; pay_path is the same address relative to that domain.
status is the link's current state: an active link past its expires_at is reported as expired.
Returns 404 when the integration does not exist.
attention is set ("Account disconnected — check PayPal") on a pending link whose payment is still clearing after its PayPal account was disconnected: check that payment in PayPal.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Permission: Integrations → List (integrations.index).
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.