API v2 Reference

The MyPayIndia API v2 uses session-based authentication via Bearer tokens. All requests and responses are JSON. If you have a question or issue, ask in #dev on our Discord.

Conventions

Authentication

Log in via POST /api/v2/auth/login to receive a session ID. Pass it as Authorization: Bearer <session_id> on all authenticated requests.
(You will still get a cookie from this endpoint, like in v1, and can use it instead if you want)

Money

All amounts are integers in paisa
100 = 1.00 INR
10000 = 100.00 INR

Timestamps

All timestamps are ISO 8601 with UTC offset
2026-05-05T14:30:00+00:00

Response Shape

Success: {"success": true, "data": { ... }}
Error: {"success": false, "error": 1001, "message": "..."}

Error Codes

Error codes identify the error type. The message field is human readable but should not be parsed programatically as it can change over time.

Maintenance Mode

Any endpoint may return 503 with error code 9003 during maintenenace mode.

Authentication

POST /api/v2/auth/login Public

Authenticate and receive a session ID.

Request Body

Parameter Type Description
username string required Username or email address
password string required Account password
totp_code string optional TOTP authenticator code (required if 2FA is enabled)

Response

{
    "success": true,
    "data": {
        "session_id": "a1b2c3d4e5f6...",
        "user": {
            "id": 123,
            "username": "johnpayment",
            "role": "user"
        }
    }
}

Errors

Code HTTP Description
1005 401 Invalid username/email or password
1002 401 2FA code required but not provided
1010 401 Invalid 2FA code
1003 403 Account is suspended
On success, use the returned session_id as Authorization: Bearer <session_id> on all authenticated requests.

User

GET /api/v2/user/info Authenticated

Get profile and balance information for the authenticated user.

Response

{
    "success": true,
    "data": {
        "id": 11,
        "username": "johnpayment",
        "first_name": "John",
        "last_name": "Payment",
        "email": "[email protected]",
        "balance": 1234500,
        "role": "user",
        "created": "2025-12-01T12:05:00+00:00",
        "mfa_enabled": true
    }
}

Errors

Code HTTP Description
1001 401 Not authenticated
Balance is returned in paisa. Divide by 100 for display. Make sure it always has exactly two decimal points. NOTE: The date_of_birth field is no longer used and therefore not shown in the example response, but still exists in the actual response to prevent apps from crashing, and will always return null.
GET /api/v2/user/restrictions Authenticated

Get active restrictions on the authenticated user's account.

Response

{
    "success": true,
    "data": {
        "restrictions": {
            "frozen": {
                "active": true,
                "value": null,
                "expires_at": "2026-06-01T00:00:00+00:00"
            }
        }
    }
}

Errors

Code HTTP Description
1001 401 Not authenticated
Returns an empty object {} if no restrictions are active.
GET /api/v2/user/session/list Authenticated

List active and recently invalidated sessions for the authenticated user.

Response

{
    "success": true,
    "data": {
        "sessions": [
            {
                "id": "a1b2c3...",
                "device_info": "macOS",
                "ip": "1.50.100.200",
                "created_at": "2026-05-01T10:00:00+00:00",
                "last_active": "2026-05-05T14:30:00+00:00",
                "invalidated": false,
                "invalidated_at": null,
                "current": true
            }
        ]
    }
}

Errors

Code HTTP Description
1001 401 Not authenticated
POST /api/v2/user/session/invalidate Authenticated

Invalidate (log out) a specific session.

Request Body

Parameter Type Description
session_id string required The session ID to invalidate

Response

{
    "success": true
}

Errors

Code HTTP Description
9004 400 Invalid input or missing session_id
1001 401 Not authenticated
9005 404 Session not found or already invalidated
POST /api/v2/user/verify-email Authenticated

Send a verification email to the authenticated user's email address.

Response

{
    "success": true
}

Errors

Code HTTP Description
1013 400 Email already verified
1001 401 Not authenticated
9006 429 Rate limited (60 second cooldown)

Transactions

POST /api/v2/transaction/transfer Authenticated

Transfer funds to another user.

Request Body

Parameter Type Description
recipient string|integer required Recipient username or user ID
amount integer required Amount in paisa
note string optional Optional transfer note

Response

{
    "success": true,
    "data": {
        "transaction_id": "TXN-1234567890-09af",
        "status": "confirmed"
    }
}

Errors

Code HTTP Description
9004 400 Invalid or missing input
2001 400 Insufficient balance
2003 400 Cannot transfer to yourself
1001 401 Not authenticated
1003 403 Account is suspended
1004 403 Sender or recipient account is frozen
2005 403 Sender or recipient is restricted from receiving or making transactions
2002 404 Recipient not found
GET /api/v2/transaction/get Authenticated

Get details of a specific transaction.

Query Parameters

Parameter Type Description
id string|integer required Transaction database ID or transaction ID (TXN-xxx)

Response

{
    "success": true,
    "data": {
        "id": 456,
        "transaction_id": "TXN-1234567890-09af",
        "sender": {
            "id": 123,
            "username": "johnpayment"
        },
        "recipient": {
            "id": 456,
            "username": "timpurchase"
        },
        "amount": 10000,
        "note": "Thanks for the Yuri",
        "status": "confirmed",
        "created": "2026-05-01T12:33:00+00:00"
    }
}

Errors

Code HTTP Description
9004 400 Missing id
1001 401 Not authenticated
1014 403 Not a party to this transaction
GET /api/v2/transaction/list Authenticated

Get transaction history for the authenticated user.

Response

{
    "success": true,
    "data": {
        "transactions": [
            {
                "id": 456,
                "transaction_id": "TXN-1234567890-09af",
                "sender": { "id": 123, "username": "johnpayment" },
                "recipient": { "id": 456, "username": "timpurchase" },
                "amount": 10000,
                "status": "confirmed",
                "created": "2026-05-01T12:00:00+00:00",
                "note": "Thanks for the Yuri"
            }
        ]
    }
}

Errors

Code HTTP Description
1001 401 Not authenticated

Payment Links

POST /api/v2/payment-link/create Authenticated

Create a payment link. Deducts the amount from your balance immediately.

Request Body

Parameter Type Description
amount integer required Amount in paisa
note string optional Optional note

Response

{
    "success": true,
    "data": {
        "id": 123,
        "token": "a1b2c3d4...",
        "amount": 10000,
        "note": "yuri",
        "url": "https://mypayindia.com/pay/link?token=a1b2c3d4..."
    }
}

Errors

Code HTTP Description
2001 400 Insufficient balance
9004 400 Invalid input or missing amount
1001 401 Not authenticated
1003 403 Account is suspended
1004 403 Account is frozen
GET /api/v2/payment-link/list Authenticated

List all payment links created by the authenticated user.

Response

{
    "success": true,
    "data": {
        "links": [
            {
                "id": 123,
                "token": "a1b2c3d4...",
                "amount": 10000,
                "note": "yuri",
                "created": "2026-05-01T12:00:00+00:00",
                "status": "active",
                "url": "https://mypayindia.com/pay/link?token=a1b2c3d4..."
            }
        ]
    }
}

Errors

Code HTTP Description
1001 401 Not authenticated
GET /api/v2/payment-link/get Public

Get details of a payment link by its token.

Query Parameters

Parameter Type Description
token string required Payment link token

Response

{
    "success": true,
    "data": {
        "amount": 10000,
        "creator": {
            "username": "johnpayment"
        },
        "note": "yuri",
        "created": "2026-05-01T12:00:00+00:00"
    }
}

Errors

Code HTTP Description
3002 400 Payment link already claimed
3003 400 Payment link cancelled
3001 404 Payment link not found
POST /api/v2/payment-link/claim Authenticated

Claim a payment link and receive the funds.

Request Body

Parameter Type Description
token string required Payment link token

Response

{
    "success": true,
    "data": {
        "transaction_id": "TXN-1234567890-09af"
    }
}

Errors

Code HTTP Description
9004 400 Invalid input or missing token
3002 400 Payment link already claimed
1001 401 Not authenticated
1003 403 Account is suspended
3001 404 Payment link not found
POST /api/v2/payment-link/cancel Authenticated

Cancel your own payment link and refund the amount to your balance.

Request Body

Parameter Type Description
token string required Payment link token

Response

{
    "success": true
}

Errors

Code HTTP Description
9004 400 Invalid input or missing token
3002 400 Payment link was already claimed
1001 401 Not authenticated
1003 403 Account is suspended
1014 403 Not your payment link
1015 403 Would exceed account fund limits if refunded
3001 404 Payment link not found

Subscriptions

GET /api/v2/user/subscriptions/list Authenticated

List the authenticated user's subscriptions.

Query Parameters

Parameter Type Description
status string optional Filter by status: active, trialing, past_due, cancelled, expired

Response

{
    "success": true,
    "data": {
        "subscriptions": [
            {
                "subscription_id": "sub_a1b2c3d4e5f6...",
                "plan_name": "MyPayIndia Premium",
                "business_name": "MyPayIndia",
                "amount": 25000,
                "interval": "monthly",
                "interval_count": 1,
                "status": "active",
                "cancel_at_period_end": false,
                "current_period_start": "2026-06-04T10:00:00+00:00",
                "current_period_end": "2026-07-04T10:00:00+00:00",
                "cancelled_at": null,
                "created_at": "2026-06-04T10:00:00+00:00"
            }
        ]
    }
}

Errors

Code HTTP Description
1001 401 Not authenticated
POST /api/v2/user/subscriptions/cancel Authenticated

Cancel a subscription at the end of the current billing period.

Request Body

Parameter Type Description
subscription_id string required The subscription ID (sub_xxx)

Response

{
    "success": true,
    "data": {
        "subscription_id": "sub_a1b2c3d4e5f6...",
        "cancel_at_period_end": true
    }
}

Errors

Code HTTP Description
9004 400 Missing subscription_id
1001 401 Not authenticated
1003 403 Account is suspended
Cancellation takes effect at the end of the current billing period. The subscription remains active until then. Use the resume endpoint to undo.
POST /api/v2/user/subscriptions/resume Authenticated

Undo a pending cancellation and resume a subscription.

Request Body

Parameter Type Description
subscription_id string required The subscription ID (sub_xxx)

Response

{
    "success": true,
    "data": {
        "subscription_id": "sub_a1b2c3d4e5f6...",
        "cancel_at_period_end": false
    }
}

Errors

Code HTTP Description
9004 400 Missing subscription_id
1001 401 Not authenticated
1003 403 Account is suspended
Only works on subscriptions with a pending cancellation (cancel_at_period_end: true). Cannot resume already cancelled or expired subscriptions.

App

GET /api/v2/app/version_check Public

Check the latest and minimum supported app version for a platform.

Query Parameters

Parameter Type Description
platform string required App platform, either "android" or "ios"

Response

{
    "success": true,
    "data": {
        "latest_version": 26050100,
        "min_supported_version": 26040200,
        "update_url": "https://mypayindia.com/app/android"
    }
}

Errors

Code HTTP Description
9004 400 Missing or invalid platform (must be android or ios)
Apps force an update if their current version is below min_supported_version.

Public

GET /api/v2/info/leaderboard Public

Get the top 10 users by balance.

Response

{
    "success": true,
    "data": {
        "leaderboard": [
            {
                "username": "johnpayment",
                "balance": 1234500
            }
        ]
    }
}
GET /api/v2/info/team Public

Get the list of MyPayIndia team members.

Response

{
    "success": true,
    "data": {
        "team": [
            {
                "name": "John Payment",
                "role": "Intern 5",
                "avatar": "https://mypayindia.com/siteassets/images/team/johnpayment.webp",
                "joined": "2025-12-01T08:36:00+00:00",
                "socials": {
                    "Website": "https://mypayindia.com",
                    "GitHub": "https://github.com/mypayindiadevs"
                },
                "status": "current",
                "country": "US",
                "country_name": "United States",
                "country_flag": "🇺🇸",
                "role_history": [
                    {
                        "role": "Intern 5",
                        "start_date": "2025-12-01",
                        "end_date": null
                    }
                ],
                "contributions": [
                    "January redesign",
                    "MyPWAIndia"
                ],
                "quote": "Online banking of the future",
                "pride_flags": ["rainbow", "trans"]
            }
        ]
    }
}
status is one of current, past, or special_thanks. country/country_name/country_flag, quote, and pride_flags are null or an empty array/object if not set for that member. pride_flags entries are one of: rainbow, progress, trans, bisexual, pansexual, nonbinary, lesbian, mlm, asexual, genderfluid, aromantic, agender, intersex.