Developer documentation
SettleX Payments API
Typical integration flow for deposits, payouts, and settlement. Start in sandbox and go live in 24 hours.
Base URL
https://api.aurorapay.io
Quickstart
Create a payment, redirect the user, confirm status via webhook.
1. Create deposit
Generate a payment link or iFrame checkout for UPI, PKR, or BDT.
2. Confirm payment
Listen to webhooks and verify signatures for final status.
3. Settle funds
Settle to your default currency account with flexible schedules.
curl -X POST "https://api.aurorapay.io/deposits" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_KEY" \
-d '{
"amount": "400",
"currency": "PKR",
"method": "UPI",
"order_id": "ORD-9211",
"return_url": "https://merchant.example/return"
}'
Authentication
Use a secret API key in the Authorization header. Rotate keys in the dashboard.
Authorization: Bearer YOUR_KEY
Verify every webhook with HMAC SHA256
Use Idempotency-Key for safe retries
Deposits
Accept customer payments via UPI, cards, wallets, and netbanking.
Payment link
Create a hosted payment page that supports UPI and local transfers.
iFrame checkout
Embed a secure checkout directly on your site.
Payment status
Poll or receive webhooks for success, failed, or pending statuses.
POST /deposits
{
"amount": "850",
"currency": "BDT",
"method": "BANK_TRANSFER",
"customer": {
"name": "Nusrat K.",
"phone": "+8801700111222"
}
}
Payouts
Send funds to vendors, creators, or customer refunds.
Single payout
Send to UPI, PKR, or BDT bank rails in real time.
Batch payouts
Upload a CSV or submit a batch payload for bulk transfers.
Refunds
Issue full or partial refunds with reason codes.
POST /payouts
{
"amount": "1200",
"currency": "PKR",
"destination": {
"type": "BANK",
"account": "0123456789",
"bank_code": "HBL"
}
}
Settlement
Configure schedules, rolling balances, and reconciliation reports.
Schedules
T+0, T+1, or custom settlement windows by region.
Balance & fees
Track fees, chargebacks, and reserve balances in one view.
Reconciliation
Download daily reports in CSV or JSON.
GET /settlements?currency=BDT&from=2026-02-01&to=2026-02-07
Webhooks
Get real-time updates for deposits, payouts, and settlements.
deposit.succeeded
Triggered when a payment is confirmed and funds are captured.
payout.completed
Triggered when a payout reaches the destination bank.
settlement.created
Triggered when a settlement batch is generated.
POST /webhooks
{
"event": "deposit.succeeded",
"data": {
"id": "dep_8h2x",
"amount": "400",
"currency": "PKR",
"status": "succeeded"
}
}