Skip to main content
POST
Create PayPal Link Session

Authorizations

Authorization
string
header
required

An Account API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-10-13-1"

Body

application/json
return_url
string
required

Where to send the holder once the PayPal login finishes. Must be an https URL; it receives paypal_link_token on success or error on failure.

Example:

"https://example.com/settings/payouts"

supported_payout_method_id
string
required

The PayPal supported payout method to connect (a podst_ identifier whose supports_paypal_login is true).

Example:

"podst_xxxxxxxxxxxxxx"

account_id
string

The account that will own the PayPal payout method, prefixed biz_. Provide this or user_id.

Example:

"biz_xxxxxxxxxxxxxx"

destination_currency
string
default:usd

Currency the PayPal payout method will deliver payouts in.

Example:

"usd"

user_id
string

The user who will own the PayPal payout method, prefixed user_. Provide this or account_id.

Response

PayPal login started

authorize_url
string
required

The PayPal login page to send the account holder to.

Example:

"https://www.paypal.com/connect"

expires_at
string<date-time>
required

When the login session stops being accepted, as an ISO 8601 timestamp; start a new one after this.

Example:

"2026-01-01T12:00:00.000Z"