API ReferenceWithdraw

Start Log in with PayPal

Begins the “Log in with PayPal” flow. Returns the PayPal authorization URL to redirect the withdrawer to, a signed state that must be echoed back to the callback endpoint, and a sessionId the widget polls (via ) to learn when linking finished.

Authentication

x-coinflow-auth-user-idstring
The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
Authorizationstring
The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
OR
x-coinflow-auth-walletstring
The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
x-coinflow-auth-blockchainstring
The blockchain associated with the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
x-coinflow-auth-merchant-idstring
The merchant ID the session should be generated for
OR
x-coinflow-auth-session-keystring
The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Request

This endpoint expects an object.
returnUrlstringOptional

Headless (API) flow: the merchant page to send the withdrawer back to once linking completes. PayPal returns to Coinflow’s own fixed handler, which then redirects the browser here. Must be one of the merchant’s whitelisted URLs. Omit for the core-flows widget (which uses Coinflow’s own return page).

Response

Ok
sessionIdstring
statestring
urlstring