Pay AGL API Documentation

Quickstart for merchants

1. Log in to the merchant dashboard.
2. Open API & Webhooks and copy your live API key. Keep your API secret private; it is used to verify Pay AGL webhooks.
3. Submit your server IP for approval in the IP whitelist section if your account uses whitelist enforcement.
4. Configure pay-in and payout callback URLs.
5. Use the examples below from your backend server, never from browser JavaScript.

Authentication

Send your live merchant API key on every API request.

x-api-key: pk_live_your_merchant_key
Content-Type: application/json

POSTCreate payment

Creates a pay-in and returns hosted checkout URLs plus app-specific UPI deeplinks. order_id is idempotent per merchant: retrying the same order returns the existing transaction.

curl -X POST https://payagl.com/api/payment/create \
  -H "x-api-key: pk_live_your_merchant_key" \
  -H "Content-Type: application/json" \
  -d '{
    "order_id": "ORD-10001",
    "amount": 1500.00,
    "currency": "INR",
    "customer_name": "Ramesh Kumar",
    "customer_email": "ramesh@example.com",
    "customer_phone": "9999999999",
    "description": "Order #10001",
    "callback_url": "https://merchant.example/webhooks/payin",
    "redirect_url_after": "https://merchant.example/thank-you"
  }'

{
  "txn_id": "TXN...",
  "order_id": "ORD-10001",
  "status": "PENDING",
  "amount": 1500,
  "currency": "INR",
  "redirect_url": "/api/payment/redirect/TXN...",
  "checkout_url": "/checkout.html?id=TXN...",
  "payment_links": {
    "ready": true,
    "upi_deeplink": "upi://pay?...",
    "phonepe_intent": "phonepe://pay?...",
    "gpay_intent": "tez://upi/pay?...",
    "paytm_intent": "paytmmp://pay?...",
    "qr_image_url": null,
    "expires_at": "2026-06-23T...",
    "error": null
  }
}

Hosted vs custom checkout

• Hosted checkout: redirect the customer to checkout_url.
• Custom checkout: open the correct value from payment_links for PhonePe, GPay, Paytm, or generic UPI.

GETPayment links refresh

Use this if payment_links.ready is false, if a QR/deeplink provider returns an error, or if you want to refresh UPI links for a pending transaction.

curl "https://payagl.com/api/payment/TXN.../payment-links?retry=true" \
  -H "x-api-key: pk_live_your_merchant_key"

{
  "txn_id": "TXN...",
  "order_id": "ORD-10001",
  "status": "PENDING",
  "payment_links": { "ready": true, "upi_deeplink": "upi://pay?..." }
}

GETPayment status

curl https://payagl.com/api/payment/status/TXN... \
  -H "x-api-key: pk_live_your_merchant_key"

{
  "txn_id": "TXN...",
  "order_id": "ORD-10001",
  "merchant_id": "m_...",
  "amount": 1500,
  "currency": "INR",
  "status": "SUCCESS",
  "completed_at": 1782220000000
}

Payment statuses: PENDING, SUCCESS, FAILED.

GETWallet balance

Returns pay-in wallet and payout wallet balances. API payouts debit the payout wallet.

curl https://payagl.com/api/wallet/balance \
  -H "x-api-key: pk_live_your_merchant_key"

{
  "merchant_id": "m_...",
  "currency": "INR",
  "payin_wallet": {
    "balance": 150000,
    "pending_settlement": 5000,
    "pending_topup": 0,
    "pending_total": 5000,
    "available": 145000
  },
  "payout_wallet": { "balance": 80000, "available": 80000 },
  "balance": 150000,
  "payout_wallet_balance": 80000,
  "available": 145000
}

POSTCreate API payout

Sends a bank payout (IMPS or NEFT) from your payout wallet to a beneficiary account. Your merchant account must have API payout commission configured. total_debit = amount + payout_commission. order_id is idempotent per merchant. Minimum amount is 150.

curl -X POST https://payagl.com/api/payout/create \
  -H "x-api-key: pk_live_your_merchant_key" \
  -H "Content-Type: application/json" \
  -d '{
    "order_id": "WD-10001",
    "amount": 500.00,
    "method": "IMPS",
    "beneficiary_name": "Ramesh Kumar",
    "account_number": "123456789012",
    "ifsc": "HDFC0001234",
    "callback_url": "https://merchant.example/webhooks/payout"
  }'

Required fields

Optional fields

{
  "payout_id": "PAYOUT...",
  "order_id": "WD-10001",
  "merchant_id": "m_...",
  "amount": 500,
  "status": "PROCESSING",
  "payout_commission": 10,
  "total_debit": 510,
  "provider_ref": "PAYOUT...",
  "utr": ""
}

Payouts return PROCESSING first; the final SUCCESS/FAILED state is delivered to your callback_url webhook (and reflected in Payout status). On failure, the full total_debit is refunded to your payout wallet.

GETPayout status

curl https://payagl.com/api/payout/status/PAYOUT... \
  -H "x-api-key: pk_live_your_merchant_key"

{
  "payout_id": "PAYOUT...",
  "order_id": "WD-10001",
  "status": "SUCCESS",
  "amount": 500,
  "payout_commission": 10,
  "total_debit": 510,
  "provider_ref": "PAYOUT...",
  "utr": "123456789012"
}

Payout statuses: PROCESSING, SUCCESS, FAILED.

Webhooks from Pay AGL

Pay AGL sends webhooks to your saved callback URL or the per-request callback_url. Verify the signature against the exact raw request body using your merchant API secret.

POST https://merchant.example/webhooks/payin
Content-Type: application/json
X-PayAGL-Signature: hex_hmac_sha256(api_secret, raw_body)
X-PayAGL-Event: payment.pending | payment.success | payment.failed
X-PayAGL-Delivery-Id: uuid

Payment webhook body

{
  "txn_id": "TXN...",
  "order_id": "ORD-10001",
  "merchant_id": "m_...",
  "amount": 1500,
  "currency": "INR",
  "status": "SUCCESS",
  "gateway": "Rebel Rupee",
  "gateway_ref": "...",
  "utr": "123456789012",
  "completed_at": 1782220000000
}

Payout webhook body

{
  "payout_id": "PAYOUT...",
  "order_id": "WD-10001",
  "merchant_id": "m_...",
  "amount": 500,
  "status": "SUCCESS",
  "utr": "123456789012",
  "payout_commission": 10,
  "total_debit": 510,
  "completed_at": "2026-06-23T..."
}

Node.js verification

const crypto = require("crypto");

function verifyPayAGL(rawBody, signature, apiSecret) {
  const expected = crypto
    .createHmac("sha256", apiSecret)
    .update(rawBody)
    .digest("hex");
  return expected === signature;
}

POSTSupport tickets

Raise and track support tickets directly from your own dashboard or server using your API key. Tickets appear in the Pay AGL support console and our team replies there.

Create a ticket

curl -X POST https://payagl.com/api/support/tickets \
  -H "x-api-key: pk_live_your_merchant_key" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "Payout WD-10001 not credited",
    "category": "Payouts",
    "priority": "high",
    "related_txn": "WD-10001",
    "message": "Customer says the payout has not arrived after 2 hours."
  }'

{
  "ticket_id": "tk_ab12cd",
  "subject": "Payout WD-10001 not credited",
  "category": "Payouts",
  "priority": "high",
  "status": "open",
  "related_txn": "WD-10001",
  "created_at": "2026-06-25T...",
  "updated_at": "2026-06-25T...",
  "messages": [ { "by": "merchant", "at": "2026-06-25T...", "text": "Customer says..." } ]
}

Categories: General, Payments / Pay-in, Payouts, Settlements, API / Integration, KYC / Account, Dispute / Chargeback, Other. Priorities: low, normal, high, urgent.

GET List your tickets

curl "https://payagl.com/api/support/tickets?status=open" \
  -H "x-api-key: pk_live_your_merchant_key"

GET Fetch one ticket

curl https://payagl.com/api/support/tickets/tk_ab12cd \
  -H "x-api-key: pk_live_your_merchant_key"

Reply to a ticket

curl -X POST https://payagl.com/api/support/tickets/tk_ab12cd/reply \
  -H "x-api-key: pk_live_your_merchant_key" \
  -H "Content-Type: application/json" \
  -d '{ "message": "Any update on this?" }'

Ticket statuses: open, pending (awaiting your reply), resolved, closed. Each message has by = merchant or support. Internal staff notes are never returned.

Error responses

Typical error body:

{ "detail": "message or validation details" }