# Bluefin Tecs Documentation

> Documentation for Bluefin Tecs

## Guides
- [Introduction](https://developers.bluefin.com/tecs/docs/introduction.md)
- [API Endpoints](https://developers.bluefin.com/tecs/docs/api-endpoints.md)
- [Getting Started](https://developers.bluefin.com/tecs/docs/getting-started-1.md)
- [API Authentication](https://developers.bluefin.com/tecs/docs/api-authentication.md)
- [Google Pay™](https://developers.bluefin.com/tecs/docs/google-paytm.md)
- [Example Use Cases](https://developers.bluefin.com/tecs/docs/example-use-cases.md)
- [API Examples](https://developers.bluefin.com/tecs/docs/api-examples.md)
- [References](https://developers.bluefin.com/tecs/docs/references.md)
- [Introduction](https://developers.bluefin.com/tecs/docs/introduction-1.md)
- [Getting Started](https://developers.bluefin.com/tecs/docs/getting-started-2.md)
- [API Examples](https://developers.bluefin.com/tecs/docs/api-examples-1.md)
- [References](https://developers.bluefin.com/tecs/docs/references-1.md)
- [Cloud-iA Semi-Integrated Mode](https://developers.bluefin.com/tecs/docs/cloud-ia-semi-integrated-mode.md)
- [One-way Push Notification Interface](https://developers.bluefin.com/tecs/docs/one-way-push-notification.md)
- [Merchant & Terminal Registration API](https://developers.bluefin.com/tecs/docs/merchant-terminal-registration-api.md)
- [User Management API](https://developers.bluefin.com/tecs/docs/user-management-api.md)

## API Reference
- [Returns application version and build date](https://developers.bluefin.com/tecs/reference/getversion.md)
- [Deactivate Terminal](https://developers.bluefin.com/tecs/reference/deactivateterminal.md): Deactivates teminal by given TerminalId.<br> Required role for operation: TE_MERCHANT_TERMINAL_MANAGEMENT.<br> Create MPauditlog table record with event type : DeactivateTerminal<br> Supported authentication:<br> * Bearer &lt;token&gt; - which is a Bearer token authentication<br>
- [Cancel Transaction](https://developers.bluefin.com/tecs/reference/canceltransaction.md): Searches for a transaction by given parameters: <b>originalTransactionId + terminalId + sourceId</b> <br> and cancels it via TecsXml Interface.<br> Required role for operation: BO_TRANSACTIONMANAGEMENT_CANCEL.<br> Create MPauditlog table record with event type : CancelTransaction.<br> Supports authentication with the following types of tokens:<br> * <b>Bearer</b> &lt;token&gt;, which is a Bearer token authentication. The bearer token is a cryptic string, usually generated by the server in response to a login request. * <b>Basic</b> &lt;credentials&gt;, where credentials is the Base64 encoding of username and password joined by a single colon :, CAS login service will be called for the given username and password for validating credentials. * <b>TecsWebToken</b> &lt;token&gt;, is used for verifying a TecsWeb signature. Token must be hashed with SHA-256 algorithm in HEX format and constructed in format: <pre>transactionId + | + terminalId + | + secretKey</pre>
- [Payment Transaction](https://developers.bluefin.com/tecs/reference/paymenttransaction.md): Searches for a transaction by given parameters: <b>TransactionId + terminalId + sourceId</b><br>  and sends a PaymentTransaction via TecsXml Interface.<br> Send XML MessageType: 0001 and when TransactionType == 'AUTHORIZATION', then TransactionOriginId: 2, else if TransactionType == 'PRE-AUTH' then TransactionOriginId: 5<br> Required role for operation: BO_TRANSACTIONMANAGEMENT_PAYMENT.<br> Create MPauditlog table record with event type : PaymentTransaction.<br> Supports authentication with the following types of tokens:<br> * <b>Bearer</b> &lt;token&gt;, which is a Bearer token authentication. The bearer token is a cryptic string, usually generated by the server in response to a login request.
- [PreAuthCompletion Transaction](https://developers.bluefin.com/tecs/reference/preauthcompletiontransaction.md): Searches for a transaction by given parameters: <b>originalTransactionId + terminalId + sourceId</b><br>  and sends a PreAuthCompletionTransaction via TecsXml Interface.<br> Send XML MessageType: 0013 and TransactionOriginId: 4<br> Required role for operation: BO_TRANSACTIONMANAGEMENT_COMPLETION.<br> Create MPauditlog table record with event type : CompleteTransaction.<br> Supports authentication with the following types of tokens:<br> * <b>Bearer</b> &lt;token&gt;, which is a Bearer token authentication. The bearer token is a cryptic string, usually generated by the server in response to a login request. * <b>TecsWebToken</b> &lt;token&gt;, is used for verifying a TecsWeb signature. Token must be hashed with SHA-256 algorithm in HEX format and constructed in format: <pre>transactionId + | + terminalId + | + secretKey</pre>
- [Refund Transaction](https://developers.bluefin.com/tecs/reference/refundtransaction.md): Searches for a transaction by given parameters: <b>originalTransactionId + terminalId + sourceId</b><br>  and sends a Refund via TecsXml Interface.<br> Required role for operation: BO_TRANSACTIONMANAGEMENT_REFUND.<br> Create MPauditlog table record with event type : RefundTransaction.<br> Supports authentication with the following types of tokens:<br> * <b>Bearer</b> &lt;token&gt;, which is a Bearer token authentication. The bearer token is a cryptic string, usually generated by the server in response to a login request. * <b>Basic</b> &lt;credentials&gt;, where credentials is the Base64 encoding of username and password joined by a single colon :, CAS login service will be called for the given username and password for validating credentials. * <b>TecsWebToken</b> &lt;token&gt;, is used for verifying a TecsWeb signature. Token must be hashed with SHA-256 algorithm in HEX format and constructed in format: <pre>transactionId + | + terminalId + | + secretKey</pre>
- [Status Transaction](https://developers.bluefin.com/tecs/reference/statustransaction.md): Returns status of a transaction searched by: <b>transactionSeqNumber</b> or by combination of: <b>transactionId + terminalId + sourceId</b><br> Create MPauditlog table record with event type : StatusTransaction.<br> Required role: BO_TE_TRANSACTION_HISTORY<br> Supports authentication with the following types of tokens:<br> * <b>Bearer</b> &lt;token&gt;, which is a Bearer token authentication. The bearer token is a cryptic string, usually generated by the server in response to a login request. * <b>Basic</b> &lt;credentials&gt;, where credentials is the Base64 encoding of username and password joined by a single colon :, CAS login service will be called for the given username and password for validating credentials.   * <b>TecsWebToken</b> &lt;token&gt;, is used for verifying a TecsWeb signature. Token must be hashed with SHA-256 algorithm in HEX format and constructed in format: <pre>transactionId + | + terminalId + | + secretKey</pre>
- [Transaction History](https://developers.bluefin.com/tecs/reference/transactionhistory.md): Search for transactions by given parameters<br> Required role for operation: MP_CORPORATE or BO_TE_TRANSACTION_HISTORY.<br> When user has role MP_CORPORATE, then all terminalIds are taken from UserProfile, otherwise terminalIds are taken from TecsCompany2TecsTerm entity.<br> Create MPauditlog table record with event type : TransactionHistory.<br> Supports filtering by wallet type: APAY (Apple Pay), GPAY (Google Pay), GPAY3D (Google Pay 3D Secure).<br> Supports authentication with the following types of tokens:<br> * <b>Bearer</b> &lt;token&gt;, which is a Bearer token authentication. The bearer token is a cryptic string, usually generated by the server in response to a login request.
- [Make a transaction](https://developers.bluefin.com/tecs/reference/maketransaction.md): Make a transaction
- [Version](https://developers.bluefin.com/tecs/reference/getecrversion.md): Get Application version.
- [Register Additional Acquiring for Existing Merchant](https://developers.bluefin.com/tecs/reference/registeradditionalacquiringusingpost.md): Registers an acquirer for an existing merchant’s terminal(s) on the TECS Platform. The call requires the package order UUID (received from the initial merchant registration), the transaction currency (in ISO 4217 format), the acquirer product identifier, and the merchant’s contract number with the acquirer (vu_nummer). Optionally, you may provide a list of terminal IDs  for which acquiring should be enabled. If no terminal IDs are supplied, acquiring will be activated  for all terminals registered to the merchant.
- [Register Additional Terminal for Existing Merchant](https://developers.bluefin.com/tecs/reference/registeradditionalterminalusingpost.md): Registers an additional terminal for an existing merchant on the TECS Platform. The caller must supply the package order UUID (obtained from the initial merchant registration) and detailed terminal information including country code, language code, location, and serial number. Optional fields such as product ID, terminal ID from the acquirer, and user contact details can also be provided. If the merchant username or password are omitted, TECS will generate these credentials and return them in the response.
- [Merchant and Terminal Registration](https://developers.bluefin.com/tecs/reference/registernewmerchantusingpost.md): Registers a new merchant along with its first terminal on the TECS Platform. The caller must supply all required merchant details, including the package ID (supplied by TECS) and merchant address information. On success, the response includes a unique package order UUID (packageorderuuid) that must be stored and used for subsequent registrations  (such as additional terminals or acquirers). If the merchant username or password are omitted, TECS will generate and return them.
- [Register New User](https://developers.bluefin.com/tecs/reference/registeruser.md): Registers a new user within your organization on the TECS Platform.  **Flow Overview:** - Calls Useraccountws.Preregister consumer API. - Generates an email confirmation code and link. - Sends a confirmation email to the user.  **Input Parameters:** - **firstName** (optional): User's first name. - **lastName** (optional): User's last name. - **email** (mandatory, unique): User's email address. - **dateOfBirth** (optional): User's date of birth (format: dd.MM.yyyy). - **street1** (optional): Primary address line. - **street2** (optional): Secondary address line. - **city** (optional): User's city. - **country** (optional): User's country. - **zip** (optional): User's postal code. - **salutation** (optional): User's salutation (e.g., Mr., Ms.). - **phone** (optional): User's phone number. - **identificationNumber** (optional): User's identification number. - **passportNumber** (optional): User's passport number. - **driverLicenceNumber** (optional): User's driver's license number. - **state** (optional): User's state or region. - **login** (optional, unique): User login identifier.  **Required Role:** - BO_USERMANAGEMENT_REGISTER_USER  **Authentication:** Supports both Basic (Base64 encoded credentials: ID:password) and Bearer token authentication.
- [Assign Role to Consumer](https://developers.bluefin.com/tecs/reference/assignroles.md): Assigns one or more roles to an existing user (consumer) within your organization on the TECS Platform.  **Pre-requisites:** - The consumer initiating the role assignment must have an owner role or a superior role. - For example, to assign the `BO_USERMANAGEMENT_REGISTER_USER` role, the caller must possess the `BO_USERMANAGEMENT_SUPERUSER` role.  **Authentication:** Supports both Basic authentication (using Base64 encoded credentials) and Bearer token authentication.

## Changelog
- [PAM v. 3.181.0 - 09.09.2025](https://developers.bluefin.com/tecs/changelog/pam-v-31810-09092025.md)
- [PAM v. 3.179.0 - 16.07.2025](https://developers.bluefin.com/tecs/changelog/pam-v-31790-16072025.md)
- [PAM v. 3.176.1 - 20.05.2025](https://developers.bluefin.com/tecs/changelog/pam-v-31761-20052025.md)
- [TecsClientRest v.0.10.4 - 15.05.2025](https://developers.bluefin.com/tecs/changelog/tecsclientrest-v0104-15052025.md)
- [PAM v. 3.175.0 - 24.04.2025](https://developers.bluefin.com/tecs/changelog/pam-v-31750-24042025.md)


# Decryptx Documentation

> Welcome to the Bluefin Developer Portal where you will find API references, payment and data security guides, and more.

## Guides
- [Welcome to Decryptx](https://developers.bluefin.com/decryptx/docs/introduction-1.md): Integrate to Bluefin's Decryptx and offer our P2PE solution directly to your clients.
- [Decryptx APIs](https://developers.bluefin.com/decryptx/docs/decryptx-api-guide.md): An Introduction to Decryptx APIs and environment.
- [Validate Account](https://developers.bluefin.com/decryptx/docs/validate-account.md): Validate your credentials with the Validate Account endpoint to access the Decryptx API.
- [Validate Device](https://developers.bluefin.com/decryptx/docs/validate-device.md): Ensure that your device has been added to the P2PE Manager, is registered correctly, and functioning properly with the Validate Device endpoint.
- [Decrypt P2PE Data](https://developers.bluefin.com/decryptx/docs/decrypt-p2pe-data.md): Decrypt P2PE data from a device using the Decrypt P2PE Data API endpoint.
- [Decrypt-Ext P2PE Data](https://developers.bluefin.com/decryptx/docs/decrypt-ext-p2pe-data.md): The Decrypt-Ext P2PE Data API endpoint is utilized in what Bluefin calls “P2PE Manager Only” mode.
- [Authentication](https://developers.bluefin.com/decryptx/docs/authentication-1.md): An introduction to the different API authentication methods used in the Decryptx API library and the security protection against replay attacks, time-to-live, request integrity, and private key.
- [Basic Authentication](https://developers.bluefin.com/decryptx/docs/basic-auth-guide.md)
- [Digest Authentication](https://developers.bluefin.com/decryptx/docs/digest-auth-guide.md)
- [HMAC Authentication](https://developers.bluefin.com/decryptx/docs/hmac-authentication-guide.md)
- [RSA Authentication](https://developers.bluefin.com/decryptx/docs/rsa-auth-guide.md)
- [Authentication on Java SDK](https://developers.bluefin.com/decryptx/docs/auth-on-java-sdk.md)
- [Authentication Debug Endpoint](https://developers.bluefin.com/decryptx/docs/auth-debug-endpoint.md)
- [Processing Payloads](https://developers.bluefin.com/decryptx/docs/processing-payloads.md): A guide on how to extract P2PE data from different payment terminal payloads. Learn how to extract the key serial number (KSN) and encrypted payload, and how to parse the decrypted data to reconstruct primary account number (PAN) data.
- [Elo Payloads](https://developers.bluefin.com/decryptx/docs/elo-payloads.md)
- [IDTech Augusta S](https://developers.bluefin.com/decryptx/docs/idtech-augusta-s.md)
- [IDTech SecuRed](https://developers.bluefin.com/decryptx/docs/idtech-secured.md)
- [IDTech Spectrum Pro](https://developers.bluefin.com/decryptx/docs/idtech-spectrum-pro.md)
- [IDTech VP5300](https://developers.bluefin.com/decryptx/docs/idtech-vp5300.md)
- [IDTech VP3350](https://developers.bluefin.com/decryptx/docs/idtech-vp3350.md)
- [Infinite Peripherals Prima M](https://developers.bluefin.com/decryptx/docs/infinite-peripherals-prima-m.md)
- [Ingenico RA1 Series](https://developers.bluefin.com/decryptx/docs/ingenico-ra1.md)
- [Ingenico RBA Series](https://developers.bluefin.com/decryptx/docs/ingenico-rba.md)
- [Ingenico UPP Series](https://developers.bluefin.com/decryptx/docs/ingenico-upp-series.md)
- [Ingenico ARC Series](https://developers.bluefin.com/decryptx/docs/ingenico-arc-series.md)
- [Ingenico RUA Series](https://developers.bluefin.com/decryptx/docs/ingenico-rua-series.md)
- [Miura M010 & Shuttle](https://developers.bluefin.com/decryptx/docs/miura-shuttle.md)
- [Verifone XPI](https://developers.bluefin.com/decryptx/docs/verifone-xpi.md)
- [Verifone VIPA](https://developers.bluefin.com/decryptx/docs/verifone-vipa.md)
- [WisePad](https://developers.bluefin.com/decryptx/docs/wisepad.md)
- [Error Handling for Processing Payloads](https://developers.bluefin.com/decryptx/docs/error-handling-for-processing-payloads.md): Possible error codes and where they appear in a Decryptx response.
- [Decryptx Java SDK](https://developers.bluefin.com/decryptx/docs/rest-clients.md): How to download and install the Decryptx Java software development kit (SDK) and use it with Maven.
- [Connectivity Options](https://developers.bluefin.com/decryptx/docs/connectivity-options.md): Bluefin support for Decryptx connectivity.
- [Decryptx Parser](https://developers.bluefin.com/decryptx/docs/decryptx-parser.md): Introduction to Bluefin's Decryptx Secure Payload Parser API endpoint.
- [API Reference](https://developers.bluefin.com/decryptx/docs/parser-api-reference-1.md)
- [Java Guide](https://developers.bluefin.com/decryptx/docs/decryptx-parser-java-guide.md)
- [Equinox](https://developers.bluefin.com/decryptx/docs/equinox-payloads.md): How to use Equinox devices with the Decryptx Payload Parser.
- [IDTECH](https://developers.bluefin.com/decryptx/docs/idtech-payloads.md): How to use IDTECH terminals with the Decryptx Payload Parser.
- [Ingenico RA1](https://developers.bluefin.com/decryptx/docs/ingenico-ra1-payloads.md): How to extract P2PE data from Ingenico RA1 payloads for processing on the Decryptx Parser.
- [Ingenico RBA](https://developers.bluefin.com/decryptx/docs/ingenico-rba-payloads.md): How to extract P2PE data from Ingenico RBA payloads for processing on the Decryptx Parser.
- [Miura](https://developers.bluefin.com/decryptx/docs/miura.md): How to use Miura terminals with the Decryptx Payload Parser.
- [Infinite Peripherals Prima M](https://developers.bluefin.com/decryptx/docs/prima-m.md): How to use the Prima M device with the Decryptx Payload Parser.
- [Verifone](https://developers.bluefin.com/decryptx/docs/verifone-devices.md): How to extract P2PE data from Verifone payloads for processing on the Decryptx Parser.
- [WisePad](https://developers.bluefin.com/decryptx/docs/wisepad-payloads.md): How to use the WisePad mobile payment device with the Decryptx Payload Parser.
- [WisePad 2](https://developers.bluefin.com/decryptx/docs/wisepad-2-payloads.md): How to use the WisePad2 mobile payment device with the Decryptx Payload Parser.
- [Error Handling for Decryptx Parser](https://developers.bluefin.com/decryptx/docs/error-handling-for-decryptx-parser.md): This page describes the the error responses that can be output by the Decryptx Parser's APIs.
- [Decryptx WebSockets API](https://developers.bluefin.com/decryptx/docs/decryptx-websockets-api.md)
- [Welcome to P2PE Manager®](https://developers.bluefin.com/decryptx/docs/overview.md): Manage your P2PE payment terminals using the online portal for Bluefin's PCI compliant P2PE Decryption as a Service (DaaS) solution.
- [P2PE Manager APIs](https://developers.bluefin.com/decryptx/docs/api-guides.md): Integrate software services with the P2PE Manager Application using the APIs
- [Authentication](https://developers.bluefin.com/decryptx/docs/api-authentication-1.md): An introduction to the different API authentication methods used with Bluefin's P2PE Manager.
- [KIF User Guide to the Management APIs](https://developers.bluefin.com/decryptx/docs/kif-user-guide-to-the-management-apis.md): A guide for Key Injection Facilities (KIFs), the first point of interaction on the P2PE chain of custody.
- [Partner User Guide to Management APIs](https://developers.bluefin.com/decryptx/docs/management-apis-for-partner-users.md): Integrate P2PE Manager functionality with your client's platforms and/or services using the Management API.
- [Transaction API Guide](https://developers.bluefin.com/decryptx/docs/transactions-api.md): Track your decryption activity on P2PE Manager using the Management API's Transaction endpoints.
- [Distribution Channel API Guide](https://developers.bluefin.com/decryptx/docs/distribution-channel-api-guide.md): A guide to the API calls required to move a P2PE device from a Key Injection Facility (KIF) to a client via a distribution channel.
- [Custody API Guide](https://developers.bluefin.com/decryptx/docs/custody-api-guide.md): How the P2PE Manager assists merchants by facilitating the chain of custody transfers required for PCI compliance.
- [Role-Based Access Control](https://developers.bluefin.com/decryptx/docs/role-based-access.md): Understand the capabilities of your role type and leverage role-based access control to manage your users' privileges within P2PE Manager.
- [Bluefin Supported PCI-Validated P2PE Devices](https://developers.bluefin.com/decryptx/docs/certified-p2pe-devices.md): Learn more about Bluefin's large selection of PCI-validated P2PE devices.
- [Single Sign-On in P2PE Manager](https://developers.bluefin.com/decryptx/docs/single-sign-on-sso.md)
- [Single Sign-on FAQ](https://developers.bluefin.com/decryptx/docs/frequently-asked-questions.md): How to set up Single Sign-on in Bluefin's P2PE Manager.
- [P2PE Manager and ServiceNow Integration](https://developers.bluefin.com/decryptx/docs/p2pe-manager-and-servicenow-integration.md): The ServiceNow integration enables businesses to utilize Bluefin’s P2PE Manager natively from ServiceNow.
- [Managing Device Swaps](https://developers.bluefin.com/decryptx/docs/device-swap-feature.md)
- [Getting Started](https://developers.bluefin.com/decryptx/docs/p2pe-manager-user-guide.md)
- [Dashboard](https://developers.bluefin.com/decryptx/docs/dashboards.md)
- [Using the Side Navigation](https://developers.bluefin.com/decryptx/docs/using-the-side-navigation.md)
- [Administration](https://developers.bluefin.com/decryptx/docs/administration.md)
- [Device Management](https://developers.bluefin.com/decryptx/docs/device-management.md)
- [Receive and Activate Your Device](https://developers.bluefin.com/decryptx/docs/receiving-and-activating-your-device.md)
- [Batch Receive Devices](https://developers.bluefin.com/decryptx/docs/batch-receiving-devices.md)
- [Receiving Devices with Specific Serial Number Requirements](https://developers.bluefin.com/decryptx/docs/receiving-devices-with-specific-serial-number-requirements.md)
- [Attestations](https://developers.bluefin.com/decryptx/docs/attestations-1.md)
- [Transactions](https://developers.bluefin.com/decryptx/docs/transactions-1.md)
- [Device Reports](https://developers.bluefin.com/decryptx/docs/reports.md)
- [Transaction Reports](https://developers.bluefin.com/decryptx/docs/transaction-reports.md)
- [Key Injection Facility (KIF) User Guide](https://developers.bluefin.com/decryptx/docs/key-injection-facility-kif-user-guide.md)
- [Administration](https://developers.bluefin.com/decryptx/docs/administration-1.md)
- [Devices](https://developers.bluefin.com/decryptx/docs/creating-devices.md)
- [Shipping Devices](https://developers.bluefin.com/decryptx/docs/shipping-devices.md)
- [Completing Equipment Requests](https://developers.bluefin.com/decryptx/docs/completing-equipment-requests.md)
- [Return Merchandise Authorization (RMA) Process](https://developers.bluefin.com/decryptx/docs/return-merchandise-authorization-rma-process.md)
- [Using Test Mode](https://developers.bluefin.com/decryptx/docs/using-test-mode.md)

## API Reference
- [Validate a Partner](https://developers.bluefin.com/decryptx/reference/validatepartner.md): This endpoint allows a partner to validate their credentials.
- [Validate a Device](https://developers.bluefin.com/decryptx/reference/validatedevice.md): This endpoint allows a partner to validate that a device is correctly registered on Decryptx and that it is functional.
- [Decrypt P2PE data](https://developers.bluefin.com/decryptx/reference/decrypt.md): This allows a partner to decrypt P2PE data from a device. Up to 100 values can be decrypted in a single call. However, it should be noted that a response will only be returned once all values are decrypted and all values to decrypt must belong to a single device. In JSON, the encrypted property contains an array of objects with name/value properties indicating the values that are to be decrypted. The response will contain an array with the same names in the same order they were submitted and their corresponding decrypted values or individual error information if the data could not be decrypted. If at least one of the values can be decrypted, the overall response will indicate a success, but an error code and message will be provided where there are failures. The API response will only indicate a failure when all decryptions fail.
- [Decrypt External Data](https://developers.bluefin.com/decryptx/reference/decrypt-external.md): In "P2PE Manager Only" mode, this API endpoint lets partners use their own P2PE Solution for decryption, with data posted directly to P2PE Manager as the system of record instead of through Bluefin’s decryption system.
- [Healthcheck method](https://developers.bluefin.com/decryptx/reference/healthcheck-2.md): Healthcheck method
- [List all Users](https://developers.bluefin.com/decryptx/reference/list-users.md): This endpoint returns a summarised list of all Users assigned to a Partner's account. To view a User's complete dataset, a call must be made to the get a single User endpoint. By default, Users from sub-partner accounts are automatucally included. A partner can lookup a Client's Users by including the client id or name as a request parameter. Other filters will limit the Users in the response by Partner or KIF. Use the *'skip'* and *'take'* parameters to implement pagination.
- [Create a User](https://developers.bluefin.com/decryptx/reference/create-user.md): This endpoint creates a User for either a Partner, a KIF, or a Client. To create a User for a KIF, a reference to the KIF must be included in the API call, to create a user for a Client, both the Partner and Client references must be included.
- [Get a single User](https://developers.bluefin.com/decryptx/reference/get-user.md): This endpoint returns an object that contains all the User's details.
- [Delete a User](https://developers.bluefin.com/decryptx/reference/delete-user.md): This endpoint deletes a User resource. Deleting User reources is only possible if the User has not logged into the P2PE Manger. If the User resource is sucessfully deleted the response body will contain an empty object.
- [Update a User](https://developers.bluefin.com/decryptx/reference/update-user.md): This endpoint updates an existing User resource. It is not neccessary to include the complete replacement object in the API call; an object containing the properties that are to be changed will suffice.
- [List all Partners](https://developers.bluefin.com/decryptx/reference/list-partners.md): This endpoint returns a summarised list of Partners and Sub-Partners. The list of partners can be filtered by including the partner ID in the request parameters. When a KIF user makes an API call to this endpoint, the complete list of Partners are returned. However, when a Partner User makes the same API call, the results are restriced to their Partner account and Sub-Partners.
- [Create a Partner](https://developers.bluefin.com/decryptx/reference/create-partner.md): This will let a Partner create a (sub) Partner. When creating a Partner, a contact and location must also be created. A parent Partner account must also be referenced.
- [Get a single Partner](https://developers.bluefin.com/decryptx/reference/get-partner.md): This endpoint returns an object that contains all the Partner's details.
- [Update a Partner](https://developers.bluefin.com/decryptx/reference/update-partner.md): This endpoint updates an existing Partner resource. It is not neccessary to include the complete replacement object in the API call; an object containing the properties that are to be changed will suffice.
- [List all Clients](https://developers.bluefin.com/decryptx/reference/list-clients.md): This endpoint returns a summarised list of Clients. The list of Clients can be filtered by including the partner ID in the request parameters.
- [Create a Client](https://developers.bluefin.com/decryptx/reference/create-client.md): This endpoint allows a Partner create a Client resource. When creating a Client, a contact and location must also be created. A parent or direct Partner account must also be referenced.
- [Get a single Client](https://developers.bluefin.com/decryptx/reference/get-client.md): This endpoint returns an object that contains all the Client's details.
- [Delete a Client](https://developers.bluefin.com/decryptx/reference/delete-client.md): This endpoint deletes a User resource. Deleting a Client resource is only possible if no devices have been shipped/deployed to the Client. Once a Client has a device history, their deletion is not possible.
- [Update a Client](https://developers.bluefin.com/decryptx/reference/update-client.md): This endpoint updates an existing Client resource. It is not neccessary to include the complete replacement object in the API call; an object containing the properties that are to be changed will suffice.
- [Get all Locations](https://developers.bluefin.com/decryptx/reference/list-location.md): This endpoint returns a List of Locations. The list can be filtered by Client.
- [Create a Location](https://developers.bluefin.com/decryptx/reference/create-location.md): This endpoint allows a Partner user create a Location for a Client.
- [Read a Location](https://developers.bluefin.com/decryptx/reference/get-location.md): This endpoint returns a single Location.
- [Delete a Location](https://developers.bluefin.com/decryptx/reference/delete-location.md): This endpoint deletes a Location resource. Deleting a Location is only possible if no devices have been shipped/deployed to that Location. Once a Location has a device history, it cannot be deleted.
- [Update a Location](https://developers.bluefin.com/decryptx/reference/update-location.md): This endpoint updates an existing Location resource. It is not neccessary to include the complete replacement object in the API call; an object containing the properties that are to be changed will suffice. For example, this endpoint can be used to change the Location affiliated with a particular Client.
- [List all Shipments](https://developers.bluefin.com/decryptx/reference/list-shipments.md): This endpoint returns a list of Shipments.
- [Create a Shipment](https://developers.bluefin.com/decryptx/reference/create-shipment.md): This endpoint creates a Shipment. It is utilized by the KIF user when shipping Devices to a Client. The shipment can contain multiple Devices. Each Device will have its tamper label and serial recorded as part of the shipment.
- [Get a single Shipment](https://developers.bluefin.com/decryptx/reference/get-shipment.md): This endpoint returns a single Shipment.
- [Update a Shipment](https://developers.bluefin.com/decryptx/reference/update-shipment.md): This endpoint updates an existing Shipment resource. It allows the KIF user to update the carriers tracking number and the shipping date. This endpoint is designed to allow a KIF to update a shipment's details before it is shipped. It is not designed for a Client to record their receiving of a shipment. That can only be performed on the P2PE Manager GUI.
- [List all Attestation](https://developers.bluefin.com/decryptx/reference/list-attestations.md): This endpoint lists Attestations based upon the filter criteria.
- [Create an Attestation](https://developers.bluefin.com/decryptx/reference/create-attestation.md): Allows the partner to POST information to the P2PE Manager.  This will allow the Partner to build an attestation UI for their Clients (Merchants).
- [Get a single Attestation](https://developers.bluefin.com/decryptx/reference/get-attestation.md): This will return the detailed information on any individual attestation.
- [List all Transactions](https://developers.bluefin.com/decryptx/reference/list-transactions.md): This endpoint returns a list of Transactions. The list can be filtered by a number of Transaction properties.  By default the paging.mode is set to nocount, this means that the list total count will not be included in the response. Setting the paging.mode parameter to full will enable the total count. However, we urge Partners to exercise caution when including the total count on the Transaction list endpoint. The total number of Transactions can grow significantly and counting them can become taxing on the system. Paging.mode full is likely to result in high latency, therefore we suggest that you adopt a pagination strategy that does not require the total count.
- [Create a Transaction](https://developers.bluefin.com/decryptx/reference/create-transaction.md): This endpoint creates a Transaction. It should only be used when decryption activity occurs outside of the Decryptx platform. Certain Partners may operate their own Validated P2PE decryption environment (Domain 5). This allows the partner to journal their decryption activity into the P2PE Manager, allowing the Partner to utilize the P2PE Manager for their device management and chain of custody. The Partner's Client can still benefit from the device management, chain of custody, and historical decryption activity even when decryptions occur outside of the Decryptx system.
- [Get a single Transaction](https://developers.bluefin.com/decryptx/reference/get-transaction.md): Return information about a specific decryption record.
- [Update a Transaction](https://developers.bluefin.com/decryptx/reference/update-transaction.md): This endpoint updates an existing Transaction resource.
- [List all Devices](https://developers.bluefin.com/decryptx/reference/list-devices.md): This endpoint returns a list of Devices. This endpoint can be returned. Some Devices will only appear for certain types of Users if they are in a particular state. For example, when a KIF user makes this API call, a Device will be included in the response list if its deviceState is set to *'Unassigned'*, *'Assigned'*, or *'Injected'*. Once it is received by the merchant and its deviceState is set to *'Stored'* or *'Activating'*, the Device will no longer appear on the GET all devices response for the KIF user.  The list of Devices can be filtered by the Partner, Client, KIF, and the Device's state. Use the *'skip'* and *'take'* parameters to implement pagination.
- [Create a Device](https://developers.bluefin.com/decryptx/reference/create-device.md): This endpoint creates a Device. Due to the chain-of-custody rules Devices are typically created by the KIF user. The serial number of the device, the device type, the Partner, the Client, the injection key, and the firmware can be specified at device creation.
- [Get a Device by Serial & Type](https://developers.bluefin.com/decryptx/reference/get-device-by-serial-type.md): This endpoint returns a single Device by the serial number and type.
- [Get a Device by ID](https://developers.bluefin.com/decryptx/reference/get-device.md): This endpoint returns a single Device.
- [Update a Device](https://developers.bluefin.com/decryptx/reference/update-device.md): This endpoint updates an existing Device resource. It is not neccessary to include the complete replacement object in the API call; an object containing the properties that are to be changed will suffice. For example, this endpoint can be used to change a Device's state from 'injected' to 'inTransit'.
- [Activate RKI Devices](https://developers.bluefin.com/decryptx/reference/activate-rki-device.md): This endpoint activates RKI devices. The serial number of the device and matching device build must be provided.
- [Receive Devices](https://developers.bluefin.com/decryptx/reference/receive-device.md): This endpoint is used to receive shipped devices. The serial number of the device and tamper label must be provided.
- [List all Inject Keys](https://developers.bluefin.com/decryptx/reference/list-injectkeys.md): This endpoint returns a summarised list of InjectKeys. The list will contain each Key's ID, name, is active and is P2PE status.
- [Get a single Inject Key](https://developers.bluefin.com/decryptx/reference/get-injectkey.md): This endpoint returns a single Inject Key.
- [List all Device Types](https://developers.bluefin.com/decryptx/reference/list-devicetypes.md): This endpoint lists all Device Types.
- [Get a single Device Type](https://developers.bluefin.com/decryptx/reference/get-devicetype.md): This endpoint returns a single DeviceType. It is intended for use by KIFs or Partners that are using the P2PE Manager to identify the details of a device type to utilize for a specific device.
- [Proxy for decryption api.](https://developers.bluefin.com/decryptx/reference/decrypt-data.md): This endpoint decrypts incoming data via the decryption apis.
- [List device builds.](https://developers.bluefin.com/decryptx/reference/list-devicebuilds.md): This endpoint returns a list of device build names and their ID.
- [List a single Device Build](https://developers.bluefin.com/decryptx/reference/get-devicebuild.md): This endpoint returns an object that contains all the Device Build's details.
- [List a Device's Custody entries.](https://developers.bluefin.com/decryptx/reference/list-custody.md): This endpoint returns a list of device's custody entries for a single device. The device serial numuber and type must be specified in the path.
- [Create a Device Custody entry.](https://developers.bluefin.com/decryptx/reference/create-custody.md): Allows the partner to POST information to the P2PE Manager.  This will allow the Partner to create device custody in order to change location or custodian.
- [Get a Device Custody entry.](https://developers.bluefin.com/decryptx/reference/get-custody.md): Return information about a specific device custody record.
- [Lists all Device States.](https://developers.bluefin.com/decryptx/reference/list-devicestates.md): This endpoint return the list of device state names and their ID.
- [Lists all KIFs.](https://developers.bluefin.com/decryptx/reference/list-kifs.md): This endpoint returns a list of KIF names and their ID.
- [Lists Devices shared to a partner.](https://developers.bluefin.com/decryptx/reference/list-shared-devices.md): This endpoint returns a list of Devices that have been shared with given Partner.
- [Shares devices with a partner.](https://developers.bluefin.com/decryptx/reference/create-virtual-device.md): This endpoint shares a list of devices to the specified partner.
- [Unshares Devices with a Partner.](https://developers.bluefin.com/decryptx/reference/delete-virtual-device.md): This endpoint unshares a list of devices to the specified partner.

## Changelog
- [Decryptx v.6.7.0 - 05.27.26](https://developers.bluefin.com/decryptx/changelog/decryptx-v670-052726.md)
- [Decryptx v.6.5.0 - 02.10.2026](https://developers.bluefin.com/decryptx/changelog/decryptx-v650-02102016.md)
- [Decryptx v.6.4.0 - 12.04.2025](https://developers.bluefin.com/decryptx/changelog/decryptx-v640-12042025.md)
- [Decryptx v.6.3.0 - 10.16.2025](https://developers.bluefin.com/decryptx/changelog/decryptx-v630-10142025.md)
- [Decryptx v.6.2.0 - 08.07.2025](https://developers.bluefin.com/decryptx/changelog/decryptx-v620-08072025.md)


# ShieldConex Documentation

> Welcome to the Bluefin Developer Portal where you will find API references, payment and data security guides, and more.

## Guides
- [Tokenization Explained](https://developers.bluefin.com/shieldconex/docs/shieldconex-overview.md): Learn more about Bluefin's Vault-less Tokenization Solution – ShieldConex
- [Implementation Options](https://developers.bluefin.com/shieldconex/docs/implementation-options.md): Get an overview of the different ways you can implement ShieldConex.
- [The ShieldConex API](https://developers.bluefin.com/shieldconex/docs/api-guides-1.md): Learn about what calls are available and how to use them
- [API Authentication](https://developers.bluefin.com/shieldconex/docs/api-authentication.md): Learn how to implement API Authentication so you can start making calls
- [ShieldConex WebSockets API](https://developers.bluefin.com/shieldconex/docs/shieldconex-websockets-api.md)
- [iFrame SDK & Tokenization](https://developers.bluefin.com/shieldconex/docs/implementation-guide.md): Devalue the data you store by tokenizing it with the ShiedConex API
- [API Tokenization](https://developers.bluefin.com/shieldconex/docs/api-tokenization-1.md)
- [Data Retrieval](https://developers.bluefin.com/shieldconex/docs/data-retrieval.md)
- [Sharing Tokens](https://developers.bluefin.com/shieldconex/docs/sharing-tokens.md)
- [ShieldConex® Network Tokens](https://developers.bluefin.com/shieldconex/docs/shieldconex-network-tokens.md): ShieldConex Network Tokens Documentation and API Examples
- [Bluefin® API Playground](https://developers.bluefin.com/shieldconex/docs/api-playground.md): Playground for Bluefin APIs for everyone!
- [Introduction](https://developers.bluefin.com/shieldconex/docs/introduction-1.md)
- [API Endpoint Overview](https://developers.bluefin.com/shieldconex/docs/api-endpoint-overview.md): End-point definitions for the ShieldConex® Management
- [API Authentication](https://developers.bluefin.com/shieldconex/docs/api-authentication-1.md)
- [Managing Partners](https://developers.bluefin.com/shieldconex/docs/managing-partners.md)
- [Managing Clients](https://developers.bluefin.com/shieldconex/docs/managing-clients.md)
- [Managing Users](https://developers.bluefin.com/shieldconex/docs/managing-users.md)
- [Managing Templates](https://developers.bluefin.com/shieldconex/docs/managing-templates.md)
- [About the ShieldConex Management API](https://developers.bluefin.com/shieldconex/docs/about-the-shieldconex-manager-apis.md)
- [Introduction](https://developers.bluefin.com/shieldconex/docs/introduction.md)
- [API Authentication](https://developers.bluefin.com/shieldconex/docs/api-authentication-2.md)
- [Getting Started](https://developers.bluefin.com/shieldconex/docs/getting-started.md)
- [ORCA Credentials Vault](https://developers.bluefin.com/shieldconex/docs/orca-credentials-vault.md): ORCA Credentials Vault
- [Example Use Cases](https://developers.bluefin.com/shieldconex/docs/example-use-case.md)
- [API Examples](https://developers.bluefin.com/shieldconex/docs/api-examples.md)
- [ORCA Request and Response Actions](https://developers.bluefin.com/shieldconex/docs/orca-request-and-response-actions.md)
- [ORCA Format Expressions](https://developers.bluefin.com/shieldconex/docs/orca-format-expressions.md): Transform <<glossary:P2PE>> Device Payload as required by the payment processor
- [References](https://developers.bluefin.com/shieldconex/docs/references.md)
- [First Time Users](https://developers.bluefin.com/shieldconex/docs/first-time-users.md): Log into ShieldConex Manager and get familiar with our dashboard
- [Administration](https://developers.bluefin.com/shieldconex/docs/administration.md): Manage settings, users, partners, and templates
- [Transactions](https://developers.bluefin.com/shieldconex/docs/transactions-1.md): View your transactions or download them via PDF or CSV
- [Reports](https://developers.bluefin.com/shieldconex/docs/reports.md): View and download reports based on your transactions and tokenizations
- [User Roles](https://developers.bluefin.com/shieldconex/docs/user-roles-1.md): Understand how permissions vary amongst user roles for both clients and partner orgs
- [Templates](https://developers.bluefin.com/shieldconex/docs/templates.md)

## API Reference
- [Validate Partner](https://developers.bluefin.com/shieldconex/reference/partner-validate.md): This API call can be used by the Partner to test connectivity to the ShieldConex platform. Upon proper authentication, a “success” is returned. This can be used by the Partner as an application “ping”.
- [Validate Template](https://developers.bluefin.com/shieldconex/reference/template-validate.md): This activity would be performed to validate that ShieldConex recognizes a partner’s template. This can be used by the Partner to ensure the template being referenced is in the ShieldConex system and provisioned correctly.
- [Tokenize Data](https://developers.bluefin.com/shieldconex/reference/tokenize.md): Provides the ability to tokenize data
- [Query Tokenized Data](https://developers.bluefin.com/shieldconex/reference/tokenize-read.md): Query previously tokenized data
- [Query and Delete Tokenized Data](https://developers.bluefin.com/shieldconex/reference/tokenize-delete.md): Query previously tokenized data and delete data from cache
- [Detokenize Data](https://developers.bluefin.com/shieldconex/reference/detokenize.md): Provides the ability to detokenize data
- [Healthcheck Tokenization](https://developers.bluefin.com/shieldconex/reference/healthcheck-tokenize.md): This activity would be performed to ensure that tokenization and detokenization are occurring properly for a given template
- [Healthcheck Detokenization](https://developers.bluefin.com/shieldconex/reference/healthcheck-detokenize.md): Healthcheck detokenize method
- [Tokenize Batch Data](https://developers.bluefin.com/shieldconex/reference/tokenize-batch.md): Provides the ability to tokenize batch data
- [Query Tokenized Batch Data](https://developers.bluefin.com/shieldconex/reference/tokenize-read-batch.md): Query previously tokenized batch data
- [Query and Delete Tokenized Batch Data](https://developers.bluefin.com/shieldconex/reference/tokenize-delete-batch.md): Query previously tokenized batch data and delete data from cache
- [Detokenization Batch Data](https://developers.bluefin.com/shieldconex/reference/detokenize-batch.md): Provides the ability to detokenize batch data
- [Create Network Token Bundle](https://developers.bluefin.com/shieldconex/reference/create-network-token-bundle.md)
- [Get Network Token Bundle](https://developers.bluefin.com/shieldconex/reference/get-network-token-bundle.md)
- [Delete Network Token Bundle](https://developers.bluefin.com/shieldconex/reference/delete-network-token-bundle.md)
- [Get Payment Credentials](https://developers.bluefin.com/shieldconex/reference/get-payment-credentials.md)
- [Get User List](https://developers.bluefin.com/shieldconex/reference/list-users.md): This endpoint returns a summarised list of all Users assigned to a Partner's account. To view a User's complete dataset, a call must be made to the get a single User endpoint. A partner can lookup a Client's Users by including the client id or name as a request parameter. Other filters will limit the Users in the response by Partner. Use the 'skip' and 'take' parameters to implement pagination.
- [Create a User](https://developers.bluefin.com/shieldconex/reference/create-user.md): This endpoint creates a User for either a Partner or a Client. To create a user for a Client, both the Partner and Client references must be included.
- [Get User Details](https://developers.bluefin.com/shieldconex/reference/get-user.md): This endpoint returns an object that contains all the User's details. In the case of the Client Level role, instead of returning the partner - it provides the client field as Client Level users cannot look into their clients' partners.
- [Update a User](https://developers.bluefin.com/shieldconex/reference/update-user.md): This endpoint updates an existing User resource. It is not neccessary to include the complete replacement object in the API call; an object containing the properties that are to be changed will suffice.
- [List Partners](https://developers.bluefin.com/shieldconex/reference/list-partners.md): This endpoint returns a summarised list of Partners and Sub-Partners. The list of partners can be filtered by including the partner ID in the request parameters. However, when a Partner User makes the same API call, the results are restriced to their Partner account and Sub-Partners.
- [Create a Partner](https://developers.bluefin.com/shieldconex/reference/create-partner.md): This will let a Partner create a (sub) Partner. Typically, this is an organization construct used to group Clients. For example, the Partner may want to create a (sub) Partner to group together 10 Clients so they are logically grouped for reporting purposes.
- [Get Partner Details](https://developers.bluefin.com/shieldconex/reference/get-partner.md): This call will return the detailed information about any Partner.
- [Update a Partner](https://developers.bluefin.com/shieldconex/reference/update-partner.md): This endpoint updates an existing Partner resource. It is not neccessary to include the complete replacement object in the API call; an object containing the properties that are to be changed will suffice.
- [List Clients](https://developers.bluefin.com/shieldconex/reference/list-clients.md): This endpoint returns a summarised list of Clients. The list of Clients can be filtered by including the partner ID in the request parameters.
- [Create a Client](https://developers.bluefin.com/shieldconex/reference/create-client.md): This endpoint allows a Partner to create a Client resource. When creating a Client, a contact and location must also be created. A direct Partner account must also be referenced.
- [Get CLient Details](https://developers.bluefin.com/shieldconex/reference/get-client.md): This endpoint returns an object that contains all the Client's details.
- [Delete a CLient](https://developers.bluefin.com/shieldconex/reference/delete-client.md): This endpoint deletes a Client resource.
- [Update a Client](https://developers.bluefin.com/shieldconex/reference/update-client.md): This endpoint updates an existing Client resource. It is not neccessary to include the complete replacement object in the API call; an object containing the properties that are to be changed will suffice.
- [List Transactions](https://developers.bluefin.com/shieldconex/reference/list-transactions.md): GET transactions will return summary information regarding transactions based upon filter criteria. For example, the Partner may wish to receive all tokenization transactions for a particular Client. By default the paging.mode is set to nocount, this means that the list total count will not be included in the response. Setting the paging.mode parameter to full will enable the total count. However, we urge Partners to exercise caution when including the total count on the Transaction list endpoint. The total number of Transactions can grow significantly and counting them can become taxing on the system. Paging.mode full is likely to result in high latency, therefore we suggest that you adopt a pagination strategy that does not require the total count.
- [Get Transaction Detials](https://developers.bluefin.com/shieldconex/reference/get-transaction.md): Return information about a specific record.
- [List Templates](https://developers.bluefin.com/shieldconex/reference/list-templates.md): GET templates will return templates based upon filter criteria.
- [Create a Template](https://developers.bluefin.com/shieldconex/reference/create-template.md): This endpoint allows to create Template.
- [Get Template Details](https://developers.bluefin.com/shieldconex/reference/get-template.md): This endpoint returns an object that contains all the Template's details.
- [Delete a Template](https://developers.bluefin.com/shieldconex/reference/delete-template.md): This endpoint deletes a Template resource. Deleting a Template resource is only possible if template hasn't been publiched yet
- [Update a Template](https://developers.bluefin.com/shieldconex/reference/update-template.md): This endpoint updates an existing Template resource. It is not neccessary to include the complete replacement object in the API call; an object containing the properties that are to be changed will suffice.
- [Clone a Template](https://developers.bluefin.com/shieldconex/reference/clone-template.md): This endpoint allows to clone Template.

## Changelog
- [ShieldConex® v1.20.3 - 5.5.2026](https://developers.bluefin.com/shieldconex/changelog/shieldconex-v1203-552026.md)
- [ShieldConex® v1.20.2 - 3.18.2026](https://developers.bluefin.com/shieldconex/changelog/shieldconex-v1202-3162026.md)
- [ShieldConex® v1.20.1 - 2.05.2026](https://developers.bluefin.com/shieldconex/changelog/shieldconex-v1201-1292026.md)
- [ShieldConex® v1.20.0 - 1.6.2026](https://developers.bluefin.com/shieldconex/changelog/shieldconex-v120-11132025.md)
- [ShieldConex® v1.19.3 - 10.29.2025](https://developers.bluefin.com/shieldconex/changelog/shieldconex-v1193-10292025.md)


# Payconex Documentation

> Welcome to the Bluefin Developer Portal where you will find API references, payment and data security guides, and more.

## Guides
- [Overview](https://developers.bluefin.com/payconex/docs/introduction.md): PayConex is Bluefin’s payment gateway, and can be used independently or integrated in multiple ways.
- [Using the PayConex™ APIs](https://developers.bluefin.com/payconex/docs/getting-started.md): An overview of the environments, endpoints, and requirements for utilizing the PayConex API Library.
- [Connecting to the API](https://developers.bluefin.com/payconex/docs/connecting-to-the-api.md): An overview of the different API environments and connection best practices.
- [Authentication](https://developers.bluefin.com/payconex/docs/authentication.md): An introduction to the different API authentication methods used with the PayConex API library.
- [Process Transactions](https://developers.bluefin.com/payconex/docs/process-transactions-ach-updates.md): A guide for using the PayConex API to process payments.
- [Create Reports](https://developers.bluefin.com/payconex/docs/reporting-service-api-rsapi.md): A guide to using the PayConex Reporting Services API to create transaction reports.
- [Schedule Transactions](https://developers.bluefin.com/payconex/docs/slapi-functions.md): A guide to using the Scheduling Layer API to create recurring payments.
- [Fetch Transaction Information](https://developers.bluefin.com/payconex/docs/tsapi-request-response-formats.md): A guide to using the Transaction Status API.
- [iFrame](https://developers.bluefin.com/payconex/docs/iframe.md): Learn how to use the PayConex secure iFrame.
- [Setup](https://developers.bluefin.com/payconex/docs/setup.md): Learn how to initialize the PayConex iFrame and start collecting payments.
- [iFrame Configuration](https://developers.bluefin.com/payconex/docs/iframe-configuration.md): Basic setup of the PayConex iFrame element.
- [Advanced Customization](https://developers.bluefin.com/payconex/docs/advanced-customization.md): Using custom CSS, font, and text options with the Payment iFrame.
- [JavaScript Reference](https://developers.bluefin.com/payconex/docs/javascript-reference.md): How to implement the constructor and call methods, and how to handle exceptions using the Payment iFrame JavaScript Library.
- [QSAPI Transaction](https://developers.bluefin.com/payconex/docs/qsapi-transaction.md)
- [Setting Masked Data](https://developers.bluefin.com/payconex/docs/setting-masked-data.md): Resetting the Payment iFrame to Process Complete Post-Transaction.
- [Computing Style](https://developers.bluefin.com/payconex/docs/computing-style.md): Setting font characteristics in the Payment iFrame.
- [Error Codes & Browser Support](https://developers.bluefin.com/payconex/docs/appendicies.md): The PayConex iFrame Appendix.
- [Hosted Payment Forms](https://developers.bluefin.com/payconex/docs/hosted-payment-forms.md): A guide to the PayConex Hosted Payment Form (HPF), a pre-built payment page that allows merchants to accept web payments securely and seamlessly.
- [Rendering the Hosted Payment Form](https://developers.bluefin.com/payconex/docs/hosted-payment-form-rendering.md): A guide to rendering the PayConex Hosted Payment Form (HPF) using default and custom form fields.
- [Response Handling](https://developers.bluefin.com/payconex/docs/response-handling.md): How the Hosted Payment Forms (HPF) module handles transaction responses.
- [Using Hash with Hosted Payment Forms](https://developers.bluefin.com/payconex/docs/using-hash-with-hosted-payment-forms.md): How to protect sensitive data with hashes in Hosted Payment Forms.
- [Securing your Hosted Payment Form](https://developers.bluefin.com/payconex/docs/securing-your-hosted-payment-form.md): Familiarize yourself with best practices to help mitigate fraud on hosted payment forms.
- [Using Reportable Fields](https://developers.bluefin.com/payconex/docs/using-reportable-fields.md): A guide on using Reportable Fields with Hosted Payment Forms
- [Apple Pay™](https://developers.bluefin.com/payconex/docs/apay-intro.md): An introduction to Apple Pay
- [Apple Pay Environment Setup](https://developers.bluefin.com/payconex/docs/getting-started-1.md)
- [Apple Pay Button Integration](https://developers.bluefin.com/payconex/docs/integrating-apple-pay.md): A guide on integrating the Apple Pay button on a webpage.
- [Using Apple Pay Tokens](https://developers.bluefin.com/payconex/docs/using-apple-pay-token.md): This guide will explain how to send a PayConex API request to process a transaction using an Apple Pay token.
- [Google Pay™](https://developers.bluefin.com/payconex/docs/google-pay.md)
- [Fraud Prevention](https://developers.bluefin.com/payconex/docs/fraud-prevention.md)
- [3D Secure](https://developers.bluefin.com/payconex/docs/3d-secure.md)
- [Bluefin 3D Secure SDK](https://developers.bluefin.com/payconex/docs/bluefin-3d-secure-sdk.md)
- [Server-Side 3DS Integration](https://developers.bluefin.com/payconex/docs/server-side-3ds-integration.md)
- [API Authentication](https://developers.bluefin.com/payconex/docs/api-authentication.md)
- [Fraud Scoring](https://developers.bluefin.com/payconex/docs/fraud-scoring-1.md)
- [Real-Time ACH Account Verification](https://developers.bluefin.com/payconex/docs/real-time-ach-account-verification.md)
- [MyChart® by Epic](https://developers.bluefin.com/payconex/docs/accepting-payments-with-mychart-by-epic.md)
- [Account Updater](https://developers.bluefin.com/payconex/docs/account-updater-1.md)
- [Merchant Setup](https://developers.bluefin.com/payconex/docs/merchant-setup.md)
- [Account Updater Batch Console](https://developers.bluefin.com/payconex/docs/account-updater-batch-console.md)
- [Bluefin Secure File Transfer Protocol (SFTP)](https://developers.bluefin.com/payconex/docs/bluefin-secure-file-transfer-protocol-sftp.md)
- [Merchant File Specifications](https://developers.bluefin.com/payconex/docs/merchant-file-specifications.md)
- [Getting Started](https://developers.bluefin.com/payconex/docs/account-updater-api-overview.md): An overview of the Account Updater API
- [API Authentication](https://developers.bluefin.com/payconex/docs/account-updater-authentication.md): A guide on authentication schemes for the Account Updater API.
- [API End-point Overview](https://developers.bluefin.com/payconex/docs/end-point-definitions.md): End-point definitions for the Account Updater API.
- [Using the Account Updater API](https://developers.bluefin.com/payconex/docs/account-updater-request-response-examples.md)
- [Getting Started](https://developers.bluefin.com/payconex/docs/getting-started-5.md)
- [Setting up and Managing Webhooks](https://developers.bluefin.com/payconex/docs/setting-up-and-managing-webhooks.md)
- [Creating Subscriptions](https://developers.bluefin.com/payconex/docs/creating-subscriptions.md)
- [Managing a Subscription](https://developers.bluefin.com/payconex/docs/managing-subscriptions.md): This article describes some actions that can be used to manage an existing account updater subscription.
- [Retrieving Card Updates](https://developers.bluefin.com/payconex/docs/retrieving-card-updates.md)
- [Welcome to QuickSwipe® Mobile](https://developers.bluefin.com/payconex/docs/introduction-to-quickswipe.md)
- [Accounts](https://developers.bluefin.com/payconex/docs/accounts.md): Learn how to make calls to our Accounts API for QuickSwipe Mobile.
- [Users](https://developers.bluefin.com/payconex/docs/users-1.md)
- [Items](https://developers.bluefin.com/payconex/docs/items.md)
- [Transactions](https://developers.bluefin.com/payconex/docs/transactions-2.md)
- [Tax Rates](https://developers.bluefin.com/payconex/docs/tax-rates.md)
- [Categories](https://developers.bluefin.com/payconex/docs/categories.md)
- [PayConex IP Address Ranges](https://developers.bluefin.com/payconex/docs/payconex-ip-addresses.md)
- [Chase Paymentech Test Cards](https://developers.bluefin.com/payconex/docs/chase-paymentech.md): Test Card Cases for Chase Paymentech
- [Elavon Test Cards](https://developers.bluefin.com/payconex/docs/elavon.md): Test card cases for Elavon
- [FIS Express Test Cards](https://developers.bluefin.com/payconex/docs/fis-express.md)
- [First Data Rapid Connect Test Cards](https://developers.bluefin.com/payconex/docs/first-data-rapid-connect.md): Test cases for First Data Rapid Connect
- [Restaurant Transaction Processing](https://developers.bluefin.com/payconex/docs/restaurant-transaction-processing.md)
- [Using Hashed Authentication](https://developers.bluefin.com/payconex/docs/using-hash.md)
- [Using Dynamic Descriptors](https://developers.bluefin.com/payconex/docs/using-dynamic-descriptors.md): Learn how to create and use PayConex's dynamic descriptor features.
- [Using PayConex With Twilio](https://developers.bluefin.com/payconex/docs/using-payconex-with-twilio.md)
- [ShieldConex on PayConex](https://developers.bluefin.com/payconex/docs/shieldconex-on-payconex.md)
- [Bulk Transaction Processing](https://developers.bluefin.com/payconex/docs/bulk-transaction-processing.md): An article reviewing PayConex bulk transaction processing
- [EMV Data](https://developers.bluefin.com/payconex/docs/emv-data-1.md)
- [Transparent Redirect](https://developers.bluefin.com/payconex/docs/transparent-redirect.md)
- [AJAX/CORS Support](https://developers.bluefin.com/payconex/docs/ajaxcors-support.md)
- [POSTback](https://developers.bluefin.com/payconex/docs/postback.md)
- [Handling Partial Authorizations](https://developers.bluefin.com/payconex/docs/handling-partial-authorizations.md)
- [Point to Point Encryption](https://developers.bluefin.com/payconex/docs/point-to-point-encryption.md)
- [Best Practices](https://developers.bluefin.com/payconex/docs/best-practices.md)
- [Level 2 Transaction Processing](https://developers.bluefin.com/payconex/docs/level-2-transaction-processing.md): Information on Level 2 transaction processing
- [Customer and Merchant Initiated Transactions](https://developers.bluefin.com/payconex/docs/customer-and-merchant-initiated-transactions.md): An overview of customer and merchant initiated transaction distinctions
- [PayConex API Key Management](https://developers.bluefin.com/payconex/docs/payconex-api-key-management.md): An overview of the PayConex API Key Management process
- [Using Level 3 Processing Profiles](https://developers.bluefin.com/payconex/docs/using-level-iii-processing-profiles.md): A guide on Level 3 processing and PayConex Level 3 Profiles
- [Enabling 2FA on PayConex](https://developers.bluefin.com/payconex/docs/enabling-2fa-on-payconex.md): How to configure a PayConex account to use two-factor authentication
- [COPY Transaction Examples](https://developers.bluefin.com/payconex/docs/copy-transaction-examples.md): A guide for using the PayConex API to copy existing transactions between agent and sub-accounts.
- [Getting Started](https://developers.bluefin.com/payconex/docs/getting-started-2.md)
- [Processing Credit Card Transactions](https://developers.bluefin.com/payconex/docs/processing-credit-card-transactions.md)
- [Processing Debit Transactions](https://developers.bluefin.com/payconex/docs/processing-debit-transactions.md)
- [Optional Processing](https://developers.bluefin.com/payconex/docs/optional-processing.md)
- [Receipts](https://developers.bluefin.com/payconex/docs/receipts.md)
- [Reports](https://developers.bluefin.com/payconex/docs/reports-2.md)
- [Batch](https://developers.bluefin.com/payconex/docs/batch.md)
- [Security](https://developers.bluefin.com/payconex/docs/security.md)
- [Web Sockets](https://developers.bluefin.com/payconex/docs/web-sockets.md)
- [Overview](https://developers.bluefin.com/payconex/docs/introduction-1.md): For semi-integrated solutions, bluefin provides clients with a local network websocket solution.
- [Terminal Requests](https://developers.bluefin.com/payconex/docs/processing-transactions-1.md)
- [Overview](https://developers.bluefin.com/payconex/docs/overview-1.md)
- [Accessing the BluePOS App](https://developers.bluefin.com/payconex/docs/accessing-the-bluepos-app.md)
- [Processing Transactions](https://developers.bluefin.com/payconex/docs/processing.md)
- [Business Settings](https://developers.bluefin.com/payconex/docs/business-settings.md): Configure prompts and Transactions Settings
- [Prompts](https://developers.bluefin.com/payconex/docs/prompts.md)
- [Contactless Settings](https://developers.bluefin.com/payconex/docs/contactless-settings.md)
- [Manual Card Entry](https://developers.bluefin.com/payconex/docs/manual-card-entry.md)
- [Forced Transactions](https://developers.bluefin.com/payconex/docs/forced-transactions.md)
- [Receipts](https://developers.bluefin.com/payconex/docs/voiding-debit-card-transactions.md)
- [Reports](https://developers.bluefin.com/payconex/docs/reports-3.md): View end of day and detailed transactions reports.

## API Reference
- [List api keys](https://developers.bluefin.com/payconex/reference/listapikeys.md): List API Keys: Endpoint to list API Keys
- [Create api key](https://developers.bluefin.com/payconex/reference/createapikey.md): # 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  | **Scope**                              | **Description**                                    | |---------------------------------------|------------------------------------| | `pcx:account_updater:*`                |Perform all Account Updater actions                 | | `pcx:account_updater:results:*`        |Perform all Account Updater results actions         | | `pcx:account_updater:results:read`     |View Account Updater results                        | | `pcx:account_updater:schedules:create` |Create an Account Updater Schedule                  | | `pcx:account_updater:schedules:delete` |Delete an Account Updater Schedule                  | | `pcx:account_updater:schedules:patch`  |Update an Account Updater Schedule                  | | `pcx:account_updater:schedules:post`   |Add data to Account Updater Schedule                | | `pcx:admin:cache`                      |Interact with memory cache                          | | `pcx:admin:nats`                       |Interact with nats.io cluster                       | | `pcx:api_key:*`                        |Perform all API Key actions                         | | `pcx:api_key:create`                   |Create API Key                                      | | `pcx:api_key:delete`                   |Delete API Key                                      | | `pcx:api_key:read`                     |View API Key settings                               | | `pcx:api_key:update`                   |Update API Key settings                             | | `pcx:api_key_scopes:read`              |Read 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:create`         |Create an Apple Pay Account                         | | `pcx:apple_pay:account:view`           |View an Apple Pay Account settings                  | | `pcx:apple_pay:session:get`            |Fetch an ApplePay session                           | | `pcx:auth:bearer:*`                    |Issue user bearer tokens                            | | `pcx:auth:pointconex-bearer`           |Issue a bearer token for the PointConex app         | | `pcx:auth:pointconex-pos-bearer`       |Issue a bearer token for a PointConex POS           | | `pcx:auth:token`                       |Issue a bearer token for a Authentication           | | `pcx:auth:wssg-admin-bearer`           |Issue a bearer token to WSSG Admins                 | | `pcx:batch:manual-settlement`          |Manual Batch Settlement Trigger                     | | `pcx:card_bins:*`                      |Perform all Card Bins actions                       | | `pcx:card_bins:read`                   |Fetch a list of a Card Bins                         | | `pcx:detokenize:ach:create`            |Detokenize ach data                                 | | `pcx:detokenize:card:create`           |Detokenize card data                                | | `pcx:detokenize:gpay:create`           |Detokenize Gpay data                                | | `pcx:device_profile:read`              |Read Device Profile                                 | | `pcx:devices:*`                        |Perform all Devices actions                         | | `pcx:devices:create`                   |Create a Device                                     | | `pcx:devices:delete`                   |Delete a Device                                     | | `pcx:devices:read`                     |Fetch a list or a single Device                     | | `pcx:devices:update`                   |Update a Device details                             | | `pcx:dynamic_descriptors:*`            |Perform all Dynamic Descriptor actions              | | `pcx:dynamic_descriptors:create`       |Create a Dynamic Descriptor                         | | `pcx:dynamic_descriptors:delete`       |Delete a Dynamic Descriptor                         | | `pcx:dynamic_descriptors:read`         |View a Dynamic Descriptor details                   | | `pcx:dynamic_descriptors:update`       |Update a Dynamic Descriptor                         | | `pcx:epic_payment_page:*`              |Perform all epic payment page                       | | `pcx:epic_payment_page:complete`       |Complete epic payment page transaction              | | `pcx:epic_payment_page:init`           |Initialize payment page transaction                 | | `pcx:epic_payment_page:trace`          |Consumes Debug information related to epic payment page transaction| | `pcx:epic_payment_page_config:*`       |Perform all epic payment page config                | | `pcx:epic_payment_page_config:create`  |Create epic payment page config                     | | `pcx:epic_payment_page_config:delete`  |Delete epic payment page config                     | | `pcx:epic_payment_page_config:read`    |Fetch payment page config                           | | `pcx:epic_payment_page_config:update`  |Update epic payment page config                     | | `pcx:iframe:*`                         |Perform all secure iframe checkout related actions  | | `pcx:iframe:create`                    |Create a secure iframe checkout                     | | `pcx:iframe:delete`                    |Delete a secure iframe checkout                     | | `pcx:iframe:instance:*`                |Perform all secure iframe checkout instance actions | | `pcx:iframe:instance:create`           |Create a secure iframe checkout instance            | | `pcx:iframe:instance:read`             |View a secure iframe checkout instance details      | | `pcx:iframe:instance:tokenize-ach`     |Tokenize ACH Payment details                        | | `pcx:iframe:instance:tokenize-card`    |Tokenize Card Payment details                       | | `pcx:iframe:instance:tokenize-ctp`     |Tokenize Mastercard Click To Pay details            | | `pcx:iframe:instance:tokenize-gpay`    |Tokenize Google Payment details                     | | `pcx:iframe:read`                      |View a secure iframe checkout details               | | `pcx:iframe:update`                    |Update a secure iframe checkout settings            | | `pcx:level3_profiles:*`                |Perform all Level3 Profile actions                  | | `pcx:level3_profiles:create`           |Create a Level3 Profile                             | | `pcx:level3_profiles:delete`           |Delete a Level3 Profile                             | | `pcx:level3_profiles:read`             |Fetch a list or a single Level3 Profile             | | `pcx:level3_profiles:update`           |Update a Level3 Profile details                     | | `pcx:payments:*`                       |Perform all Payment related actions                 | | `pcx:payments:ach:*`                   |Process ACH Payments                                | | `pcx:payments:ach:refund`              |Process ACH Refunds                                 | | `pcx:payments:ach:sale`                |Process ACH Sale Payments                           | | `pcx:payments:ach:store`               |Process ACH Store Payments                          | | `pcx:payments:capture`                 |Capture an Authorization                            | | `pcx:payments:card_not_present:*`      |Process Card Not Present Payments                   | | `pcx:payments:card_not_present:auth`   |Process Card Not Present Auth transactions          | | `pcx:payments:card_not_present:credit` |Process Card Not Present Credit transactions        | | `pcx:payments:card_not_present:force`  |Process Card Not Present Force transactions         | | `pcx:payments:card_not_present:sale`   |Process Card Not Present Sale transactions          | | `pcx:payments:card_not_present:store`  |Process Card Not Present Store transactions         | | `pcx:payments:create`                  |Initialize a Payment                                | | `pcx:payments:device:*`                |Process Device Payments                             | | `pcx:payments:device:auth`             |Process Device Auth transactions                    | | `pcx:payments:device:credit`           |Process Device Credit transactions                  | | `pcx:payments:device:force`            |Process Device Force transactions                   | | `pcx:payments:device:sale`             |Process Device Sale transactions                    | | `pcx:payments:device:store`            |Process Device Store transactions                   | | `pcx:payments:read`                    |View Payment Details                                | | `pcx:payments:refund`                  |Refund a Payment                                    | | `pcx:payments:twilio`                  |Process a twillio Payment                           | | `pcx:payments:update`                  |Update a Payment                                    | | `pcx:pointconex:*`                     |Send all PointConex commands                        | | `pcx:pointconex:auth`                  |Send a auth command to a PointConex app             | | `pcx:pointconex:cancel`                |Send a cancel command to a PointConex app           | | `pcx:pointconex:credit`                |Send a credit command to a PointConex app           | | `pcx:pointconex:custom_print`          |Send a custom receipt print command to a PointConex app| | `pcx:pointconex:force`                 |Send a force command to a PointConex app            | | `pcx:pointconex:list_transactions`     |Send a list transaction command to a PointConex app | | `pcx:pointconex:poslink`               |Send a poslink command to a PointConex app          | | `pcx:pointconex:reboot`                |Send a reboot command to a PointConex app           | | `pcx:pointconex:refund`                |Send a refund transaction command to a PointConex app| | `pcx:pointconex:sale`                  |Send a sale command to a PointConex app             | | `pcx:pointconex:show_dialog`           |Send a show dialog command to a PointConex app      | | `pcx:pointconex:status`                |Send a status command to a PointConex app           | | `pcx:status:*`                         |Perform all Status related actions                  | | `pcx:status:nats`                      |View nats status details                            | | `pcx:three_d_secure:*`                 |3DS All Scopes                                      | | `pcx:three_d_secure:init:create`       |3DS Init Browser Authenticate                       | | `pcx:three_d_secure:no_scope`          |Un Authenticated API call                           | | `pcx:three_d_secure:status:read`       |3DS Status check                                    | | `pcx:tokenize:*`                       |Tokenize all types of payment data                  | | `pcx:tokenize:ach`                     |Tokenize ach data                                   | | `pcx:tokenize:card`                    |Tokenize card data                                  | | `pcx:webhooks:*`                       |Perform all Webhook related actions                 | | `pcx:webhooks:create`                  |Create a Webhook                                    | | `pcx:webhooks:delete`                  |Delete a Webhook                                    | | `pcx:webhooks:read`                    |View Webhook details                                | | `pcx:webhooks:trigger`                 |Trigger a Webhook                                   | | `pcx:webhooks:update`                  |Update a Webhook                                    |
- [Retrieve api key details](https://developers.bluefin.com/payconex/reference/getapikey.md): # 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  | **Scope**                              | **Description**                                    | |---------------------------------------|------------------------------------| | `pcx:account_updater:*`                |Perform all Account Updater actions                 | | `pcx:account_updater:results:*`        |Perform all Account Updater results actions         | | `pcx:account_updater:results:read`     |View Account Updater results                        | | `pcx:account_updater:schedules:create` |Create an Account Updater Schedule                  | | `pcx:account_updater:schedules:delete` |Delete an Account Updater Schedule                  | | `pcx:account_updater:schedules:patch`  |Update an Account Updater Schedule                  | | `pcx:account_updater:schedules:post`   |Add data to Account Updater Schedule                | | `pcx:admin:cache`                      |Interact with memory cache                          | | `pcx:admin:nats`                       |Interact with nats.io cluster                       | | `pcx:api_key:*`                        |Perform all API Key actions                         | | `pcx:api_key:create`                   |Create API Key                                      | | `pcx:api_key:delete`                   |Delete API Key                                      | | `pcx:api_key:read`                     |View API Key settings                               | | `pcx:api_key:update`                   |Update API Key settings                             | | `pcx:api_key_scopes:read`              |Read 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:create`         |Create an Apple Pay Account                         | | `pcx:apple_pay:account:view`           |View an Apple Pay Account settings                  | | `pcx:apple_pay:session:get`            |Fetch an ApplePay session                           | | `pcx:auth:bearer:*`                    |Issue user bearer tokens                            | | `pcx:auth:pointconex-bearer`           |Issue a bearer token for the PointConex app         | | `pcx:auth:pointconex-pos-bearer`       |Issue a bearer token for a PointConex POS           | | `pcx:auth:token`                       |Issue a bearer token for a Authentication           | | `pcx:auth:wssg-admin-bearer`           |Issue a bearer token to WSSG Admins                 | | `pcx:batch:manual-settlement`          |Manual Batch Settlement Trigger                     | | `pcx:card_bins:*`                      |Perform all Card Bins actions                       | | `pcx:card_bins:read`                   |Fetch a list of a Card Bins                         | | `pcx:detokenize:ach:create`            |Detokenize ach data                                 | | `pcx:detokenize:card:create`           |Detokenize card data                                | | `pcx:detokenize:gpay:create`           |Detokenize Gpay data                                | | `pcx:device_profile:read`              |Read Device Profile                                 | | `pcx:devices:*`                        |Perform all Devices actions                         | | `pcx:devices:create`                   |Create a Device                                     | | `pcx:devices:delete`                   |Delete a Device                                     | | `pcx:devices:read`                     |Fetch a list or a single Device                     | | `pcx:devices:update`                   |Update a Device details                             | | `pcx:dynamic_descriptors:*`            |Perform all Dynamic Descriptor actions              | | `pcx:dynamic_descriptors:create`       |Create a Dynamic Descriptor                         | | `pcx:dynamic_descriptors:delete`       |Delete a Dynamic Descriptor                         | | `pcx:dynamic_descriptors:read`         |View a Dynamic Descriptor details                   | | `pcx:dynamic_descriptors:update`       |Update a Dynamic Descriptor                         | | `pcx:epic_payment_page:*`              |Perform all epic payment page                       | | `pcx:epic_payment_page:complete`       |Complete epic payment page transaction              | | `pcx:epic_payment_page:init`           |Initialize payment page transaction                 | | `pcx:epic_payment_page:trace`          |Consumes Debug information related to epic payment page transaction| | `pcx:epic_payment_page_config:*`       |Perform all epic payment page config                | | `pcx:epic_payment_page_config:create`  |Create epic payment page config                     | | `pcx:epic_payment_page_config:delete`  |Delete epic payment page config                     | | `pcx:epic_payment_page_config:read`    |Fetch payment page config                           | | `pcx:epic_payment_page_config:update`  |Update epic payment page config                     | | `pcx:iframe:*`                         |Perform all secure iframe checkout related actions  | | `pcx:iframe:create`                    |Create a secure iframe checkout                     | | `pcx:iframe:delete`                    |Delete a secure iframe checkout                     | | `pcx:iframe:instance:*`                |Perform all secure iframe checkout instance actions | | `pcx:iframe:instance:create`           |Create a secure iframe checkout instance            | | `pcx:iframe:instance:read`             |View a secure iframe checkout instance details      | | `pcx:iframe:instance:tokenize-ach`     |Tokenize ACH Payment details                        | | `pcx:iframe:instance:tokenize-card`    |Tokenize Card Payment details                       | | `pcx:iframe:instance:tokenize-ctp`     |Tokenize Mastercard Click To Pay details            | | `pcx:iframe:instance:tokenize-gpay`    |Tokenize Google Payment details                     | | `pcx:iframe:read`                      |View a secure iframe checkout details               | | `pcx:iframe:update`                    |Update a secure iframe checkout settings            | | `pcx:level3_profiles:*`                |Perform all Level3 Profile actions                  | | `pcx:level3_profiles:create`           |Create a Level3 Profile                             | | `pcx:level3_profiles:delete`           |Delete a Level3 Profile                             | | `pcx:level3_profiles:read`             |Fetch a list or a single Level3 Profile             | | `pcx:level3_profiles:update`           |Update a Level3 Profile details                     | | `pcx:payments:*`                       |Perform all Payment related actions                 | | `pcx:payments:ach:*`                   |Process ACH Payments                                | | `pcx:payments:ach:refund`              |Process ACH Refunds                                 | | `pcx:payments:ach:sale`                |Process ACH Sale Payments                           | | `pcx:payments:ach:store`               |Process ACH Store Payments                          | | `pcx:payments:capture`                 |Capture an Authorization                            | | `pcx:payments:card_not_present:*`      |Process Card Not Present Payments                   | | `pcx:payments:card_not_present:auth`   |Process Card Not Present Auth transactions          | | `pcx:payments:card_not_present:credit` |Process Card Not Present Credit transactions        | | `pcx:payments:card_not_present:force`  |Process Card Not Present Force transactions         | | `pcx:payments:card_not_present:sale`   |Process Card Not Present Sale transactions          | | `pcx:payments:card_not_present:store`  |Process Card Not Present Store transactions         | | `pcx:payments:create`                  |Initialize a Payment                                | | `pcx:payments:device:*`                |Process Device Payments                             | | `pcx:payments:device:auth`             |Process Device Auth transactions                    | | `pcx:payments:device:credit`           |Process Device Credit transactions                  | | `pcx:payments:device:force`            |Process Device Force transactions                   | | `pcx:payments:device:sale`             |Process Device Sale transactions                    | | `pcx:payments:device:store`            |Process Device Store transactions                   | | `pcx:payments:read`                    |View Payment Details                                | | `pcx:payments:refund`                  |Refund a Payment                                    | | `pcx:payments:twilio`                  |Process a twillio Payment                           | | `pcx:payments:update`                  |Update a Payment                                    | | `pcx:pointconex:*`                     |Send all PointConex commands                        | | `pcx:pointconex:auth`                  |Send a auth command to a PointConex app             | | `pcx:pointconex:cancel`                |Send a cancel command to a PointConex app           | | `pcx:pointconex:credit`                |Send a credit command to a PointConex app           | | `pcx:pointconex:custom_print`          |Send a custom receipt print command to a PointConex app| | `pcx:pointconex:force`                 |Send a force command to a PointConex app            | | `pcx:pointconex:list_transactions`     |Send a list transaction command to a PointConex app | | `pcx:pointconex:poslink`               |Send a poslink command to a PointConex app          | | `pcx:pointconex:reboot`                |Send a reboot command to a PointConex app           | | `pcx:pointconex:refund`                |Send a refund transaction command to a PointConex app| | `pcx:pointconex:sale`                  |Send a sale command to a PointConex app             | | `pcx:pointconex:show_dialog`           |Send a show dialog command to a PointConex app      | | `pcx:pointconex:status`                |Send a status command to a PointConex app           | | `pcx:status:*`                         |Perform all Status related actions                  | | `pcx:status:nats`                      |View nats status details                            | | `pcx:three_d_secure:*`                 |3DS All Scopes                                      | | `pcx:three_d_secure:init:create`       |3DS Init Browser Authenticate                       | | `pcx:three_d_secure:no_scope`          |Un Authenticated API call                           | | `pcx:three_d_secure:status:read`       |3DS Status check                                    | | `pcx:tokenize:*`                       |Tokenize all types of payment data                  | | `pcx:tokenize:ach`                     |Tokenize ach data                                   | | `pcx:tokenize:card`                    |Tokenize card data                                  | | `pcx:webhooks:*`                       |Perform all Webhook related actions                 | | `pcx:webhooks:create`                  |Create a Webhook                                    | | `pcx:webhooks:delete`                  |Delete a Webhook                                    | | `pcx:webhooks:read`                    |View Webhook details                                | | `pcx:webhooks:trigger`                 |Trigger a Webhook                                   | | `pcx:webhooks:update`                  |Update a Webhook                                    |
- [Update an API Key](https://developers.bluefin.com/payconex/reference/updateapikey.md): # Update an API Key  Endpoint to update an API Key.   # Required Scopes The API Key calling this endpoint must have one of the following scopes: * `pcx:api_key:*` * `pcx:api_key:update` # Scope documentation  | **Scope**                              | **Description**                                    | |---------------------------------------|------------------------------------| | `pcx:account_updater:*`                |Perform all Account Updater actions                 | | `pcx:account_updater:results:*`        |Perform all Account Updater results actions         | | `pcx:account_updater:results:read`     |View Account Updater results                        | | `pcx:account_updater:schedules:create` |Create an Account Updater Schedule                  | | `pcx:account_updater:schedules:delete` |Delete an Account Updater Schedule                  | | `pcx:account_updater:schedules:patch`  |Update an Account Updater Schedule                  | | `pcx:account_updater:schedules:post`   |Add data to Account Updater Schedule                | | `pcx:admin:cache`                      |Interact with memory cache                          | | `pcx:admin:nats`                       |Interact with nats.io cluster                       | | `pcx:api_key:*`                        |Perform all API Key actions                         | | `pcx:api_key:create`                   |Create API Key                                      | | `pcx:api_key:delete`                   |Delete API Key                                      | | `pcx:api_key:read`                     |View API Key settings                               | | `pcx:api_key:update`                   |Update API Key settings                             | | `pcx:api_key_scopes:read`              |Read 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:create`         |Create an Apple Pay Account                         | | `pcx:apple_pay:account:view`           |View an Apple Pay Account settings                  | | `pcx:apple_pay:session:get`            |Fetch an ApplePay session                           | | `pcx:auth:bearer:*`                    |Issue user bearer tokens                            | | `pcx:auth:pointconex-bearer`           |Issue a bearer token for the PointConex app         | | `pcx:auth:pointconex-pos-bearer`       |Issue a bearer token for a PointConex POS           | | `pcx:auth:token`                       |Issue a bearer token for a Authentication           | | `pcx:auth:wssg-admin-bearer`           |Issue a bearer token to WSSG Admins                 | | `pcx:batch:manual-settlement`          |Manual Batch Settlement Trigger                     | | `pcx:card_bins:*`                      |Perform all Card Bins actions                       | | `pcx:card_bins:read`                   |Fetch a list of a Card Bins                         | | `pcx:detokenize:ach:create`            |Detokenize ach data                                 | | `pcx:detokenize:card:create`           |Detokenize card data                                | | `pcx:detokenize:gpay:create`           |Detokenize Gpay data                                | | `pcx:device_profile:read`              |Read Device Profile                                 | | `pcx:devices:*`                        |Perform all Devices actions                         | | `pcx:devices:create`                   |Create a Device                                     | | `pcx:devices:delete`                   |Delete a Device                                     | | `pcx:devices:read`                     |Fetch a list or a single Device                     | | `pcx:devices:update`                   |Update a Device details                             | | `pcx:dynamic_descriptors:*`            |Perform all Dynamic Descriptor actions              | | `pcx:dynamic_descriptors:create`       |Create a Dynamic Descriptor                         | | `pcx:dynamic_descriptors:delete`       |Delete a Dynamic Descriptor                         | | `pcx:dynamic_descriptors:read`         |View a Dynamic Descriptor details                   | | `pcx:dynamic_descriptors:update`       |Update a Dynamic Descriptor                         | | `pcx:epic_payment_page:*`              |Perform all epic payment page                       | | `pcx:epic_payment_page:complete`       |Complete epic payment page transaction              | | `pcx:epic_payment_page:init`           |Initialize payment page transaction                 | | `pcx:epic_payment_page:trace`          |Consumes Debug information related to epic payment page transaction| | `pcx:epic_payment_page_config:*`       |Perform all epic payment page config                | | `pcx:epic_payment_page_config:create`  |Create epic payment page config                     | | `pcx:epic_payment_page_config:delete`  |Delete epic payment page config                     | | `pcx:epic_payment_page_config:read`    |Fetch payment page config                           | | `pcx:epic_payment_page_config:update`  |Update epic payment page config                     | | `pcx:iframe:*`                         |Perform all secure iframe checkout related actions  | | `pcx:iframe:create`                    |Create a secure iframe checkout                     | | `pcx:iframe:delete`                    |Delete a secure iframe checkout                     | | `pcx:iframe:instance:*`                |Perform all secure iframe checkout instance actions | | `pcx:iframe:instance:create`           |Create a secure iframe checkout instance            | | `pcx:iframe:instance:read`             |View a secure iframe checkout instance details      | | `pcx:iframe:instance:tokenize-ach`     |Tokenize ACH Payment details                        | | `pcx:iframe:instance:tokenize-card`    |Tokenize Card Payment details                       | | `pcx:iframe:instance:tokenize-ctp`     |Tokenize Mastercard Click To Pay details            | | `pcx:iframe:instance:tokenize-gpay`    |Tokenize Google Payment details                     | | `pcx:iframe:read`                      |View a secure iframe checkout details               | | `pcx:iframe:update`                    |Update a secure iframe checkout settings            | | `pcx:level3_profiles:*`                |Perform all Level3 Profile actions                  | | `pcx:level3_profiles:create`           |Create a Level3 Profile                             | | `pcx:level3_profiles:delete`           |Delete a Level3 Profile                             | | `pcx:level3_profiles:read`             |Fetch a list or a single Level3 Profile             | | `pcx:level3_profiles:update`           |Update a Level3 Profile details                     | | `pcx:payments:*`                       |Perform all Payment related actions                 | | `pcx:payments:ach:*`                   |Process ACH Payments                                | | `pcx:payments:ach:refund`              |Process ACH Refunds                                 | | `pcx:payments:ach:sale`                |Process ACH Sale Payments                           | | `pcx:payments:ach:store`               |Process ACH Store Payments                          | | `pcx:payments:capture`                 |Capture an Authorization                            | | `pcx:payments:card_not_present:*`      |Process Card Not Present Payments                   | | `pcx:payments:card_not_present:auth`   |Process Card Not Present Auth transactions          | | `pcx:payments:card_not_present:credit` |Process Card Not Present Credit transactions        | | `pcx:payments:card_not_present:force`  |Process Card Not Present Force transactions         | | `pcx:payments:card_not_present:sale`   |Process Card Not Present Sale transactions          | | `pcx:payments:card_not_present:store`  |Process Card Not Present Store transactions         | | `pcx:payments:create`                  |Initialize a Payment                                | | `pcx:payments:device:*`                |Process Device Payments                             | | `pcx:payments:device:auth`             |Process Device Auth transactions                    | | `pcx:payments:device:credit`           |Process Device Credit transactions                  | | `pcx:payments:device:force`            |Process Device Force transactions                   | | `pcx:payments:device:sale`             |Process Device Sale transactions                    | | `pcx:payments:device:store`            |Process Device Store transactions                   | | `pcx:payments:read`                    |View Payment Details                                | | `pcx:payments:refund`                  |Refund a Payment                                    | | `pcx:payments:twilio`                  |Process a twillio Payment                           | | `pcx:payments:update`                  |Update a Payment                                    | | `pcx:pointconex:*`                     |Send all PointConex commands                        | | `pcx:pointconex:auth`                  |Send a auth command to a PointConex app             | | `pcx:pointconex:cancel`                |Send a cancel command to a PointConex app           | | `pcx:pointconex:credit`                |Send a credit command to a PointConex app           | | `pcx:pointconex:custom_print`          |Send a custom receipt print command to a PointConex app| | `pcx:pointconex:force`                 |Send a force command to a PointConex app            | | `pcx:pointconex:list_transactions`     |Send a list transaction command to a PointConex app | | `pcx:pointconex:poslink`               |Send a poslink command to a PointConex app          | | `pcx:pointconex:reboot`                |Send a reboot command to a PointConex app           | | `pcx:pointconex:refund`                |Send a refund transaction command to a PointConex app| | `pcx:pointconex:sale`                  |Send a sale command to a PointConex app             | | `pcx:pointconex:show_dialog`           |Send a show dialog command to a PointConex app      | | `pcx:pointconex:status`                |Send a status command to a PointConex app           | | `pcx:status:*`                         |Perform all Status related actions                  | | `pcx:status:nats`                      |View nats status details                            | | `pcx:three_d_secure:*`                 |3DS All Scopes                                      | | `pcx:three_d_secure:init:create`       |3DS Init Browser Authenticate                       | | `pcx:three_d_secure:no_scope`          |Un Authenticated API call                           | | `pcx:three_d_secure:status:read`       |3DS Status check                                    | | `pcx:tokenize:*`                       |Tokenize all types of payment data                  | | `pcx:tokenize:ach`                     |Tokenize ach data                                   | | `pcx:tokenize:card`                    |Tokenize card data                                  | | `pcx:webhooks:*`                       |Perform all Webhook related actions                 | | `pcx:webhooks:create`                  |Create a Webhook                                    | | `pcx:webhooks:delete`                  |Delete a Webhook                                    | | `pcx:webhooks:read`                    |View Webhook details                                | | `pcx:webhooks:trigger`                 |Trigger a Webhook                                   | | `pcx:webhooks:update`                  |Update a Webhook                                    |
- [Delete an API key](https://developers.bluefin.com/payconex/reference/deleteapikey.md): # Delete a single API key  Endpoint to delete an API key.   # Required Scopes The API Key calling this endpoint must have one of the following scopes: * `pcx:api_key:*` * `pcx:api_key:delete`
- [Lists API Key Scopes and their meta data](https://developers.bluefin.com/payconex/reference/listapikeyscopes.md): # Lists API Key Scopes This endpoint list the available API Key Scopes and their meta data.   # Required Scopes The API Key calling this endpoint must have one of the following scopes: * `pcx:api_key_scopes:read`
- [Init Bluefin 3ds with card details](https://developers.bluefin.com/payconex/reference/threedsecurebrowserauthinitwithcarddetailsid.md): # Bluefin 3ds   # Required Scopes The API Key calling this endpoint must have one of the following scopes: * `pcx:three_d_secure:init:create` * `pcx:three_d_secure:*`
- [Make Authorization Request](https://developers.bluefin.com/payconex/reference/threedsecurebrowserauthid.md): # Bluefin 3ds   # Required Scopes The API Key calling this endpoint must have one of the following scopes: * `pcx:three_d_secure:init:create` * `pcx:three_d_secure:*`
- [Make Authorization Request](https://developers.bluefin.com/payconex/reference/threedsecurestatusid.md): # Bluefin 3ds   # Required Scopes The API Key calling this endpoint must have one of the following scopes: * `pcx:three_d_secure:status:read` * `pcx:three_d_secure:*`

## Changelog
- [PayConex - 04.21.2026](https://developers.bluefin.com/payconex/changelog/payconex-04202026.md)
- [SaasConex - 02.26.2026](https://developers.bluefin.com/payconex/changelog/saasconex-02262026.md)
- [PayConex - 12.09.2025](https://developers.bluefin.com/payconex/changelog/payconex-12082025.md)
- [PayConex – 09.03.2025](https://developers.bluefin.com/payconex/changelog/payconex-08282025.md)
- [PayConex - 07.14.2025](https://developers.bluefin.com/payconex/changelog/payconex-07082025.md)