Authentication

The API accepts 2 different authentication methods:

OAuth2

Retrieve an Access Token with the OAuth 2.0 flows described below before accessing the API. Once you have an access token, send it in the Authorization HTTP header to authenticate with the API.

Flow type authorizationCode
Authorization URL https://id.pace.cloud/auth/realms/pace/protocol/openid-connect/auth
Token URL https://id.pace.cloud/auth/realms/pace/protocol/openid-connect/token
Refresh URL https://id.pace.cloud/auth/realms/pace/protocol/openid-connect/token
Scopes
  • pay:transactions:read: Get a transaction If the client has the scope `pay:payment-transactions:global-list` and the user the realm role `finance_operator` access to all transactions is permitted (administrative access).
  • pay:payment-tokens:read: Get a payment token
  • pay:transactions:cancel: Cancel a transaction
  • pay:transactions:create: Create a transaction
  • pay:payment-methods:read: Get/search for payment methods
  • pay:payment-methods:patch: Change customer fields on the payment method
  • pay:payment-tokens:create: Create a payment token
  • pay:payment-tokens:delete: Delete a payment token
  • pay:payment-methods:create: Create a payment method
  • pay:payment-methods:delete: Delete a payment method

Oidc (openIdConnect)

OpenID Connect is a simple identity layer on top of the OAuth 2.0 protocol. It enables Applications to verify the identity of End-Users based on the authentication performed by an Authorization Server.

The OpenID Connect URL for this API is: https://id.pace.cloud/auth/realms/pace/.well-known/openid-configuration.