Installation

Prerequisites

Requirements:

Modern web browser with ES6 support
API token from your Payviox dashboard
Node.js 14+ (for npm installation)

Installation methods

You can integrate the Payviox SDK using different methods depending on your project setup.

CDN
NPM
Download

Include the SDK directly in your HTML file using a CDN link.

index.html

<!DOCTYPE html>
<html>
<head>
  <title>Payviox Integration</title>
</head>
<body>
  <!-- Your content -->
  
  <script src="https://sdk.payviox.com/payviox.js"></script>
  <script>
    // The SDK is now globally available
    const payviox = new Payviox('your_api_token');
  </script>
</body>
</html>

Using the CDN is the fastest way to get started and automatically provides updates.

Install the SDK as a package in your Node.js project.

npm install @payviox/sdk

Then import it in your JavaScript files:

app.js

import Payviox from '@payviox/sdk';

const payviox = new Payviox('your_api_token');

Download the SDK file directly and include it in your project.

Download payviox.js from the releases page
Place it in your project’s js or vendor directory
Include it in your HTML:

<script src="/js/payviox.js"></script>

Get your API token

To use the SDK, you need an API token from your Payviox dashboard.

Navigate to https://dash.payviox.com and sign in with your credentials.

Access API settings

Go to Settings > API Keys in the sidebar menu.

Create or copy token

Click Create new API key or copy an existing key.

Use your public key (pk_) with the SDK — it’s built to be exposed in the browser. Your secret key (sk_) must never appear in client-side code: keep it on your server. See Authentication.

Initialize the SDK

Once installed, initialize the SDK with your API token:

const payviox = new Payviox('your_api_token');

// Verify that initialization is successful
console.log('Payviox SDK initialized');

import Payviox from '@payviox/sdk';

const payviox = new Payviox('your_api_token');

export default payviox;

import Payviox from '@payviox/sdk';

const payviox: Payviox = new Payviox('your_api_token');

export default payviox;

Verify installation

Test your installation by fetching available payment methods:

test.js

const payviox = new Payviox('your_api_token');

// Test the API connection
payviox.getPaymentsMethods()
  .then(methods => {
    console.log('Available payment methods:', methods);
  })
  .catch(error => {
    console.error('Installation error:', error);
  });

If you see a list of payment methods in the console, your SDK is correctly installed and configured.

Environment configuration

Development vs Production

Use different API tokens for development and production environments:

config.js

const PAYVIOX_TOKEN = process.env.NODE_ENV === 'production'
  ? 'pk_live_xxxxxxxxxxxxx'
  : 'pk_test_xxxxxxxxxxxxx';

const payviox = new Payviox(PAYVIOX_TOKEN);

Base URL configuration

The SDK automatically uses the correct base URLs:

API endpoint: https://api.payviox.com
Secure redirect: https://secure.payviox.com

To serve the payment page from your own subdomain, pass the checkoutUrl option to the constructor. The SDK is then also available at https://pay.yourstore.com/sdk.js. See Custom checkout domain.

Next steps

Quickstart

Create your first payment session

Redirect integration

Implement redirect mode

Iframe integration

Implement iframe mode

API reference

Explore all SDK methods

SDK - Getting Started

SDK - Integration

SDK - API Reference

Prerequisites

Installation methods

Get your API token

Initialize the SDK

Verify installation

Environment configuration

Development vs Production

Base URL configuration

Next steps

Quickstart

Redirect integration

Iframe integration

API reference

​Prerequisites

​Installation methods

​Get your API token

​Initialize the SDK

​Verify installation

​Environment configuration

​Development vs Production

​Base URL configuration

​Next steps

Quickstart

Redirect integration

Iframe integration

API reference

Prerequisites

Installation methods

Get your API token

Initialize the SDK

Verify installation

Environment configuration

Development vs Production

Base URL configuration

Next steps