Payment Gateway API Documentation

Payin API Documentation

Create Order API

POST URL: https://merchant.zivope.in/v1/api/create-order

⚠️ Important: Order Timeout 30 Minutes. Order Will Be Automatically Failed After 30 Minutes.

Request Headers

Content-Type: application/x-www-form-urlencoded

Request Payload

{
  "customer_mobile": "9876543210",
  "user_token": "YOUR_USER_TOKEN",
  "amount": "250",
  "order_id": "ORD20250108123456",
  "redirect_url": "https://example.com/payment-success",
  "remark1": "Product purchase",
  "remark2": "Invoice #INV-2025-001"
}

Request Parameters

customer_mobile - Customer mobile number (required, 10 digits)
user_token - Your unique user token (required, obtained from dashboard)
amount - Payment amount in ₹ (required, minimum ₹1)
order_id - Unique order identifier (required, must be unique per transaction)
redirect_url - URL to redirect after payment completion (optional)
remark1 - Additional remark 1 (optional)
remark2 - Additional remark 2 (optional)

Success Response

HTTP Status: 200 OK

{
  "status": true,
  "message": "Order Created Successfully",
  "result": {
    "orderId": "ORD20250108123456",
    "payment_url": "https://merchant.zivope.in/payment/intent_payment_page.php?order_id=ORD20250108123456",
    "deeplinks": {
      "upi": "upi://pay?pa=auraaccessoriessolutio-13491285.payu@indus&pn=Aura Accessories&tr=26776813338&tid=PPPL2677681333809012611350969609a95&am=250.00&cu=INR&tn=UPIIntent",
      "gpay": "tez://upi/pay?pa=auraaccessoriessolutio-13491285.payu@indus&pn=Aura Accessories&tr=26776813338&tid=PPPL2677681333809012611350969609a95&am=250.00&cu=INR&tn=UPIIntent",
      "phonepe": "phonepe://pay?pa=auraaccessoriessolutio-13491285.payu@indus&pn=Aura Accessories&tr=26776813338&tid=PPPL2677681333809012611350969609a95&am=250.00&cu=INR&tn=UPIIntent",
      "paytm": "paytmmp://pay?pa=auraaccessoriessolutio-13491285.payu@indus&pn=Aura Accessories&tr=26776813338&tid=PPPL2677681333809012611350969609a95&am=250.00&cu=INR&tn=UPIIntent"
    }
  }
}

payment_url: Redirect your customer to this URL to complete the payment.
deeplinks: Direct UPI app links for instant payment (UPI, Google Pay, PhonePe, Paytm).

Failed Response

HTTP Status: 400 Bad Request

{
  "status": "false",
  "message": "Invalid user token or insufficient balance"
}

Example cURL Request

curl -X POST "https://merchant.zivope.in/v1/api/create-order" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "customer_mobile=9876543210" \
  -d "user_token=YOUR_USER_TOKEN" \
  -d "amount=250" \
  -d "order_id=ORD20250108123456" \
  -d "redirect_url=https://example.com/payment-success"

Webhook Documentation

Payin Webhook

Whenever a pay-in (customer deposit) is received, the system will POST the JSON payload to your configured webhook URL.

Webhook Endpoint

You need to configure your webhook URL in the dashboard. The system will send data to this URL.

POST Your Configured Webhook URL

Method

POST

Content-Type

application/json

Sample Webhook Payload

{
  "order_id": "ORD20250108123456",
  "status": "SUCCESS",
  "amount": "250",
  "utr": "987654321098765",
  "message": "Payment received successfully"
}

Field Descriptions

order_id - Unique order identifier for the payin transaction
status - Payment status. Possible values: SUCCESS, FAILED, etc.
amount - Amount received
utr - Unique Transaction Reference number for the payment
message - Status message for the transaction

Important Notes

Your webhook endpoint must be accessible and capable of processing application/json payloads
Always validate order_id and status before updating your records
Send HTTP 200 OK response within 5 seconds to avoid automatic retries
System retries failed webhook attempts up to 3 times