Vexor

Initialize the SDK

As regards the code, the only difference between the Standalone version and Vexor Cloud is the way you initialize the SDK, you'll see that below.

If you need to know more about the differences as regards the product itself, you can read the differences page.

Installation

Vexor can be installed in any Node.js-based project. To install Vexor, simply run one of the following commands in your project directory:

npm install vexor

or

npm i vexor

This will install the core Vexor package, which can be used with any Node.js-based framework or library.

Static Initialization

There are 3 ways to instantiate a Vexor instance:

  1. Using the new Vexor() constructor with publishable key, project id and secret key.
  2. Using the Vexor.init() static method.
  3. Using the Vexor.fromEnv() only available in Vexor Cloud version.

StaticVexor.init(params) | new Vexor(params)

Returns

These methods return a new Vexor instance. Choose the method that best fits your application's architecture/conventions.

import { Vexor } from 'vexor';
 
export const vexor = Vexor.init({
  standalone: {
    api_key: string;
    platforms?: {
      mercadopago?: {
        public_key: string;
        access_token: string;
        client_id?: string;
        client_secret?: string;
        webhook_secret?: string;
        webhooks_url?: string;
        sandbox?: boolean;
      },
      stripe?: {
        public_key: string;
        secret_key: string;
        webhook_secrets?: string[];
        sandbox?: boolean;
      },
      paypal?: {
        client_id: string;
        secret_key: string;
        webhook_id?: string;
        sandbox?: boolean;
      },
      talo?: {
        user_id: string;
        client_id: string;
        client_secret: string;
        webhooks_url?: string;
        sandbox?: boolean;
      },
      square?: {
        access_token: string;
        application_id: string;
        webhooks_url?: string;
        webhook_signature_key?: string;
        sandbox?: boolean;
      }
    }
  }
});

Recommendations

  1. Create a .env file in your project root and add your Vexor environment variables:
VEXOR_STANDALONE_KEY=vx_prod_st_1234567890

WARNING: Do not store any secrets in your client-side code! These keys should be handled on the server side.

  1. Create a vexor.ts file in your lib or utils folder and export the Vexor instance:
import { Vexor } from 'vexor';
 
export const vexor = Vexor.init({
  standalone: {
    api_key: process.env.VEXOR_STANDALONE_KEY,
    // Add only the platforms you want to use
    platforms: {
            mercadopago: {
                public_key: 'your_mercadopago_public_key',
                access_token: 'your_mercadopago_access_token',
                webhook_secret: 'your_mercadopago_webhook_secret',
                webhooks_url: 'your_mercadopago_webhooks_url',
                sandbox: true // Optional, defaults to false
            },
            paypal: {
                client_id: 'your_paypal_client_id',
                secret_key: 'your_paypal_secret_key',
                webhook_id: 'your_paypal_webhook_id',
                sandbox: true // Optional, defaults to false
            },
            talo: {
                user_id: 'your_talo_user_id',
                client_id: 'your_talo_client_id',
                client_secret: 'your_talo_client_secret',
                webhooks_url: 'your_talo_webhooks_url',
                sandbox: true // Optional, defaults to false
            },
            stripe: {
                public_key: 'your_stripe_public_key',
                secret_key: 'your_stripe_secret_key',
                webhook_secrets: [
                    'your_stripe_webhook_secret'
                ],
                sandbox: true // Optional, defaults to false
            },
            square: {
                application_id: 'your_square_application_id',
                access_token: 'your_square_access_token',
                webhooks_url: 'your_square_webhooks_url',
                webhook_signature_key: 'your_square_webhook_signature_key',
                sandbox: true // Optional, defaults to false
            }
  }
});

Choose the method that best fits your application's architecture and security requirements.

The Vexor.init() method is functionally equivalent to using the new Vexor() constructor. It's provided as an alternative syntax that some developers may find more intuitive or easier to use in certain contexts.

Next Steps

Follow the guides to start integrating Vexor into your project.

Previous

Vexor Cloud vs Standalone

On this page

InstallationStatic InitializationReturnsRecommendationsNext Steps