Interface ConnectGateway

Type declaration

• final_redirect: string

  URL to send the user to when the connection is finished. The API appends a status query parameter: 0 means success, 1 to 5 mean an error. Must be on an allowed admin host.

• Optional options?: { email?: string; paypal_product_type?: "ppcp" | "express_checkout" }

  Gateway-specific connection options.

  • Optional email?: string

    For paypal_platform, the email of the PayPal account to connect. Pass the connected account's email to reconnect it with extra permissions.

  • Optional paypal_product_type?: "ppcp" | "express_checkout"

    Required for paypal_platform. ppcp connects PayPal Checkout with direct card payments (supported store countries only), express_checkout connects PayPal Checkout only.

• type: string

  Payment gateway type to connect, for example stripe_connect. When reconnecting a hosted payment gateway, the API uses that gateway's own type and ignores this value.