Create PayPal Integration

POST 
/api/paypal/integrations

Creates a new, not-yet-connected PayPal integration (one per PayPal Business account). Connect it afterwards with Start PayPal Authorization (Connect with PayPal) or Connect PayPal With API Keys.

Not yet available to API tokens

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

Creating the integration also makes sure a "PayPal Payment" payment type exists, so it can be mapped to QuickBooks Online or Xero before the first PayPal payment arrives.

Body

• name (string, required, max 255) — display name for the account, e.g. the business or store it collects for.

Returns 201 with the new integration (connected: false, onboarding_status: null).

Permission: Integrations → Manage (integrations.manage); otherwise 403.

Authentication: Bearer token (Personal Access Token).

Request

Responses

201

Created

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden

Response Headers

Content-Type

422

Unprocessable Entity

Response Headers

Content-Type

429

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.