Integration Steps

This section contains the necessary (and recommended) steps to begin and complete your integration. It will help you navigate through the process, ensuring that you have all the essential components in place. By following these steps, you will be able to set up, configure and deploy your integration smoothly with the PayConex™ V4 API, addressing both mandatory requirements and best practices for optimal performance and security.

1. Account Setup

You must have a PayConex™ certification account before you can begin testing or integration.
- All preliminary development must be conducted and tested within the certification environment.
To gain access to a test account, contact our Integrations team at [email protected].

2. API Key Management

Generate and securely store your API keys. This can be done at login via the PayConex™ user interface.
After the first API key is created, you can use the endpoints to manage API keys for further operations.

3. API Authentication

Set up API authentication in your environment using your API keys.

4. Creating Iframe configuration and instance

To load the Checkout Component, the V4 API provides the payment-iframe endpoint, which securely generates a reusable bearerToken that expires in accordance with the configuration settings via timeout.
The iframe configurations and instances are customizable. You can specify allowedPaymentMethods, allowedParentDomains, payment settings and other options to tailor the payment form to meet your customers' needs, as outlined in Creating a Configuration and Creating an Instance.

5. Checkout Component Integration

Load the Checkout Component JavaScript SDK in your project.

📘
Note
This is the checkout component for the cert environment. See Checkout Component URLs for other environments.
```
<script src="https://cert.payconex.net/iframe-v2/iframe-v2.0.0.min.js"></script>
```
Implement the secure Checkout Component UI using the API and SDK with bearerToken.
Based on the payment method, confirm that the Checkout Component correctly handles and tokenizes payment data through testing. This can be done via the certification environment, for example: https://checkout-cert.payconex.net. Make sure to refer to the Testing & Go Live sections of each payment method.

6. Transaction Initialization

Implement endpoints for initializing transactions.
Test the transaction initialization process to ensure that it works as expected.
To follow these steps, see Initializing a Transaction.

7. Processing Transactions

Be sure to review the Point of Sale Profiles and select the right POS profiles for your business. Note that the device profile must also be specified for Card Present transactions. These profiles are required of the Payment Processor.
Implement endpoints to process credit card or ACH transactions using the tokenized payment data. That data is also known as a PayConex™ token for CNP transactions.
Verify that transactions are processed correctly and validate that all the response codes are returned correctly based on your needs and the payment processor you integrate with. For these test cards based on the payment processor, refer to Test Accounts, Cards, and Cases.

8. Transaction Management

Implement endpoints to retrieve transaction metadata.
Set up functionality for initializing transactions, issuing refunds, authorizations and captures.
Test transaction management features to ensure accurate and secure handling.

9. Testing

Conduct thorough testing in the certification environment.
Simulate various transaction scenarios to ensure reliability and security.
Perform end-to-end testing, from Checkout Component rendering to transaction completion.

10. Go Live

Work with the PayConex™ Integrations team to certify your integration.
After certification, work with our team on providing a production PayConex™ account.
- Provide API keys for your production PayConex™ account.
- Switch your integration so that it uses the production URLs and your production account's API key(s).
- Conduct a final round of testing in the live environment.
- Monitor transactions closely after going live to ensure everything functions smoothly.