Skip to navigation
OverviewAuthentication

Create an access token for the Recipients embedded experience

Generates an access token to run the Recipients frontend embedded experience using Mangopay Elements.

The OAuth bearer token you use to call this endpoint must be generated using an API key with specific permissions.

A single access token can be used to service the experience to one user and has a lifespan of 15 minutes. You need to provide the UserId of the Natural User or Legal User who will use the frontend session to register a Recipient.

Authentication

AuthorizationBearer

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

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Request

This endpoint expects an object.
clientIdstringRequired
Your Mangopay Client ID.
claimsobjectRequired
Claims for the access token request.

Response

Success
access_tokenstringOptional

The value to use as the clientToken when initializing Mangopay Elements for the Recipients embedded experience.

token_typestringOptional

Returned values: Bearer

The type of the token.

expires_inintegerOptional
The number of seconds until the token expires.
scopestringOptional

Returned values: bankaccounts:r bankaccounts:w

The API permission scopes of the token, in this case to read and write bank account data.