Skip to main content
POST
Create a token to initialize the Benji Connect SDK
The x-api-key header value to be used on this API is your partner API key, which can be generated through the Developer page in Pilot.
The Connect Token API resolves merchant and partner from partnership_id.

Request body

string
required
The unique identifier of the partnership on the Benji Platform.
number
required
The connection mode for the SDK (Connect = 1, Transfer = 3, and Redeem = 4). See Connect modes.
string
Display name shown in the Connect UI. If omitted, the name configured for the partnership on the platform is used.
string
A unique identifier for the user in your system. When set, the flow can skip the authentication step for your user.
object
Custom attributes for the connection flow (e.g. transfer actions).

Example requests

Return values

string
required
The connect token to pass when initializing the Benji Connect SDK or as connect_token on the Benji Hosted Connect URL.
string
Base URL for Benji Hosted Connect for this partnership. Append ?connect_token=<token> (and optional query parameters) to send users into Benji Hosted Connect. May be empty if Benji Hosted Connect URLs are not enabled for your account.