API Reference

Secure banking, PayIn, Payout, and utility API endpoints for Kortya Pay portal integration.

Authentication Required

An Authorization header with Bearer {token} is required for all endpoints except login.

Live Gateway URL

https://cms.kortyapayultra.com/api

1 Authentication

Authenticate user credentials and issue a secure API Bearer Token for subsequent requests.

Body Parameters

email Required

The registered developer email address.

password Required

Account password.

{
  "email": "developer@kortyapayultra.com",
  "password": "password123"
}

{
  "status": true,
  "message": "Token generated successfully.",
  "data": {
    "token": "1|abcdef1234567890...",
    "user": {
      "id": 1,
      "name": "Jai Kumar",
      "email": "developer@kortyapayultra.com",
      "unique_id": "KP_12345"
    }
  }
}

2 PayIn Collection

Generate a checkout session and UPI intent string for collecting payments.

Body Parameters

amount Required

Transaction amount (Min: 1, Max: 10000).

customer_name Required

Name of the paying customer.

redirect_url Required

Callback URL after payment.

order_id Optional

Your unique order identifier.

{
  "amount": 500,
  "customer_name": "Jai Kumar",
  "redirect_url": "https://your-domain.com/callback",
  "order_id": "ORD_992_CUSTOM"
}

{
  "status": "success",
  "message": "Payment URL generated successfully.",
  "result": {
    "payment_url": "https://cms.kortyapayultra.com/api/pay/KP123456...",
    "order_id": "ORD_992_CUSTOM",
    "txn_id": "KP123456789",
    "upi_intent": "upi://pay?pa=kortyapayultra@upi&pn=..."
  }
}

Query the current processing status for a single collection payload.

Body Parameters

order_id Required

The Order ID provided during creation.

{ 
  "order_id": "ORD_992_CUSTOM" 
}

{
  "status": "success",
  "result": {
    "status": "success",
    "order_id": "ORD_992_CUSTOM",
    "txn_id": "KP123456789",
    "amount": 500,
    "charges": 5,
    "settled_amount": 495,
    "rrn": "312345678901",
    "created_at": "2026-06-03 10:00:00"
  }
}

3 Payout Remittance

Execute secure direct payout bank dispatch requests via IMPS, NEFT, or RTGS.

Body Parameters

account_number Required

ifsc_code Req (11 Char)

account_holder Required

amount Required

Amount between 101 and 100,000.

transfer_type Required

Enum: IMPS, NEFT, RTGS

order_id Optional

{
  "account_number": "919999999999",
  "ifsc_code": "PYTM0123456",
  "account_holder": "Jai Kumar",
  "amount": 5000,
  "transfer_type": "IMPS",
  "order_id": "TXN_PAYOUT_91002"
}

{
  "status": true,
  "message": "Transaction placed and is pending.",
  "data": {
    "txn_id": "TXN_PAYOUT_91002",
    "amount": 5000,
    "rrn": "315421998877",
    "charges": 15,
    "total_deducted": 5015,
    "status": "PENDING"
  }
}

Check precise details for a single remittance transaction.

Path Parameters

txn_id Required

Your original order_id or reference ID.

Response

{
  "status": true,
  "data": {
    "txn_id": "TXN_PAYOUT_91002",
    "rrn": "315421998877",
    "amount": 5000,
    "charges": 15,
    "status": "success",
    "created_at": "2026-06-03 10:20:00"
  }
}

4 Wallet Information

Retrieve the authenticated user's current wallet balances, hold amounts, and payout charges.

Response (200)

{
  "status": "success",
  "message": "Wallet details fetched successfully.",
  "data": {
    "wallet_balance": "15000.00",
    "hold_balance": "0.00",
    "lien_amount": "0.00",
    "total_deposit": "50000.00",
    "total_payouts": "35000.00",
    "payout_charges": "3.00"
  }
}