Server side implementation
To use the embedded component, you need to generate an access token for the connected account’s company. This token grants temporary access to the payout portal for that specific company.Create Access Token API
See the full API reference for generating access tokens and all available
parameters
Client side setup
Client side implementation
PayoutsSession Props
ThePayoutsSession component requires the following props:
| Prop | Type | Required | Description |
|---|---|---|---|
token | string | Promise | Function | Yes | Access token for the session. Can be a string, promise, or function that returns a token. |
companyId | string | Yes | The company ID for the connected account. |
redirectUrl | string | Yes | Absolute URL (e.g., https://yourapp.com/verification-complete) to redirect the user to after identity verification is completed. |
currency | string | No | Currency code (e.g., “USD”). Defaults to “USD”. |
Example
The
redirectUrl must be a publicly accessible URL. Localhost URLs (e.g.,
http://localhost:3000) will not work. For local development, use a tunneling
service like ngrok to expose your local server.
