DEV Community: Christopher Akanmu

How to Integrate Crypto Payments in Your Apps & Build Your Own Crypto Payment Gateway with ZinariPays OpenAPI

Christopher Akanmu — Thu, 24 Oct 2024 03:44:56 +0000

In this article, we'll walk you through how to quickly set up a cryptocurrency payment gateway using ZinariPay's robust infrastructure. Whether you're a developer or a business looking to accept crypto payments, ZinariPay makes the process simple by providing a set of easy-to-use APIs for handling transactions, managing wallets, and monitoring payments.

1. What is ZinariPay?

ZinariPay is a cryptocurrency payment gateway built to simplify crypto transactions for businesses, with a specific focus on the African market. Using ZinariPay’s OpenAPI, businesses can process crypto payments in USDT and USDC with full integration support for fiat-to-crypto and crypto-to-fiat conversions.

2. Why Use ZinariPay for Your Payment Gateway?

Seamless Integration: ZinariPay provides comprehensive OpenAPIs that allow you to create, track, and manage transactions easily.
Fast Setup: With just a few API calls, you can have a functional crypto payment system.
Security and Reliability: ZinariPay handles all blockchain interactions securely, ensuring that your transactions are processed smoothly and without exposing sensitive information.

3. Step-by-Step Guide: How to Create a Crypto Payment Gateway

Step 1: Set Up Your ZinariPay Account

To get started, sign up for a ZinariPay account, where you can manage your apps and generate an API key from the ZinariPay console.

Step 2: Authenticate with Your API Key

Before making any API requests, you’ll need to pass your apiKey as a Bearer token in the Authorization header. Without this, your requests will fail. You can obtain your API key from the ZinariPay console.

Example:

   Authorization: Bearer <your_api_key>

Step 3: Create a Transaction

Use the create-transaction API to generate a unique payment address for your users. This allows your users to send payments in USDT or USDC.

Example Request:

   POST https://openapi.zinari.io/v1/create-transaction
   Content-Type: application/json

   {
     "cryptocurrency": "USDT",
     "fiatAmount": 50,
     "notificationEmailAddress": "customer@example.com"
   }

In development mode, the transaction will automatically be confirmed after a few seconds.
You can also pass additional data like userId, orderId, or productId to track your transactions.

Step 4: Monitor Transaction Status

Once the transaction is created, you can track its status using the get-transaction-by-id endpoint. This helps you keep tabs on whether the payment is Pending, Confirming, Confirmed, or in any other status.

Example:

   GET https://openapi.zinari.io/v1/transaction/:id

ZinariPay also provides webhook notifications for real-time updates on transaction status. Set up your webhook URLS in your ZinariPay console

Step 5: Get Wallet Balances

You can use the get-wallets endpoint to retrieve all your app’s wallet balances, which is essential for managing your crypto reserves and withdrawals.

Step 6: Withdraw Funds

To move funds out of your wallets, use the withdraw-from-wallet endpoint. This ensures you can securely transfer crypto to external wallets when needed. Withdrawal fees apply.

Example:

   POST https://openapi.zinari.io/v1/withdraw/:id

   {
     "amount": 50,
     "address": "<withdrawal address here>"
   }

Step 7: Handle Exchange Rates

ZinariPay also supports fiat-to-crypto, crypto-to-fiat, fiat-to-fiat and crypto-to-crypto conversions. You can use the get-exchange-rate endpoint to retrieve the latest conversion rates.

Example:

   GET https://openapi.zinari.io/v1/exchange-rate?from=USD&to=NGN
   GET https://openapi.zinari.io/v1/exchange-rate?from=USDT&to=ETH
   GET https://openapi.zinari.io/v1/exchange-rate?from=USDT&to=ZAR

4. Additional Features

Transaction Statuses: Learn about the various transaction statuses like Pending, Confirming, Confirmed, Incomplete, etc., and how to respond to each.
Paginated Transaction Lists: Use the list-paginated-transactions endpoints to fetch transactions in production and development modes.

5. Conclusion

By following the steps above, you can quickly integrate ZinariPay's APIs to either set up your own cryptocurrency payment gateway or directly receive payments in your website or apps. ZinariPay’s flexible API infrastructure makes it easy to process, track, and manage crypto payments without the burden of heavy maintenance. Whether you're looking to build a complete payment system or just accept payments, ZinariPay provides the tools to ensure a smooth and secure integration.

For a more comprehensive guide on all available endpoints, detailed usage examples, and best practices, please visit our official API documentation.

ZinariPay 2.0.0: The New Era of Cryptocurrency Payments Integration

Christopher Akanmu — Mon, 14 Oct 2024 19:28:01 +0000

We're excited to announce the release of ZinariPay version 2.0.0! This major update introduces significant changes and improvements to our npm package and CDN, making it easier and more secure than ever to integrate cryptocurrency payments into your web applications.

What's New?

1. Mandatory API Key for Enhanced Security

In version 2.0.0, the apiKey is now a mandatory field for all integrations. This breaking change emphasizes our commitment to enhanced security. By requiring the API key, we've introduced an extra layer of protection to ensure that your transactions remain safe and secure.

2. Completely Revamped User Interface

Our new UI is not only beautiful and intuitive, but it also follows a newly established design pattern that makes it more user-friendly. Whether you’re using the npm package or the CDN, you’ll notice how the fresh look and feel align with our marketing site. The updated interface provides clearer transaction details, while still maintaining core functionalities such as barcodes and copy functionality.

Key Features in ZinariPay 2.0.0

Multiple Cryptocurrency Support: ZinariPay supports USDT and USDC, ensuring a seamless crypto payment experience.
Encrypted Transactions: We’ve made security a priority with encrypted transaction handling, ensuring sensitive data is protected at all times.
Easy Integration: Developers can integrate ZinariPay more easily, whether using npm, yarn, or CDN. With just a few simple steps, you can enable crypto payments for your app.

Installation and Integration

ZinariPay 2.0.0 can be integrated via npm, yarn, or CDN. Below are the simple steps to get started:

Using npm

npm install zinari-pay

Using yarn

yarn add zinari-pay

CDN Integration

Simply include our latest script tag, and the ZinariPay instance will be globally available via the window object.

<script src="https://cdn.jsdelivr.net/npm/zinari-pay/dist/zinari-pay-cdn-bundle.umd.js"></script>

Usage

After installation, configuring ZinariPay is as easy as initializing ZinariPay with your app’s credentials, including the now-required API key:

const config = new ZinariPay({
  appId: 'your-app-id',
  apiKey: 'your-api-key',
  publicKey: 'your-public-key',
});

With a fully configured instance, you can easily initiate transactions and handle user payments. For instance, the zinariPay.initiateTransaction method allows you to manage the payment process seamlessly:

zinariPayInstance.initiateTransaction({
  amount: 100,
  details: { orderId: '#1234', description: 'Purchase Order #1234' },
  onConfirmed: (response) => {
    console.log('Transaction Confirmed:', response);
  },
});

Supported Fiat Currencies

Our package supports a range of fiat currencies, automatically converting them into USDT or USDC for transactions. Supported currencies include:

Nigerian Naira (₦)
South African Rand (R)
United States Dollar ($)
Euro (€)
British Pound (£)
and more!

CORS and Known Issues

If you encounter a CORS error, visit your ZinariPay console, navigate to the API section under App Settings, and whitelist your development/live environment URLs.

The Path Ahead

ZinariPay 2.0.0 brings a new level of security, functionality, and aesthetic appeal to cryptocurrency payments. With this release, we’ve solidified our commitment to providing a developer-friendly and highly secure gateway for accepting cryptocurrency payments. Whether you're a seasoned developer or new to crypto, ZinariPay has the tools you need to succeed.

Check out our official documentation to learn more, and get started with ZinariPay today!

How to Integrate ZinariPay with Your Application Using the CDN

Christopher Akanmu — Wed, 04 Sep 2024 11:46:42 +0000

If you’re looking for a quick and easy way to integrate cryptocurrency payments into your web application, ZinariPay’s CDN option is the perfect solution. With no need to install any packages, you can start accepting USDT and USDC payments by simply including a script tag in your HTML file.

Step 1: Installation

Integrating ZinariPay via CDN is as simple as adding a script tag to your HTML file. Here’s how you can do it.

<script src="https://cdn.jsdelivr.net/npm/zinari-pay/dist/zinari-pay-cdn-bundle.umd.js"></script>

You can also use UNPKG as an alternative:

<script src="https://unpkg.com/zinari-pay/dist/zinari-pay-cdn-bundle.umd.js"></script>

This script will load the ZinariPay library directly into your application, allowing you to start configuring and initiating transactions right away.

Step 2: Create a New Instance

After including the script, you’ll need to create a new instance of the ZinariPay object. This is where you’ll configure your payment options, such as the publicKey and appId.

Example Configuration

Here’s a basic example of how to create a new instance:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Zinari Pay Integration</title>
</head>
<body>
<!-- Your content -->

<!-- Include the Zinari Pay CDN Bundle -->
<script src="https://cdn.jsdelivr.net/npm/zinari-pay/dist/zinari-pay-cdn-bundle.umd.js"></script>
<script>
    // Create a new instance of ZinariPay
    window.zinariPay = new ZinariPay({
        appId: 'your-app-id',
        publicKey: 'your-public-key',
    });
</script>
</body>
</html>

You can get you publicKey and appId from you dashboard.

Step 3: Initiate a Transaction

Once your instance is configured, you can initiate a transaction. This can be done by calling the initiateTransaction method on your ZinariPay instance.

Example of Transaction Initiation

// Access the ZinariPay instance
const zinariPayInstance = window.zinariPay;

// Example: Initiate a transaction
zinariPayInstance.initiateTransaction({
  amount: 100,
  details: {orderId: '#1234', description: 'Purchase Order #1234'},
  onConfirmed: (response) => {
    console.log('Transaction Confirmed:', response);
  },
});

In this example, the transaction initiation is tied to a button click event. When the user clicks the “Pay with ZinariPay” button, the transaction process begins.

Conclusion

Integrating ZinariPay using the CDN is a hassle-free way to start accepting cryptocurrency payments on your website. With just a few lines of code, you can provide your users with the option to pay using USDT or USDC, all while enjoying the security and convenience of ZinariPay’s encrypted transaction handling.

For more information, visit our official documentation and start integrating ZinariPay today!

How to Integrate ZinariPay with Your Application Using the NPM Package

Christopher Akanmu — Wed, 04 Sep 2024 11:35:12 +0000

Integrating cryptocurrency payments into your web application has never been easier. ZinariPay offers a robust NPM package that allows developers to seamlessly add USDT and USDC payment functionalities. In this guide, we will walk you through the steps to integrate ZinariPay into your application using the NPM package.

Step 1: Installation

First, you'll need to install the ZinariPay package. This can be done using either npm or yarn, depending on your preference.

Using npm
To install using npm, run the following command in your terminal:

npm install zinari-pay

Using yarn
Alternatively, you can use yarn to install the package:

yarn add zinari-pay

Step 2: Configuration

Once the package is installed, you need to configure it for your application. The configuration involves creating an instance of ZinariPay with your specific settings.

Example Configuration
Here's a basic configuration example using vanilla JavaScript:

import ZinariPay from 'zinari-pay';

const zinariPay = new ZinariPay({
  appId: 'your-app-id',
  publicKey: 'your-public-key',
  log: process.env.NODE_ENV === 'development', /** Recommendation: Only 
use for development to avoid exposing sensitive data to end users
   */
});

You can get you appId and publicKey from you dashboard

Step 3: Initiate a Transaction

With your configuration set up, you can now initiate a transaction. This can be done using the initiateTransaction method.

Vanilla JavaScript Example
Here's how you would initiate a transaction:

import ZinariPay from 'zinari-pay';

const zinariPay = new ZinariPay({...})

const payWithCryptoButton = document.getElementById("your-payment-button");

payWithCryptoButton.addEventListener("click", () => {
  zinariPay.initiateTransaction({
    amount: 10000,
    notificationEmailAddress: 'users@email.com',
    details: {
      /** Add all the extra details you need here,
       * we  call your webhook url with all this data included */
    },
    onConfirmed: (transactionDetails) => {
      /** Do something when the transaction is confirmed */
    }
  });
});

React Example
If you're using React, you can integrate ZinariPay as follows:

import ZinariPay from 'zinari-pay';

const zinariPay = new ZinariPay({
  appId: 'your-app-id',
  publicKey: 'your-public-key',
  log: process.env.NODE_ENV === 'development',
});

const App = () => {
  const handleClick = useCallback(({price, email}) => {
    zinariPay.initiateTransaction({
      amount: price,
      notificationEmailAddress: email,
      onConfirmed: (transactionDetails) => {
        /** Do something when the transaction is confirmed */
      },
      details: {
        /** Add all the extra details you need here,
         * we  call your webhook url with all this data included */
      },
    });
  }, []);

  return <button onClick={handleClick}>
    Pay with Cryptocurrency
  </button>
}

Conclusion
Integrating ZinariPay into your application using the NPM package is straightforward and efficient. With support for USDT and USDC, encrypted transactions, and easy-to-use methods, ZinariPay is the perfect solution for adding cryptocurrency payments to your web application.
For more detailed information, visit the official documentation and start building today!

Introducing ZinariPay: The Future of Cryptocurrency Payments

Christopher Akanmu — Wed, 04 Sep 2024 11:20:17 +0000

In an increasingly digital world, businesses need reliable and secure ways to accept cryptocurrency payments. Enter ZinariPay - a powerful and versatile cryptocurrency payment platform designed to meet the needs of modern businesses. Currently, ZinariPay supports USDT and USDC, with plans to expand to other cryptocurrencies in the near future.

Why ZinariPay?
ZinariPay is not just another payment gateway; it's a comprehensive solution for managing your cryptocurrency transactions with ease and security. Whether you're a small business or a large enterprise, ZinariPay provides all the tools you need to integrate cryptocurrency payments seamlessly into your operations.

Add and Manage Apps
ZinariPay allows you to easily add and manage multiple apps under one account. Each app can be configured with its own settings, public keys, and more. You can rotate public keys for enhanced security and manage all your apps from a single dashboard.
Team Management with Role-Based Permissions
With ZinariPay, you can add, manage, and even terminate team members with different permission levels. Whether you need a customer support role to handle queries or a software developer role to manage technical aspects, ZinariPay has you covered.
Seamless Withdrawals
Withdraw your funds effortlessly with our seamless withdrawal feature. ZinariPay ensures that your transactions are processed quickly and securely, giving you peace of mind.
Comprehensive Transaction History
ZinariPay provides a thorough transaction history that includes blockchain transaction IDs. These IDs allow you to track your transactions directly on the blockchain, offering transparency and trust.
Social Login
Simplify user onboarding with social login options. ZinariPay supports popular social media platforms, making it easier for users to sign in and start managing their cryptocurrency payments.
Encrypted Data Storage
At ZinariPay, security is our top priority. All sensitive data is encrypted before storage, ensuring that your information is protected at all times.

Supported Fiat Currencies

ZinariPay is designed to be flexible, and we support a comprehensive list of fiat currencies. Whether you're dealing with USD, EUR, GBP, NGN, KSh, GHS, EGP or any other major currency, ZinariPay makes it easy to convert and manage your funds. You can find a list of supported fiat currencies here.

Development Roadmap

While ZinariPay currently supports USDT and USDC, we are actively working on integrating other popular cryptocurrencies. Our goal is to provide a diverse range of payment options to meet the evolving needs of our users.

Get Started with ZinariPay
Ready to integrate ZinariPay into your business? Visit our website to learn more. You can also check out our NPM package to start building your own integrations.

Conclusion

ZinariPay is more than just a payment platform - it's a gateway to the future of digital payments. With robust features, strong security measures, and an expanding range of supported currencies, ZinariPay is poised to become the go-to solution for businesses looking to accept cryptocurrency payments.
Don't miss out on the future of payments. Join ZinariPay today!