Authentication

Create an access token for Checkout SDK features

Changed on

Generates an access token to initialize the Checkout SDK to offer PayPal One-Click.

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

The access token returned by this endpoint is only required for the following features using Checkout SDK:

  • PayPal One-Click

You do not need an access token if using Checkout SDK to service other payment methods or PayPal without PayPal One-Click.

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 Checkout session to make the payment.

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

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/oauth/token/embedded/checkout
  • Auth
    HTTP bearer

Request body

clientIdstring required

Your Mangopay Client ID.

Response

Success

access_tokenstring

The access token value to use as the clientToken value when initializing Checkout SDK.

token_typestring

Returned values: Bearer

The type of the token.

expires_ininteger

The number of seconds until the token expires.

scopestring

Returned values: checkout.session:r checkout.session:w

The API permission scopes of the token, in this case to read and write a Checkout session.

Changes

  • f44a59c76515Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e731ec4a85bRevision changes
    • info

      api operation id create_access_token_checkout removed and replaced with authentication_create_access_token_checkout