Get Public Pay Page
GET/api/public/paypal/pay/:token
Returns what the pay page shows the buyer for a PayPal pay link, and the settings it needs to load PayPal's JavaScript SDK.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Called by the public pay page, not by an integrator. No bearer token: the pay link token in the URL is the only credential. The request must be sent to the seller's own workspace host (e.g. https://acme.sku.io), because the workspace is identified from the host; on any other host the response is 404 Payment page not found. (plain text). Limited to 60 requests per minute (20 per minute for checkout and capture). Returns 503 while the workspace is briefly under maintenance.
Response fields
status—active(payable),pending(a payment is processing),paid,expired,cancelled(also when the order was deleted), orunavailable(the seller's PayPal account is disconnected, its API keys were rejected, or PayPal is not available).company_name— the store name on the order (falls back to the workspace name).order_number— the sales order number, or the sales invoice number for an invoice pay link.amount— amount this link collects (2 decimals).order_total— the order's full total (null for invoice links).is_part_payment— true when the link asks for less than the order still owes (a deposit or part payment).currency— ISO code.paypal_client_id,merchant_id,bn_code,environment— values for loading PayPal's JS SDK: an API keys account uses its own Client ID with nomerchant_id; a Connect with PayPal account uses SKU.io's partner Client ID scoped to the seller'smerchant_id.account_needs_attention— true when PayPal no longer accepts the seller's API keys (the buyer should contact the seller).
Authentication: none (pay link token in the URL).
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
Response Headers
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.