Issue API Key

Issue a new API key for the Payment Element, scoped to one or more properties.

The response includes both the identity (public) and the secret (private).
The secret is only returned once at creation time and cannot be retrieved later.

Important: Treat the secret as a password. Store it in a secure vault or secrets manager.
Do not log it, commit it to source control, or expose it in client-side code.

Using with the Payment Webcomponent

To initialize the payment webcomponent your backend must produce a token from the
identity and secret, then populate the webcomponents api-key field.
The token format is:

{identity}.{base64(HMAC_SHA256(message, secret))}

Where:

  • message is the literal string "{identity}|{property_id}" (UTF-8 bytes, pipe-separated, no surrounding whitespace).
  • secret is the value returned by this endpoint, used as-is (its raw ASCII bytes). Do not base64-decode it before signing.
  • The HMAC digest is the raw 32 bytes of HMAC-SHA256, then standard base64 encoded (not base64url, no = stripping).
  • The token is the identity, a literal ., then the base64 digest.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Issue Api Key

property_ids
array of strings
required

Array of property IDs to scope the key to. At least one is required and must be scoped to your JWT key

property_ids*
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json