Status page
Guides

Integration Guide

Suggest Edits

This guide outlines the integration process, highlighting key considerations and referencing relevant documentation for detailed instructions.

Integration Methods

ℹ️

Paybis offers various integration options to suit your specific requirements. To learn more about each method and choose the most suitable one, please refer to our integration instructions.

You can integrate the Corporate Ramp using one of the following methods:

Direct API Integration

This method allows you to use Paybis API. This provides greater flexibility and control over the widget's behavior and appearance.

Steps:

  • Retrieve supported fiat and cryptocurrencies using the GET /v2/currency/pairs/buy-crypto.
  • Request a quote with the desired parameters using the POST /v2/quote.
  • Obtain the requestId required to initialize the widget using the POST /v2/request.
  • Generate request with the obtained requestId and optional query parameters.

Variations:

  • With Quote: Generate a quote using the POST /v2/quote and include it in the transaction request.
  • Without Quote: Initiate a transaction without a pre-generated quote, allowing users to select parameters within the widget.
  • One-Click Purchase: Streamline the purchase process by combining quote generation and transaction initiation into a single step.

ℹ️

Refer to the Web: Direct URL API integration guide for detailed instructions.

Direct URL Standalone Integration

This method offers a simplified integration process with less flexibility.

  • Pre-filled URL: Generate a URL with pre-filled parameters, such as partnerId, amount, currency, and cryptoWalletAddress.
  • Ease of Use: This approach is easier to implement, requiring minimal coding and API interaction.
  • Limited Customization: Offers less customization compared to Direct API Integration, as the widget's behavior is largely predefined by the URL parameters.

ℹ️

Refer to the Web: Direct URL standalone integration guide for details.

Web JavaScript SDK Integration

This method provides a more interactive and customizable integration experience.

  • JavaScript SDK: Utilize the Paybis JavaScript SDK to embed the widget into your webpage and control its behavior using JavaScript functions.
  • Customization: Offers greater control over the widget's appearance, user flow, and event handling.
  • Embedded Mode: Allows embedding the widget directly into your page layout for a more seamless user experience.

ℹ️

Refer to the "Web: JavaScrpt SDK section, including guides for embedded mode.

By following the appropriate integration guide and considering these key aspects, you can successfully integrate the Paybis Corporate Ramp into your platform, providing a seamless and secure crypto purchasing experience for your corporate clients.

Updated 12 days ago