withdraw

Start Log in with PayPal

Changed on

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

Request

  • Base URL
    https://api-sandbox.coinflow.cash/api
  • URL
    https://api-sandbox.coinflow.cash/api/withdraw/paypal/login
  • Auth
    API key in header x-coinflow-auth-user-id

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

Changes

  • 81b590227b14Revision changes
    • warning

      deleted the header request parameter x-coinflow-auth-user-id

    • info

      the endpoint scheme security userId was added to the API

  • 66b771d6d31fRevision changes
    • info

      api operation id start-paypal-login removed and replaced with withdraw_StartPaypalLogin