Skip to main content
POST
Create PayPal Link Session

Autorisationer

Authorization
string
header
påkrævet

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.

Scopes

payout:create_destination

Overskrifter

Idempotency-Key
string

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

Maximum string length: 255
Eksempel:

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

Api-Version-Date
string

Pins the request to a dated API version.

Eksempel:

"2026-11-17"

Krop

application/json
return_url
string
påkrævet

Where to send the holder once the PayPal login finishes. Must be an https URL whose host is a domain added to the account, or to its platform, with POST /domains and verification: {}; the domain doesn't need to finish verifying. Whop's own pages and https://localhost are also accepted; they're the only options for a user_id session. It receives paypal_link_token on success or error on failure.

Eksempel:

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

supported_payout_method_id
string
påkrævet

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

Eksempel:

"podst_xxxxxxxxxxxxxx"

account_id
string

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

Eksempel:

"biz_xxxxxxxxxxxxxx"

destination_currency
string
standard:usd

Currency the PayPal payout method will deliver payouts in.

Eksempel:

"usd"

user_id
string

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

Svar

PayPal login started

authorize_url
string
påkrævet

The PayPal login page to send the account holder to.

Eksempel:

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

expires_at
string<date-time>
påkrævet

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

Eksempel:

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