VTEX Integration Guide – aCuotaz

This guide explains how to integrate aCuotaz as a payment method in your VTEX store and how to enable the Payment Mocker and Funding Limits behavior.

1. Prerequisites

Before you start, make sure you have:

2. Configure aCuotaz as Provider

  1. In VTEX Admin, go to:
    Store Settings → Payment → Providers.
    VTEX providers menu

  2. In the top‑right corner, click the New Provider button.
    VTEX new provider

  3. Search for “aCuotaz” in the list and select it.
    VTEX aCuotaz provider

  4. In the Authentication section, leave App Key and App Token blank (do not change them).
    VTEX aCuotaz provider blank tokens

  5. In the Provider Fields section, enter the credentials provided by Apurata: Client ID (client_id), Secret Token (secret_token) and Currency (PEN).
    Do not forget to save your changes. VTEX aCuotaz provider fieds

  6. Confirm that aCuotaz appears in the Providers list. VTEX aCuotaz confirmation

  7. Navigate to Store Settings → Payment → Settings in VTEX Admin. In the top-right corner, click the (+) button. VTEX settings menu

  8. In the payment methods list, search for "aCuotaz" and select it. VTEX aCuotaz click

  9. In the aCuotaz configuration panel, change the Status to Active, and click Save to apply the changes. VTEX configuration panel

  10. Confirm that aCuotaz has been successfully added and appears in the list of Payment Conditions. VTEX aCuotaz confirmation

3. Configure Payment Mocker & Funding Limits

This section enables the aCuotaz financing banner in the checkout and applies the funding limit logic for each customer and cart.

Important

Before starting with the following steps, make sure to replace the [client_id] field and copy the code provided at the following link: https://docs.apurata.com/POS/vtex_mocker/

  1. In the VTEX dashboard, go to Store Settings → Storefront → Checkout. VTEX checkout

  2. Click the settings (gear) icon. VTEX gear

  3. Select Code and then choose checkout6-custom.js. VTEX code

  4. Open the code file from the link provided earlier (https://docs.apurata.com/POS/vtex_mocker/). Make sure to replace the client_id with your actual client ID in the snippet.

  5. Copy and paste the code content (with your client_id replaced) into the checkout6-custom.js file and save your changes. VTEX pm snippet

Alternative Path

Note: If you encounter a warning or error when trying to access checkout6-custom.js in step 3, follow these alternative steps instead:

  1. Navigate to Store Settings → Storefront → Checkout UI Custom. VTEX error1

  2. Select Javascript. VTEX error2

  3. Copy and paste the code content (with your client_id replaced) and click Publish. Then proceed to see the examples below. VTEX error3

Example: Before and After

Here you can see examples of how the checkout should look before and after configuration:

Before: VTEX pm snippet

After: VTEX pm snippet

For purchases outside the funding limits, aCuotaz will no longer be displayed (check the price) VTEX pm snippet

4. Testing

To test the integration, follow the instructions in our Testing Guide.

Do not forget:

Note: Use your test credentials for all testing steps below.

  1. Obtain your credentials via email from Apurata. See step 5 in the "Configure aCuotaz as Provider" section and enter them in the Client ID and Secret Token fields respectively.
  2. Place several test orders using aCuotaz as the payment method, use different cart amounts (below, within, and above expected funding limits).
  3. In each case, verify that the aCuotaz widget loads correctly in the VTEX checkout only if the cart amount is within the funding limits, and that the aCuotaz option does not appear when the cart amount is outside the funding limits.
  4. Review your orders dashboard to confirm that orders from VTEX are received with the correct amounts and metadata.
  5. If any result looks incorrect, share screenshots and order IDs with the aCuotaz support team so they can adjust configuration or funding limits.

5. Go Live

  1. Once testing is complete and validated, replace test credentials with your production credentials in the aCuotaz provider configuration (same place as step 5 in the "Configure aCuotaz as Provider") and ensure the same aCuotaz script (Mocker) is still active in VTEX checkout with the correct clientId (see step 4 in "Configure Payment Mocker & Funding Limits").
  2. Place at least one small real order with aCuotaz from your production store to validate that the checkout flow works end-to-end and that the order appears correctly in VTEX and in aCuotaz.
  3. Inform your commercial / operations teams that aCuotaz is live so they can monitor initial orders and support customers during the first days of usage.
  4. If you need to change funding limits or visual behavior in the checkout, coordinate with the aCuotaz team; they may provide an updated script or configuration.