Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

trace-id
string
required

Body

application/json

Preset payment method request for Stripe Connect

paymentGatewayType
enum<string>
required

Gateway type discriminator. Fixed value stripe-connect

Available options:
stripe-connect
Example:

"stripe-connect"

customerIdentifier
string
required

Unique customer identifier used to query or create a gateway customer. When Billing is used, this is the accountNumber

Example:

"ACC-0000000001"

redirectUrl
string<uri>
required

Redirect URL after setup is completed

Example:

"https://example.com/payment/success"

cancelUrl
string<uri>
required

Stripe-only required field. Redirect URL when the user cancels setup on Stripe.

Example:

"https://example.com/payment/cancel"

Response

Success; returns the payment method setup page URL

Gateway-provided redirect URL to the setup page