Search K

Appearance

Technical Information ​

The process involves the merchant creating a payment intent using the API, which then directs the user to the Hosted Checkout Page (HCP) for secure card entry. The HCP confirms the payment with the API and redirects the user back to the merchant's website with the transaction result.

Access HCP & Live and Test Environments ​

’s Hosted Checkout Page (HCP) operates in two distinct environments:

  • Live Environment: Used for processing real transactions with actual payment details, ensuring all interactions are secure and reliable.
  • Test Environment: Designed for development and troubleshooting, enabling merchants to simulate transactions without incurring actual charges. This separation helps developers verify their integrations and functionality without risking real customer data or financial information.

Environments ​

  • Test Environment URL:
    https://test.checkout.us.payapex.com?client_id={acc_id}&intent_id={int_id}

  • Live Environment URL:
    https://checkout.us.payapex.com?client_id={acc_id}&intent_id={int_id}

HCP URL Variables ​

To access the Hosted Checkout Page (HCP) URL, you must provide two specific GET parameters: client_id and intent_id.

  • client_id: Represents the unique identifier assigned to the merchant’s account. This ensures the transaction is linked to the correct merchant. You can find this information in your API/Developer Section in the Portal, also referred to as the Account ID.

  • intent_id: This is the unique identifier for the payment intent, allowing the system to retrieve the correct transaction details. Using both parameters in the URL ensures that the HCP opens correctly and processes payments securely for the intended user and transaction.

HCP Sequence Flow ​

Step-by-Step Explanation ​

1. Merchant Website → API: ​

The merchant’s backend sends a POST /intents/payment request to create a new payment intent. This request typically includes information such as the merchant’s external_id, order details, and redirect URLs.

2. API → Merchant Website: ​

The API responds with a JSON payload containing the intent_id. This unique identifier references the newly created payment intent.

3. Merchant Website → User: ​

With the intent_id, the merchant constructs and provides the Hosted Checkout Page URL to the user. This might involve redirecting the user’s browser or displaying a link/button that includes the intent_id and the merchant’s account_id (also known as client_id).

4. User → Hosted Checkout Page: ​

The user clicks on the provided link or is automatically redirected to the Hosted Checkout Page (HCP), which is responsible for securely collecting the user’s card and billing information.

5. Hosted Checkout Page → API: ​

Once the user enters their card details and confirms payment, the HCP sends the card data and confirmation to the API. This step triggers the payment authorization process.

6. API → Hosted Checkout Page: ​

The API processes the request (e.g., checks the card, contacts the payment network, etc.) and returns the authorization result to the HCP. The result can either be a success (authorized) or failure (declined or error).

7. Hosted Checkout Page → Merchant Website: ​

Finally, the Hosted Checkout Page redirects the user back to the merchant-specified success or failure URL. This redirect typically includes parameters indicating the status of the transaction and possibly the intent_id or a transaction reference.