Integration Guide

You’ll find detailed instructions for setting up authentication, configuring payment settings, and establishing conditions for both installment and single payment options.

General Setup

To configure Bamboo as a payment provider in your VTEX store, follow these steps:

1. Log in to your VTEX admin panel using your credentials.

2. Navigate to ‘Store Configuration’ > ‘Providers’ > ‘New Provider’.

3. Search for Bamboo-Payments in the list of providers and select it.

Bamboo Plugin Configuration

Authentication Setup

Enter your store credentials in the designated fields. For information on generating your store keys, refer to the VTEX Keys documentation

Payment Control

1. Choose whether to operate in test mode.

2. Select your preferred type of settlement.

Provider Fields

Configure the following settings:

1. Private Key: Enter your Bamboo PrivateKey.
2. Enable Authorization and Capture: If enabled, you’ll need to manually capture payments made with Bamboo from your store.
3. Operating Country: Select the country where your store operates.

After completing these fields, click the ‘Save’ button.

Payment Methods Configuration

To set up payment methods:

1. Go to the ‘Payment Conditions’ tab.

2. Click the ‘+’ icon to add a new condition.
3. Configure the payment method you want to offer to your customers.

Installments for Credit Cards

To set up installments for Credit Cards:

1. Select the desired card brand from the list.

2. Activate the condition.

3. Select Bamboo-Payments as the provider.

4. Enter a name to identify the payment condition.

5. Choose the ‘Installments’ option and enter the requested data.
6. Configure interest rates and/or external interests as needed.
7. Save the changes.

Single Payment (One-time Payment) for Credit and Debit Cards

To set up single payments (payments in one installment):

1. Follow the same process as ‘Installment Payments’.
2. Instead of selecting ‘Installments’, choose the ‘Single Payment’ option.

3. Configure the necessary details for one-time payments.
4. Save the changes.

By following these steps, you’ll successfully offer Bamboo as a payment method to your customers in your VTEX store, including both installment plans and single payment options.

Antifraud Script

For the correct functioning of transactions made through Bamboo, an anti-fraud analysis script must be injected into the store. To configure it, follow the steps below:

1. Inside the VTEX administrative panel, go to ‘Store Settings’.

2. Navigate to ‘Storefront > Checkout’.
3. Click on the configuration icon for the ‘Default’ option.

4. Enter ‘Code > checkout-custom.js’.

5. Insert the following code block into the file and save:

const API_Environment = "https://api.bamboopayment.com",
    PublicAccountKey = "CT4XUYw10xDemA4UqCgU0m_I56ONV7HQ";

async function getIp() {
    return fetch("https://api.ipify.org/?format=json")
}

async function loadScript(e, t) {
    if (!window.vtex || window.vtex.deviceFingerprint) {
        console.debug(window.vtex ? `already deviceFingerprint: ${window.vtex.deviceFingerprint}` : "there is no VTEX");
        return
    }
    let n = document.createElement("script");
    n.src = e,
    n.onload = t,
    document.head.appendChild(n)
}

async function generateFingerPrint() {
    if (!window.setSessionID) {
        console.debug("SetSessionID not found");
        await new Promise(e => setTimeout(() => e(!0), 1e3));
        console.debug("Retrying...");
        return generateFingerPrint();
    }
    let e = window.getSessionAntifraud(),
        t = await getIp().then(e => e.json()).then(({ip: e}) => e),
        n = JSON.stringify({
            sessionId: e,
            ip: t
        });
    window.vtex.deviceFingerprint = n
}

window.addEventListener("DOMContentLoaded", () => {
    console.info("==== RUNNING FINGER PRINT ====");
    loadScript(`${API_Environment}/v1/Scripts/Antifraud.js?key=${PublicAccountKey}`, generateFingerPrint)
});

This script will ensure that the anti-fraud analysis is performed correctly for transactions processed through Bamboo.

Last modified December 20, 2024

© Bamboo | All rights reserved 2024