Skip to main content
POST
Connect PayPal with the company's own PayPal app

Authorizations

Authorization
string
header
required

Portal API key minted in portal Settings → API access. Scope read or write; pinned to one company. Send as Authorization: Bearer lac_sk_....

Body

application/json
client_id
string
required

The Live app's Client ID exactly as the PayPal Developer Dashboard shows it.

Pattern: ^[A-Za-z0-9_-]{20,128}$
client_secret
string
required
write-only

The Live app's Secret. Never returned.

Maximum string length: 256
customer_id
string

Target company. Optional for API keys.

Response

The credentials are stored and the connection is registered. A verified app claims its PayPal account and starts the first import, reaching back three years; a refused or unchecked one leaves the connection waiting for a recheck. The response carries only the secret's last four characters.

customer_id
string
required
connection
object
required

A connection created from a pasted credential. A connection waiting for verification has status reauth_required, attention_required and reauth_required true, last_error_code credential_rejected (the provider refused the credential) or credential_unverified (the provider could not be reached), the provider's message in last_error_message, and no external_company_id until a recheck verifies it.

event_id
string
required
credential_check
object
required

The last check of a stored credential with its provider. rejected: the provider refused it; unverified: the provider could not be reached to check it; not_checked: the provider offers no check. Absent on connections that predate credential checks.