Introduction to ZiniPay

ZiniPay is a simple and secure payment automation tool designed to use personal accounts as a payment automation, allowing you to accept payments from customers through your website. This documentation provides a complete overview of how ZiniPay works and how you can integrate the ZiniPay API into your website.

API Introduction

ZiniPay Payment Automation enables Merchants to receive money from their customers by temporarily redirecting them to ZiNiPay.com. The gateway connects multiple payment terminals including card systems, mobile financial systems, and local and international wallets. After the payment is complete, the customer is returned to the merchant's site, and seconds later the Merchant receives notification about the payment along with the details of the transaction.

API Operation

REST APIs are supported in two environments. Use the Sandbox environment for testing purposes, then move to the live environment for production processing. When testing, generate an order URL with your test credentials to make calls to the Sandbox URIs. When you're set to go live, use the live credentials assigned to your new signature key to generate a live order URL to be used with the live URIs. Your server must support the cURL system.

Create Payment Examples

The following examples show how to create a payment request with the ZiniPay API in various programming languages.

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.zinipay.com/v1/payment/create',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{"redirect_url":"yourdomain.com/success","cancel_url":"yourdomain.com/cancel","webhook_url":"yourdomain.com/webhook","metadata":{"phone":"016****"},"amount":"10"}',
  CURLOPT_HTTPHEADER => array(
   'zini-api-key': 'YOUR_BRAND_API_KEY',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

?>

{
  "status": true,
  "message": "Payment URL generated successfully",
  "payment_url": "https://secure.zinipay.com/payment/abc123xyz456"
}

Required Parameters

Verify Payment

After a payment is completed, you might want to verify its status. ZiniPay provides an API endpoint to verify payment status using the transaction ID.

Variables Needed For Payment Verification

<?php
// Verify Payment Example
$apiKey = "YOUR_API_KEY";

// Initialize cURL session
$ch = curl_init();

// Transaction ID received from success URL
$invoiceId = $_GET['invoiceId']; 

// Prepare data for API request
$data = [
    'invoiceId' => $invoiceId,
    'apiKey' => $apiKey
];

// Configure cURL request
curl_setopt($ch, CURLOPT_URL, 'https://api.zinipay.com/v1/payment/verify');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'zini-api-key': 'YOUR_BRAND_API_KEY',
]);

// Execute request and get response
$response = curl_exec($ch);
curl_close($ch);

// Process the response
$paymentData = json_decode($response, true);

if ($paymentData && isset($paymentData['status']) && $paymentData['status'] === 'success') {
    // Payment is verified, process order
    echo "Payment verified successfully!";
    echo "Transaction ID: " . $paymentData['data']['transactionId'];
    echo "Amount: " . $paymentData['data']['amount'];
    // Update your database, fulfill the order, etc.
} else {
    // Payment verification failed
    echo "Payment verification failed: " . ($paymentData['message'] ?? 'Unknown error');
}
?>

{
    "transaction_id": "OVKPXW135414",
    "invoiceId": "553ca0ac-28c0-41f7-adc0-6243910b1e1b",
    "amount": "900.00",
    "currency": "USD",
    "paymentMethod": "bkash",
    "status": "COMPLETED",
    "customerName": "John Doe",
    "customerEmail": "[email protected]",
    "metadata": {
      "orderId": "ORD-12345",
      "productId": "PROD-567"
    },
    "createdAt": "2023-09-15T14:23:45Z"
}

API Reference

Comprehensive documentation of all available ZiniPay API endpoints.

WordPress & WooCommerce Integration

ZiniPay offers a seamless integration with WordPress and WooCommerce, allowing you to accept payments in Bangladesh through bKash, Nagad, and Rocket with a simple plugin installation. Our automatic payment automation solution works with both merchant and personal accounts.

Features of ZiniPay WordPress Plugin

Installation Guide

Configuration Options

Benefits of Using ZiniPay with WordPress

Tools & SDKs

ZiniPay provides various tools and SDKs to help you integrate faster.