Start PayPal Payment Method Setup

Start a hosted PayPal payment method setup flow for the organization. Redirect the user to redirect_url, then verify with checkout_id after the provider returns.

Authorization

BearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

Request payload.

TypeScript Definitions

Use the request body type in TypeScript.

success_url*string

Public URL returned for this resource or action.

Formaturi

cancel_url*string

Public URL returned for this resource or action.

Formaturi

[key: string]?any

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/billing/payment-methods/paypal/setup" \  -H "Content-Type: application/json" \  -d '{    "success_url": "https://northstar-distribution.co.uk/billing/paypal/success",    "cancel_url": "https://northstar-distribution.co.uk/billing/paypal/cancel"  }'

{  "success": true,  "message": "Payment method setup created.",  "data": {    "checkout_id": "39b189c1-8f8e-4df2-8632-176f87f791a1",    "gateway": "paypal",    "redirect_url": "https://checkout.spacemedia-docs.invalid/session/docs-checkout-session"  }}

Authorization

Request Body

Response Body

200application/json

401application/json

403application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`