Retrieve api key details.

Get an API Key

Endpoint to view an API Key's details.

Required Scopes

The API Key calling this endpoint must have one of the following scopes:

  • pcx:api_key:*
  • pcx:api_key:read

Scope documentation

ScopeDescription
pcx:account_updater:results:readView Account Updater results
pcx:account_updater:schedules:createCreate an Account Updater Schedule
pcx:account_updater:schedules:deleteDelete an Account Updater Schedule
pcx:account_updater:schedules:patchUpdate an Account Updater Schedule
pcx:account_updater:schedules:postAdd data to Account Updater Schedule
pcx:api_key:*Perform all API Key actions
pcx:api_key:createCreate API Key
pcx:api_key:deleteDelete API Key
pcx:api_key:readView API Key settings
pcx:api_key:updateUpdate API Key settings
pcx:apple_pay:*Perform all Apple Pay actions
pcx:apple_pay:account:*Perform all actions on Apple Pay Accounts
pcx:apple_pay:account:createCreate an Apple Pay Account
pcx:apple_pay:account:viewView an Apple Pay Account settings
pcx:apple_pay:session:getFetch an ApplePay session
pcx:dynamic_descriptors:*Perform all Dynamic Descriptor actions
pcx:dynamic_descriptors:createCreate a Dynamic Descriptor
pcx:dynamic_descriptors:deleteDelete a Dynamic Descriptor
pcx:dynamic_descriptors:readView a Dynamic Descriptor details
pcx:dynamic_descriptors:updateUpdate a Dynamic Descriptor
pcx:iframe:*Perform all secure iframe checkout related actions
pcx:iframe:createCreate a secure iframe checkout
pcx:iframe:deleteDelete a secure iframe checkout
pcx:iframe:instance:*Perform all secure iframe checkout instance actions
pcx:iframe:instance:createCreate a secure iframe checkout instance
pcx:iframe:instance:readView a secure iframe checkout instance details
pcx:iframe:readView a secure iframe checkout details
pcx:iframe:updateUpdate a secure iframe checkout settings
pcx:payments:*Perform all Payment related actions
pcx:payments:createInitialize a Payment
pcx:payments:readView Payment Details
pcx:payments:updateUpdate a Payment
pcx:webhooks:*Perform all Webhook related actions
pcx:webhooks:createCreate a Webhook
pcx:webhooks:deleteDelete a Webhook
pcx:webhooks:readView Webhook details
pcx:webhooks:updateUpdate a Webhook
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!