Integrating Paybis Send

Introduction

This guide provides you with the technical part of Paybis Send integration into your platform, enabling your merchants to send cryptocurrency payouts to their users.

Prerequisites

Implement signing requests. See our Signing Requests Guide for details on how to secure your API requests.
(Optional) Implement a user interface that utilizes our APIs to allow Merchants to initiate and track crypto payouts and view transaction history.
(Optional) Integrate Paybis Send functionality into your admin panel to enable your team to initiate payouts on behalf of merchants, and monitor and manage transaction statuses.

Send Crypto Flow

1. (Optional) Check Prefunded Balance

Ensure sufficient funds are available in your prefunded balance to cover the transaction amount. See the Get Available and Hold Balances reference.

2. Validate Wallet Address

Use the Crypto Address Screening API to verify that the end-user's crypto wallet address is valid and compliant. This step is recommended to avoid potential payout issues. See the Crypto Address Screening API reference.

3. Request a Quote

Call the Quote API to obtain a real-time quote for the selected cryptocurrency and fiat currency pair. See the Quote API reference.

4. Execute Send Crypto Transaction

Utilize the Execute API to send the payout request to Paybis. Paybis will process the request and execute the crypto payout to the specified wallet address. See the Execute API Endpoint reference.

5. Transaction Statuses and Reconciliation

Paybis will notify you of the payout status using the Transaction Data Webhook. Implement logic to process these webhooks and update your system accordingly. See the Transaction Data Webhook reference.

Available Environments

Sandbox: A testing environment for your integration.

Use the provided sandbox API key and URL.
IP whitelisting is not enforced in the sandbox.
Crypto payouts are executed on testnet blockchains. See the Sandbox Testing section for more details.

Production: The live environment for processing real transactions.

Use the production API key and URL.

🚧
IP whitelisting will be enforced and must be configured before going live.

Managing Paybis Send Prefunding Balance

To ensure uninterrupted service and avoid payout failures, it's your responsibility to proactively monitor and maintain prefunded balance.

Topping Up Your Balance:

When your balance runs low, you can replenish it by transferring fiat currency to the designated Paybis bank account. The necessary bank account details will be provided to you during the onboarding process.

Key Points:

Responsibility: It's your responsibility to ensure your pre-funded balance remains sufficient to cover upcoming payouts.
Currency: This balance, denominated in USDT (1 USDT = 1 USD), is used to cover the cost of cryptocurrency payouts initiated through the Paybis Send API. Transactions in other currencies are converted at the prevailing exchange rate.

✅
By managing prefunded balance, you can ensure seamless operations for your users and maintain the smooth flow of cryptocurrency payouts.

Additional Considerations

Supported Cryptos and Fiats: See the Supported Assets section for more details.
Testing: Use the recommended testnet assets and small transaction amounts during sandbox testing.
Key Generation: You must generate the RSA key pair for signing requests and provide the public key to Paybis.
Webhook URL: If you want to receive webhook notifications, provide your webhook URL to Paybis.

📘
For assistance with Paybis Send API, signing requests, webhooks, sandbox setup, and prefunded balance inquiries, contact your Paybis account manager or the designated support team.