PayConexDecryptxShieldConexTECS Platform
API Reference
Request SandboxContact Us

Create api key.

post
https://api-cert.payconex.net/api/v4/accounts//api-keys

Create an API Key

Endpoint to create an API Key.

Required Scopes

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

  • pcx:api_key:*
  • pcx:api_key:create

Scope documentation

ScopeDescription
pcx:account_updater:*Perform all Account Updater actions
pcx:account_updater:results:*Perform all Account Updater results actions
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:admin:cacheInteract with memory cache
pcx:admin:natsInteract with nats.io cluster
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:api_key_scopes:readRead API Scopes
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:auth:bearer:*Issue user bearer tokens
pcx:auth:poi-bearerIssue a bearer token for a POI app
pcx:auth:poi-pos-bearerIssue a bearer token for a POI POS
pcx:auth:tokenIssue a bearer token for a Authentication
pcx:auth:wssg-admin-bearerIssue a bearer token to WSSG Admins
pcx:batch:manual-settlementManual Batch Settlement Trigger
pcx:card_bins:*Perform all Card Bins actions
pcx:card_bins:readFetch a list of a Card Bins
pcx:detokenize:ach:createDetokenize ach data
pcx:detokenize:card:createDetokenize card data
pcx:detokenize:gpay:createDetokenize Gpay data
pcx:device_profile:readRead Device Profile
pcx:devices:*Perform all Devices actions
pcx:devices:createCreate a Device
pcx:devices:deleteDelete a Device
pcx:devices:readFetch a list or a single Device
pcx:devices:updateUpdate a Device details
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:epic_payment_page:*Perform all epic payment page
pcx:epic_payment_page:completeComplete epic payment page transaction
pcx:epic_payment_page:initInitialize payment page transaction
pcx:epic_payment_page:traceConsumes Debug information related to epic payment page transaction
pcx:epic_payment_page_config:*Perform all epic payment page config
pcx:epic_payment_page_config:createCreate epic payment page config
pcx:epic_payment_page_config:deleteDelete epic payment page config
pcx:epic_payment_page_config:readFetch payment page config
pcx:epic_payment_page_config:updateUpdate epic payment page config
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:instance:tokenize-achTokenize ACH Payment details
pcx:iframe:instance:tokenize-cardTokenize Card Payment details
pcx:iframe:instance:tokenize-ctpTokenize Mastercard Click To Pay details
pcx:iframe:instance:tokenize-gpayTokenize Google Payment details
pcx:iframe:readView a secure iframe checkout details
pcx:iframe:updateUpdate a secure iframe checkout settings
pcx:level3_profiles:*Perform all Level3 Profile actions
pcx:level3_profiles:createCreate a Level3 Profile
pcx:level3_profiles:deleteDelete a Level3 Profile
pcx:level3_profiles:readFetch a list or a single Level3 Profile
pcx:level3_profiles:updateUpdate a Level3 Profile details
pcx:payments:*Perform all Payment related actions
pcx:payments:ach:*Process ACH Payments
pcx:payments:ach:refundProcess ACH Refunds
pcx:payments:ach:saleProcess ACH Sale Payments
pcx:payments:ach:storeProcess ACH Store Payments
pcx:payments:captureCapture an Authorization
pcx:payments:card_not_present:*Process Card Not Present Payments
pcx:payments:card_not_present:authProcess Card Not Present Auth transactions
pcx:payments:card_not_present:creditProcess Card Not Present Credit transactions
pcx:payments:card_not_present:forceProcess Card Not Present Force transactions
pcx:payments:card_not_present:saleProcess Card Not Present Sale transactions
pcx:payments:card_not_present:storeProcess Card Not Present Store transactions
pcx:payments:createInitialize a Payment
pcx:payments:device:*Process Device Payments
pcx:payments:device:authProcess Device Auth transactions
pcx:payments:device:creditProcess Device Credit transactions
pcx:payments:device:forceProcess Device Force transactions
pcx:payments:device:saleProcess Device Sale transactions
pcx:payments:device:storeProcess Device Store transactions
pcx:payments:readView Payment Details
pcx:payments:refundRefund a Payment
pcx:payments:twilioProcess a twillio Payment
pcx:payments:updateUpdate a Payment
pcx:poi:*Send all POI commands
pcx:poi:authSend a auth command to a POI app
pcx:poi:cancelSend a cancel command to a POI app
pcx:poi:creditSend a credit command to a POI app
pcx:poi:custom_printSend a custom receipt print command to a POI app
pcx:poi:forceSend a force command to a POI app
pcx:poi:list_transactionsSend a list transaction command to a POI app
pcx:poi:poslinkSend a poslink command to a POI app
pcx:poi:rebootSend a reboot command to a POI app
pcx:poi:refundSend a refund transaction command to a POI app
pcx:poi:saleSend a sale command to a POI app
pcx:poi:show_dialogSend a show dialog command to a POI app
pcx:poi:statusSend a status command to a POI app
pcx:status:*Perform all Status related actions
pcx:status:natsView nats status details
pcx:three_d_secure:*3DS All Scopes
pcx:three_d_secure:init:create3DS Init Browser Authenticate
pcx:three_d_secure:no_scopeUn Authenticated API call
pcx:three_d_secure:status:read3DS Status check
pcx:tokenize:*Tokenize all types of payment data
pcx:tokenize:achTokenize ach data
pcx:tokenize:cardTokenize card data
pcx:webhooks:*Perform all Webhook related actions
pcx:webhooks:createCreate a Webhook
pcx:webhooks:deleteDelete a Webhook
pcx:webhooks:readView Webhook details
pcx:webhooks:triggerTrigger a Webhook
pcx:webhooks:updateUpdate a Webhook
Path Params
string
required
Body Params

Create API Key Body

string
required

A word or short phrase that describes an API Key.

methods
array of strings
methods
accounts
array of strings
accounts
scopes
array of objects
required
scopes*
string

How long this key should live for. (not used if the expiresAt param is provided)

date-time | null

Timestamp at which point this API Key will expire. Note that this field takes precedence over the expiresIn field.

boolean

Indicates if the key is enabled.

Responses

Updated 8 months ago

Language
Credentials
Basic
base64
:
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 8 months ago