Sign in

v3

latestOpenAPI 3.1.02026-08-06186981679.4 KB
withdraw

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.

post/withdraw/paypal/login

Headers

x-coinflow-auth-user-idstring required

The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Request body

returnUrlstring

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 required
statestring required
urlstring required