Introduction

Welcome to the RupiyaX Payout API documentation. Our API allows you to programmatically manage payouts, check balances, and track transaction statuses in real-time.

Base URL

https://api.rupiyax.com/v1

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Authentication

Authenticate your requests by including your secret API key in the URL parameters of every request.

Authentication Example

https://api.rupiyax.com/v1/balance?key=YOUR_API_KEY

Security Warning: Your API key carries many privileges, so be sure to keep it secret! Do not share your secret API key in publicly accessible areas such as GitHub, client-side code, and so forth.

Get Balance

GET /balance

Retrieve the current available balance in your wallet. The balance is returned in Indian Rupees (INR).

Parameters

Parameter	Description
key Required	Your secret API key.

Response

JSON

{
  "success": true,
  "balance": 15000.00,
  "currency": "INR"
}

Create Payout

GET /pay

Initiate a payout to a beneficiary via UPI or Bank Transfer. This endpoint immediately processes the transfer request.

Parameters

Parameter	Description
key Required	Your secret API key.
name Required	Beneficiary's full name.
amount Required	Amount to transfer in INR.
upi Required	Beneficiary's UPI ID (e.g., username@bank).
purpose Optional	Purpose of the payment (max 50 chars).

Response

JSON

{
  "success": true,
  "transaction_id": "TXN123456789",
  "status": "pending",
  "message": "Payout initiated successfully"
}

Transaction Status

GET /transactions

Check the current status of a payout transaction using its unique transaction ID.

Parameters

Parameter	Description
key Required	Your secret API key.
trx_id Required	The unique transaction ID returned from the payout request.

Response

JSON

{
  "success": true,
  "transaction_id": "TXN123456789",
  "status": "success",
  "amount": 500.00,
  "utr": "123456789012",
  "timestamp": "2024-02-10 14:30:00"
}

Errors

RupiyaX uses conventional HTTP response codes to indicate the success or failure of an API request.

Code	Description
200 OK	Request was successful.
400 Bad Request	The request was unacceptable, often due to missing a required parameter.
401 Unauthorized	No valid API key provided.
404 Not Found	The requested resource doesn't exist.
500 Server Error	Something went wrong on RupiyaX's end.