Skip to main content

Start PayPal Authorization

POST 
/api/paypal/integrations/:id/authorize

Begins the Connect with PayPal sign-up for an integration and returns the PayPal URL to send the merchant to (open it in a popup or new window).

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

SKU.io creates a PayPal partner referral whose return URL is GET /api/paypal/oauth/callback?state=.... The state is single-use and carries the tenant, so the callback can find this account again. When the merchant finishes on PayPal, PayPal sends the browser to that callback, which records the connection.

Body

  • confirm_same_account (boolean, optional) — only needed when switching an api_keys account to Connect with PayPal while switch_needs_same_account_confirmation is true: confirms the merchant will sign in with the same PayPal account its existing payments were taken with. Without it such a request returns 409 with requires_same_account_confirmation: true.

Errors

  • 409 — Connect with PayPal is not available on this deployment yet (use API keys instead), or the same-account confirmation above is required.
  • 422 — PayPal rejected or could not be reached while creating the referral.
  • 404 — unknown integration.

Rate limited to 20 requests per minute.

Permission: Integrations → Manage (integrations.manage).

Authentication: Bearer token (Personal Access Token).

Request​

Responses​

OK

Response Headers
    Content-Type