Mars-Pay Payout Integration Guide

Complete API documentation for integrating Mars-Pay Payout services

Table of Contents

Authentication

All API requests require an API Token for authentication.

Steps to generate API token:

  1. Login to Mars-Pay Dashboard
  2. Go to Profile → Developer Zone → Settings
  3. Copy or generate your API Token
Keep the token server-side only. Never expose it in frontend code.

1. Transfer Payment API

Used to send payouts via NEFT / IMPS.

Endpoint

POST https://mars-pay.in/api/payout/v1/transfer-now

Request Parameters

Parameter Type Validation Rules Required Description
api_token String required Yes Authentication token
mobile_number String required, digits:10 Yes Beneficiary's 10-digit mobile number
email String required, valid email Yes Beneficiary's email address
beneficiary_name String required Yes Beneficiary full name
ifsc_code String required, exactly 11 chars Yes IFSC code of beneficiary's bank
account_number String required Yes Beneficiary's account number
amount Number required, between:min,max Yes Transaction amount
channel_id String required Yes 1 = NEFT, 2 = IMPS
client_id String required Yes Unique client reference ID

Example: cURL Request

curl -X POST https://mars-pay.in/api/payout/v1/transfer-now \ -H "Content-Type: application/json" \ -d '{ "api_token": "YOUR_API_TOKEN", "mobile_number": "9876543210", "email": "user@example.com", "beneficiary_name": "Ravi Kumar", "ifsc_code": "HDFC0001234", "account_number": "123456789012", "amount": 500, "channel_id": "2", "client_id": "TXN1001" }'

Example: PHP Integration

Redirecting to https://mars-pay.in/login Redirecting to https://mars-pay.in/login.

Example: Node.js (Fetch API)

const fetch = require("node-fetch"); async function transferPayment() { const response = await fetch("https://mars-pay.in/api/payout/v1/transfer-now", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ api_token: "YOUR_API_TOKEN", mobile_number: "9876543210", email: "user@example.com", beneficiary_name: "Ravi Kumar", ifsc_code: "HDFC0001234", account_number: "123456789012", amount: 500, channel_id: "2", client_id: "TXN1001" }) }); const result = await response.json(); console.log(result); } transferPayment();

2. Check Balance API

Check your available balance.

Endpoint

GET https://mars-pay.in/api/telecom/v1/check-balance?api_token=YOUR_API_TOKEN

Example: cURL Request

curl -X GET "https://mars-pay.in/api/telecom/v1/check-balance?api_token=YOUR_API_TOKEN"

Example: PHP Integration

Mars-Pay

Example: Node.js (Fetch API)

const fetch = require("node-fetch"); async function checkBalance() { const response = await fetch("https://mars-pay.in/api/telecom/v1/check-balance?api_token=YOUR_API_TOKEN"); const result = await response.json(); console.log(result); } checkBalance();

Response Example

{ "status": "success", "balance": { "normal_balance": "2999.1" } }

3. Check Transaction Status API

Check the status of a transaction using your client_id.

Endpoint

GET https://mars-pay.in/api/telecom/v1/check-status?api_token=YOUR_API_TOKEN&client_id=TXN1001

Example: cURL Request

curl -X GET "https://mars-pay.in/api/telecom/v1/check-status?api_token=YOUR_API_TOKEN&client_id=TXN1001"

Example: PHP Integration

Mars-Pay

Example: Node.js (Fetch API)

const fetch = require("node-fetch"); async function checkStatus() { const response = await fetch("https://mars-pay.in/api/telecom/v1/check-status?api_token=YOUR_API_TOKEN&client_id=TXN1001"); const result = await response.json(); console.log(result); } checkStatus();

Response Examples

✅ Success
{ "status": true, "message": "Success: Data found successfully.", "data": { "payid": 673, "provider": "Payout", "date": "2024-10-19 14:15:37", "number": "9876543210", "amount": "500.00", "profit": "0.00", "txnid": null, "client_id": "TXN1001", "ip_address": "", "status": "Success" } }
❌ Failure
{ "status": true, "message": "Success: Data found successfully.", "data": { "payid": 673, "provider": "Payout", "date": "2024-10-19 14:15:37", "number": "9876543210", "amount": "500.00", "profit": "0.00", "txnid": null, "client_id": "TXN1001", "ip_address": "", "status": "Failed" } }
⏳ Pending
{ "status": true, "message": "Success: Data found successfully.", "data": { "payid": 673, "provider": "Payout", "date": "2024-10-19 14:15:37", "number": "9876543210", "amount": "500.00", "profit": "0.00", "txnid": null, "client_id": "TXN1001", "ip_address": "", "status": "Pending" } }

4. Callback Handling

If a payout is pending, Mars-Pay will notify your Callback URL with the final status.

Callback Payload Example

{ "status": "success", "message": "Payout processed successfully", "utr": "1234567890UTR", "payid": "12345", "client_id": "TXN1001" }

Server Requirements