API Documentation

Integrate Quicktxn with your application using our powerful REST API

API Reference

SDKs & Libraries

Authentication

The Quicktxn API uses API tokens to authenticate requests. You can view and manage your API tokens in the Quicktxn Dashboard.

Using Your API Token

Include your API token in all API requests to the server as a form-encoded parameter. 

curl https://manage.quicktxn.in/api/create-order \
   "user_token=your_api_token_here" \
   "customer_mobile=9876543210" \
   "amount=100" \
   "order_id=ORDER123" \
   "redirect_url=https://manage.quicktxn.in" \
   "[email protected]" \
   "remark2=Hello"

Security

Always keep your API token secure and never expose it in client-side code or public repositories.

  • Use HTTPS for all API requests
  • Rotate your API tokens regularly
  • Restrict API token usage to specific IP addresses if possible

Errors

Quicktxn uses conventional HTTP response codes to indicate the success or failure of an API request.

Code Status Description
200 OK Request succeeded
400 Bad Request Invalid request parameters
401 Unauthorized Invalid API token
404 Not Found Resource doesn't exist
429 Too Many Requests Rate limit exceeded
500 Server Error Internal server error

Error Response Example

{
  "status": "false",
  "message": "Order_id Already Exist"
}

Create Order

The order is created through this API. Once the order is created, you will get a payment link. You can accept the payment very easily by redirecting to the same payment link.

POST

Create a payment order

Endpoint https://manage.quicktxn.in/api/create-order

Request Parameters (form-encoded)

Parameter Type Required Description
customer_mobile string Yes Your customer's mobile number
user_token string Yes Your API token
amount string Yes Transaction amount
order_id string Yes Unique transaction ID
redirect_url string Yes URL to redirect after payment
remark1 string No Customer's email address
remark2 string No Additional data

Example Request

curl https://manage.quicktxn.in/api/create-order \
   "customer_mobile=9876543210" \
   "user_token=940149cb99886d365f5f314476a994b6" \
   "amount=1" \
   "order_id=8787772321800" \
   "redirect_url=https://manage.quicktxn.in" \
   "[email protected]" \
   "remark2=Hello"

Success Response

{
  "status": true,
  "message": "Order Created Successfully",
  "result": {
    "orderId": "1234561705047510",
    "payment_url": "https://manage.quicktxn.in/payment/pay.php?data=MTIzNDU2MTcwNTA0NzUxMkyNTIy"
  }
}

Failed Response

{
  "status": "false",
  "message": "Order_id Already Exist"
}

Check Order Status

This is the transaction check status API, through which you can check your transaction status very easily.

POST

Check order status

Endpoint https://manage.quicktxn.in/api/check-order-status

Request Parameters (form-encoded)

Parameter Type Required Description
user_token string Yes Your API token
order_id string Yes Your reference ID of transaction

Example Request

curl https://manage.quicktxn.in/api/check-order-status \
   "user_token=2048f66bef68633fa3262d7a398ab577" \
   "order_id=9876543210"

Success Response

{
  "status": "COMPLETED",
  "message": "Transaction Successfully",
  "result": {
    "txnStatus": "COMPLETED",
    "resultInfo": "Transaction Success",
    "orderId": "871868513",
    "status": "SUCCESS",
    "amount": 1,
    "date": "2024-08-24 20:06:20",
    "utr": "423776207603",
    "customer_mobile": "1234567890",
    "remark1": "test1",
    "remark2": "test2"
  }
}

Failed Response

{
  "status": "ERROR",
  "message": "Error Message"
}

Webhooks

You need to add an endpoint for the Callback API. This endpoint will be used to update the status of the transaction through IMB Payment Gateway. We will assume that the update request has been accepted when you receive a successful response from the endpoint.

Webhook URL Setup

Note that only static URL structures are supported.

URL Structure https://domain.in/path

Webhook Payload (form-encoded)

{
  "status": "SUCCESS",
  "order_id": "TXN00743264723",
  "message": "Transaction Successfully",
  "result": {
    "txnStatus": "COMPLETED",
    "resultInfo": "Transaction Success",
    "orderId": "TXN00743264723",
    "amount": 100,
    "date": "2021-01-01 12:00:00",
    "utr": 435644746487,
    "customer_mobile": 9876543210,
    "remark1": "[email protected]",
    "remark2": "Your Data"
  }
}

Response Handling

Your endpoint should return a 200 OK response to acknowledge successful receipt of the webhook.

SDKs & Libraries

Official Quicktxn libraries for popular programming languages.

Node.js

Node.js

Install with npm:

npm install quicktxn

Example usage:

const Quicktxn = require('quicktxn');

const client = new Quicktxn('your_api_token_here');

// Create order
client.createOrder({
  customer_mobile: '9876543210',
  amount: '100',
  order_id: 'ORDER123',
  redirect_url: 'https://yourdomain.com/callback',
  remark1: '[email protected]',
  remark2: 'Additional info'
}).then(response => {
  console.log(response.payment_url);
}).catch(error => {
  console.error(error);
});

// Check status
client.checkStatus({
  order_id: 'ORDER123'
}).then(response => {
  console.log(response.status);
}).catch(error => {
  console.error(error);
});
Python

Python

Install with pip:

pip install quicktxn

Example usage:

import quicktxn

client = quicktxn.Client(api_key='your_api_token_here')

# Create order
response = client.create_order(
    customer_mobile='9876543210',
    amount='100',
    order_id='ORDER123',
    redirect_url='https://yourdomain.com/callback',
    remark1='[email protected]',
    remark2='Additional info'
)
print(response['payment_url'])

# Check status
status = client.check_status(
    order_id='ORDER123'
)
print(status['status'])
PHP

PHP

Install with Composer:

composer require quicktxn/quicktxn

Example usage:

<?php
require 'vendor/autoload.php';

use Quicktxn\Quicktxn;

$client = new Quicktxn('your_api_token_here');

// Create order
$response = $client->createOrder([
    'customer_mobile' => '9876543210',
    'amount' => '100',
    'order_id' => 'ORDER123',
    'redirect_url' => 'https://yourdomain.com/callback',
    'remark1' => '[email protected]',
    'remark2' => 'Additional info'
]);

echo $response['payment_url'];

// Check status
$status = $client->checkStatus([
    'order_id' => 'ORDER123'
]);

echo $status['status'];
?>
Java

Java

Add to your Maven pom.xml:

<dependency>
    <groupId>com.quicktxn</groupId>
    <artifactId>quicktxn-java</artifactId>
    <version>1.0.0</version>
</dependency>

Example usage:

import com.quicktxn.Quicktxn;
import com.quicktxn.models.CreateOrderResponse;
import com.quicktxn.models.CheckStatusResponse;

public class Main {
    public static void main(String[] args) {
        Quicktxn client = new Quicktxn("your_api_token_here");
        
        // Create order
        CreateOrderResponse response = client.createOrder(
            "9876543210",  // customer_mobile
            "100",         // amount
            "ORDER123",    // order_id
            "https://yourdomain.com/callback",  // redirect_url
            "[email protected]",  // remark1
            "Additional info"        // remark2
        );
        
        System.out.println(response.getPaymentUrl());
        
        // Check status
        CheckStatusResponse status = client.checkStatus(
            "ORDER123"    // order_id
        );
        
        System.out.println(status.getStatus());
    }
}

Ready to integrate? Start accepting payments today.

Get API Keys
Contact Support