Class OAuthResource

Index

Constructors

Methods

authorizeUrl deauthorize token

Constructors

constructor

new OAuthResource(): OAuthResource
Returns OAuthResource

Methods

authorizeUrl

authorizeUrl(
params?: Stripe.OAuthAuthorizeUrlParams,
options?: OAuthAuthorizeUrlOptions,
): string
Get a URL to which you can send a user to complete the OAuth flow to authorize their account.
Parameters
- Optionalparams: Stripe.OAuthAuthorizeUrlParams
- Optionaloptions: OAuthAuthorizeUrlOptions
Returns string
Docs
https://stripe.com/docs/connect/oauth-reference#get-authorize
- Defined in node_modules/stripe/types/OAuth.d.ts:331

deauthorize

deauthorize(
params: OAuthDeauthorizeParams,
options?: RequestOptions,
): Promise<OAuthDeauthorization>
Used for revoking access to an account.
Parameters
- params: OAuthDeauthorizeParams
- Optionaloptions: RequestOptions
Returns Promise<OAuthDeauthorization>
Docs
https://stripe.com/docs/connect/oauth-reference#post-deauthorize
- Defined in node_modules/stripe/types/OAuth.d.ts:340

token

token(params: OAuthTokenParams, options?: RequestOptions): Promise<OAuthToken>
Turning an authorization_code into an access_token, or get a new access token using a refresh_token.
Parameters
- params: OAuthTokenParams
- Optionaloptions: RequestOptions
Returns Promise<OAuthToken>
Docs
https://stripe.com/docs/connect/oauth-reference#post-token
- Defined in node_modules/stripe/types/OAuth.d.ts:349