English

Getting Started

Brief Integration Overview

There is a set of libraries for working with the platform, it is located in, available in the official project repository.

The SDKs offer several advantages over the “bare” documentation.

  • Ready-to-use methods: Integration method functions are implemented, allowing you to start working quickly without the need to wrap API requests and handle errors manually.

  • Automation: Some parameters and settings are filled automatically, reducing integration time. They also automatically create signatures for requests. However, flexible settings are always available if desired.

  • Code examples can be found on the library pages:

The libraries include a set of all the methods necessary for integration.

Some of the methods necessary for a quick start:

  1. Payment acceptance 1.1 Invoices or orders 1.2 Personal static addresses

  2. Commission token retrieval

  3. Withdrawals. Payouts.

  4. Retrieving the list of all payments.

Integration using the SDK libraries.

  1. Make sure you have Python (version 3.6 or higher) installed.

  2. Install the OnchainPay API library using pip through Terminal or Command Prompt.

Installation command

pip install onchainpay-api

  1. Make sure you have Node.js (version 12.x or higher) installed.

  2. Install the OnchainPay SDK library using npm or yarn.

Installation command via npm:

npm install onchainpay-sdk

Installation command via yarn:

yarn add onchainpay-sdk

  1. Make sure you have Go (version 1.13 or higher) installed.

  2. Install the OnchainPay SDK library using “go get”.

Installation command:

go get github.com/onchainpay/go-sdk

  1. Make sure you have PHP (version 7.2 or higher) and Composer installed.

  2. Install the OnchainPay API library using Composer.

Installation command:

composer require onchainpay/php-api

These instructions will help you quickly and easily install the OnchainPay library for various programming languages.

PreviousIntroductionNextAuthorization

Last updated