Create an access token for the Recipients embedded experience

POST

/v2.01/oauth/token/embedded/recipient

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

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.

Generate an access token to run the [Recipients frontend embedded experience](/sdks/elements) using Mangopay Elements 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.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) 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_tokenstring

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

token_typestring

Returned values: Bearer

The type of the token.

expires_ininteger

The number of seconds until the token expires.

scopestring

Returned values: bankaccounts:r bankaccounts:w

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

1	{
2	"access_token": "rec_019bb6b1683d7251b29e56524bcc551e",
3	"token_type": "Bearer",
4	"expires_in": 900,
5	"scope": "bankaccounts:r bankaccounts:w"
6	}