API Documentation - iPaisaPay

Quick Start

Get Your API Key

Test in Sandbox

Use our sandbox environment to test all APIs without real transactions.

Go Live

Once tested, switch to production API credentials and start processing real transactions.

Monitor & Support

Use our dashboard to monitor transactions and our 24/7 support for any issues.

GET Get Account Balance

Retrieve your current account balance and transaction limits.

GET https://api.ipaisapay.com/v1/api/account/balance

Headers:

Parameter	Type	Required	Description
Authorization	String	Required	Your API Key. Format: "Authorization: API-KEY"
Content-Type	String	Required	Must be "application/json"

200 OK

{
  "status": "true",
  "data": {
    "balance": 50000,
    "available_limit": 100000,
    "reserved": 5000,
    "currency": "INR",
    "last_updated": "2024-06-03T10:30:00Z"
  }
}
            

cURL Request:

curl --location 'https://api.ipaisapay.com/v1/api/account/balance' \
  --header 'Authorization: ipp_live_xxxxxxxxxxxxx' \
  --header 'Content-Type: application/json'
            

POST Create Payin Intent

Initiate a payment collection. Returns payment link and UPI deeplink for customer.

POST https://api.ipaisapay.com/v1/api/payin/initiate_payment

Request Body:

Parameter	Type	Required	Description
customer_name	String	Required	Full name of the customer
customer_email	String	Required	Valid email address
customer_mobile	String	Required	10-digit mobile number
amount	Integer	Required	Amount in rupees (minimum ₹1)
order_id	String	Required	Unique transaction ID from your system

200 OK

{
  "status": "true",
  "msg": "Transaction Successful",
  "order_details": {
    "tid": "ENP326020...",
    "deeplink": "upi://pay?pa=ipaisapay@nsdlpbma&pn=iPaisaPay%20PAY...",
    "payment_link": "https://api.ipaisapay.com/payment?id=TXN0699...",
    "expiry": "2024-06-03T11:30:00Z"
  }
}
            

cURL Request:

curl --location 'https://api.ipaisapay.com/v1/api/payin/initiate_payment' \
  --header 'Authorization: ipp_live_xxxxxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "customer_name": "Alex Kumar",
  "amount": "100",
  "order_id": "TXN_9988",
  "customer_email": "alex@gmail.com",
  "customer_mobile": "9876543210"
}'
            

POST Check Payin Status

Check the status of a payment that was initiated. Returns success/pending/failed status.

POST https://api.ipaisapay.com/v1/api/payin/check_status

Request Body:

Parameter	Type	Description
order_id	String	The order ID from initiate_payment request

200 OK

{
  "status": "true",
  "msg": "Successfully Found",
  "order_details": {
    "amount": "100",
    "bank_utr": "123456",
    "status": "success",
    "tid": "ENP123456",
    "order_id": "TXN_9988",
    "payer_vpa": "customer@upi"
  }
}
            

cURL Request:

curl --location 'https://api.ipaisapay.com/v1/api/payin/check_status' \
  --header 'Authorization: ipp_live_xxxxxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "order_id": "TXN_9988"
}'
            

POST Create Payout

Send money to a beneficiary's bank account via IMPS/NEFT/RTGS.

POST https://api.ipaisapay.com/v1/api/payout/create_payout

Request Body:

Parameter	Type	Required	Description
mid	String	Required	Unique transaction ID for tracking
name	String	Required	Beneficiary name (max 25 chars)
account_number	String	Required	Bank account number
ifsc_code	String	Required	11-character IFSC code
amount	Integer	Required	Amount in rupees (₹100-₹25,000)
bank	String	Optional	Bank name (auto-detected from IFSC)

200 OK

{
  "status": "true",
  "msg": "Transaction Successful",
  "order_details": {
    "bank_utr": 1,
    "tid"span>: 1,
    "status": "pending",
    "reference_id": "PAY-2024-001"
  }
}
            

cURL Request:

curl --location 'https://api.ipaisapay.com/v1/api/payout/create_payout' \
  --header 'Authorization: ipp_live_xxxxxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "mid": "PAY-2024-001",
  "name": "Ramesh Kumar",
  "account_number": "1234567890123",
  "ifsc_code": "HDFC0001234",
  "amount": "5000",
  "bank": "HDFC Bank"
}'
            

POST Check Payout Status

Check the status of a payout transaction. Returns success/pending/failed status and UTR.

POST https://api.ipaisapay.com/v1/api/payout/check_status

Request Body:

Parameter	Type	Description
mid	String	Transaction ID from create_payout request

200 OK

{
  "status": "true",
  "msg": "Status Found",
  "order_details": {
    "amount": "5000",
    "bank_utr": "123456",
    "status": "success",
    "tid": "123456",
    "mid": "PAY-2024-001",
    "beneficiary_name": "Ramesh Kumar"
  }
}
            

cURL Request:

curl --location 'https://api.ipaisapay.com/v1/api/payout/check_status' \
  --header 'Authorization: ipp_live_xxxxxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "mid": "PAY-2024-001"
}'
            

HTTP Status Codes

Code	Meaning	Description
200	OK	Request successful. Check the "status" field in response for transaction result.
400	Bad Request	Invalid parameters. Check request body for errors.
401	Unauthorized	Invalid or missing API key. Check Authorization header.
429	Rate Limit	Too many requests. Wait before retrying.
500	Server Error	Internal server error. Try again after a few minutes.