Preset payment method
Presets a payment method for a customer on the selected payment gateway and returns the gateway-hosted setup page URL.
The request body is polymorphic and is selected by paymentGatewayType.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
- Option 1
- Option 2
Polymorphic request payload for presetting a payment method.
The concrete schema is selected by paymentGatewayType:
- stripe-connect -> StripePaymentMethodPresetRequest
- payer-max-isv -> PayerMaxPaymentMethodPresetRequest
Gateway type discriminator. Fixed value stripe-connect
stripe-connect "stripe-connect"
Unique customer identifier (for example user ID) used to query or create a gateway customer
"user-12345"
Redirect URL after setup is completed
"https://example.com/payment/success"
Stripe-only required field. Redirect URL when the user cancels setup on Stripe.
"https://example.com/payment/cancel"
Response
Success; returns the payment method setup page URL
Gateway-provided redirect URL to the setup page
