v2

latestOpenAPI 3.1.02026-07-262279731.3 MB

Authentication

Create an access token for the Recipients embedded experience

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.

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

Headers

Authorizationstring required

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 body

clientIdstring required

Your Mangopay Client ID.

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.