Skip to main content

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.

Required scope: accounting:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Permission: Integrations → List (integrations.index).

Request​

Responses​

OK

Response Headers
    Content-Type