v11

latestOpenAPI 3.1.12026-08-03174162.0 MB
Team Payments

Initiate payment processor connection

Start the OAuth flow to connect a team's payment processor account. Returns an authorization URL to redirect the user to the payment provider's OAuth page. The OAuth callback is handled directly by the payment gateway.

post/teams/{key}/payment/connect

Path parameters

keystring required

Team identifier (ID or slug)

Request body

provider'STRIPE' | 'AIRWALLEX' required

Payment processor to connect

Example request

{
  "provider": "STRIPE"
}

Response

OK

authorizationUrlstring uri required

URL to redirect the user to for OAuth authorization. Open in a new window or redirect the current page.

Example response

{
  "authorizationUrl": "https://connect.stripe.com/oauth/authorize?response_type=code&client_id=ca_xxx&scope=read_write&redirect_uri=..."
}