PaymentsClient ID + Client secretConfirm pricing before publishing
PayPal
PayPal checkout (Orders v2) for plan payments.
AProvider definition
- Provider
- PayPal
- What it does
- PayPal checkout (Orders v2) for plan payments.
- Why we need it
- PayPal checkout (Orders v2) for plan payments.
- Used in
- Billing (Super Admin)
BAccount requirements
- Account type
- PayPal Business account + REST app
- Prerequisites
- None
CConnection method
- Authentication
- Client ID + Client secret
- Where to enter it
- Platform-wide (Super Admin): Super Admin → Platform → IntegrationsPlatform owner. Used for every customer who hasn't added their own key; can also be set as PLATFORM_KEY_<PROVIDER> on the API server.
Setup steps
- 1developer.paypal.com → Apps & Credentials → Create app (sandbox and live).
- 2Super Admin → Platform → Integrations → PayPal: enter the credentials and mode, then Test.
DPermissions & API scopes
No OAuth scopes — access is controlled by the key or token itself. Restrict keys to the APIs listed in the setup steps where the provider allows it.
This list is generated from the scopes the application's code requests.
EFree vs paid
- Free account / free API access
- No monthly fee.
- Card or billing account required?
- No.
- Paid plan / costs
- Per-transaction fees.
- Quota and usage limits
- Provider-specific rate limits.
Not yet verified. Confirm on the provider's official pricing page before publishing.
FSetup screenshots
Capture each step with real values masked. Save images as public/docs/integrations/paypal/1.png … 10.png and they appear here automatically.
- Screenshot to add1. Account login / creationThe provider's sign-in or sign-up page.
- Screenshot to add2. Developer consoleThe developer console or dashboard home.
- Not applicable3. Project / app creationCreating the app or project used for this integration.
- Not applicable4. API enablementThe API or product enabled for the project.
- Not applicable5. OAuth configurationConsent screen / OAuth settings with the redirect URIs.
- Screenshot to add6. API key / credentials creationCreating the key, secret or token (mask the value).
- Not applicable7. Permissions / scopesThe scopes or permissions requested or approved.
- Screenshot to add8. Billing / quota settingsBilling, credits or quota page.
- Screenshot to add9. Application connectionThe provider card in our application with fields filled (secrets masked).
- Screenshot to add10. Successful connectionThe green Test result or the connected account listed.
GApplication configuration
Never include real API keys, client secrets, access tokens or passwords in screenshots, tickets or documentation. Values below are field names and examples only.
| Field | Required | Example / default | Notes |
|---|---|---|---|
| Client ID | Yes | — | |
| Client secret | Yes | •••••••• | Stored encrypted; shown masked after saving. |
| Mode (sandbox / live) | Optional | — |
HTesting
- 1Click Test — it requests an access token.
ITroubleshooting
| Problem | What to do |
|---|---|
| Invalid credentials | The key or token is wrong, revoked or from another project. Create a new one and paste it again, then click Test. |
| Missing permissions | The key's project or role doesn't include this API. Grant access or create the key in the right project. |
| API not enabled | Enable the API/product for the project or app in the provider console and wait a few minutes. |
| Quota exceeded | Wait for the quota window to reset (see section E) or request a higher quota / add credits. |
| Account not eligible | Check the account requirements in section B (e.g. business/professional account, verified property, registered organisation). |
| Billing required | Add a payment method or prepaid credits on the provider account (see section E). |
JDisconnect & security
- Revoke access at the provider
- Delete or regenerate the app secret in the PayPal developer dashboard.
- Disconnect in the application
- Super Admin → Platform → Integrations → open the card → Remove / Disconnect. Connected accounts can be disconnected per brand.
- Rotate credentials
- Create the new key or secret first, paste it into the same card and Test, then delete the old one at the provider — no downtime.
- How credentials are stored
- Encrypted at rest with AES-256-GCM using the server's ENCRYPTION_KEY, shown masked after saving, never returned to the browser, and used only from the API server.
- What data the application can access
- Orders created at checkout.

