API & Webhook Reference

Clean, high-performance financial infrastructure documentation designed with Apple-grade clarity. Integrate secure payment gateways and callbacks effortlessly.

Quick Start Guide Explore Endpoints
Quick Start Guide

Implement iPaisaPay services in your application stack in 4 clear, frictionless steps.

1
API Credentials

Generate your live token authentication keys securely from your partner dashboard.

2
Sandbox Mode

Test your integrations instantly against mock banking endpoints without real monetary risk.

3
Configure Webhooks

Provide your server callback URLs to automatically receive real-time status updates.

4
Go Live

Swap out your sandbox credentials with live production keys and scale your collection volume.

GET Get Account Balance

Fetch real-time merchant liquidity, available limits, and working capital reserves.

GET https://partner.ipaisapay.com/v2/api/account/balance
Header Parameter Type Requirement Description
Authorization String Required Your API authorization bearer token
Content-Type String Required Set to application/json
POST Create Payin Intent

Initialize a UPI collection intent, generating dynamic deeplinks and checkout URLs.

POST https://partner.ipaisapay.com/v2/api/payin/upi_intent
Parameter Type Requirement Description
name String Required Customer full name
email String Required Customer email id
mobile String Required Customer mobile number
amount Integer Required Amount in INR
transaction_id String Required Unique order reference code from your system
POST Check Payin Status

Verify real-time completion status and bank UTR markers for collection orders.

POST https://partner.ipaisapay.com/v2/api/payin/check_status
Parameter Type Requirement Description
transaction_id String Required The unique transaction reference id
POST Create Payout

Initiate immediate bank transfers via IMPS, NEFT, or RTGS channels to beneficiary accounts.

POST https://partner.ipaisapay.com/v2/api/payout/create_payout
Parameter Type Requirement Description
mid String Required Unique merchant reference ID for tracking
name String Required customer full name
account_number String Required Beneficiary bank account number
ifsc_code String Required Bank branch IFSC identifier
amount Integer Required Transfer value in INR
POST Check Payout Status

Query bank remittance confirmation and settlement states for previously routed payouts.

POST https://partner.ipaisapay.com/v2/api/payout/check_status
Parameter Type Description
mid String Merchant tracking identifier assigned during create_payout
WEBHOOK Payin Callback (Webhook)

Automated server-to-server POST notification sent to your webhook URL the moment a customer collection succeeds or fails.

Incoming Webhook Payload Example
{
  "status": "true",
  "msg": "Payin Webhook",
  "order_details": {
    "amount": "100.00",
    "bank_utr": "676034893990",
    "status": "success",
    "tid": "IPPAY326020981911908484",
    "order_id": "213053084397",
    "payee_vpa": "Upi"
  }
}
WEBHOOK Payout Webhook

Automated server-to-server notification dispatched when a beneficiary fund remittance concludes.

Incoming Webhook Payload Example
{
  "status": "true",
  "msg": "Payout Webhook",
  "order_details": {
    "status": "success",
    "bank_utr": "12345678",
    "tid": "12345678",
    "amount": "300",
    "mid": "m1234"
  }
}