Nexus Star Developer API
Build on Nexus Star Services with server-side integrations for crypto payments, email verification,
and account-linked developer tools. All public endpoints live under /v1 on the API gateway.
/v2 surface is reserved for the Nexus Star storefront itself.
Quick start
- Create an account at v3xyservices.com (email + verification code, or Discord).
- Open Account → Developer and generate a developer API key with the scopes you need.
- Add at least one payout wallet for the crypto assets you plan to accept.
- Call the API from your server using the key in the
X-V3XY-API-Keyheader.
curl -X POST "https://api.nexusstar.org/v1/developer/payments/crypto" \
-H "X-V3XY-API-Key: v3xy_dev_your_secret_here" \
-H "Content-Type: application/json" \
-d '{
"asset": "LTC",
"amount_usd_cents": 2500,
"customer_email": "[email protected]",
"external_id": "order-1001"
}'
The response includes a wallet_address and amount_crypto for your customer to pay.
Poll payment status or use webhooks for confirmation.
Base URL
All requests use HTTPS. Paths in this documentation are relative to the versioned base URL.
| Surface | Base URL | Audience |
|---|---|---|
| Customer API | https://api.nexusstar.org/v1 | You and your servers |
| Storefront API | https://api.nexusstar.org/v2 | v3xyservices.com only |
Send Content-Type: application/json on requests with a JSON body. A health probe is available at
GET /v1/health.
Authentication
V3XY uses two credential types. Do not mix them.
Developer API keys
Use when your backend calls the API on behalf of your V3XY developer account. Keys are issued in the account dashboard and must never appear in client-side code, mobile app binaries, or public repositories.
| Item | Value |
|---|---|
| Header | X-V3XY-API-Key |
| Format | v3xy_dev_ followed by a random secret |
| Usage | Server-side only — requests carrying a browser Origin are rejected |
Key scopes
| Scope | Allows |
|---|---|
payments:create | Create crypto payment requests |
payments:read | Read payment status for your account |
wallets:read | List saved payout addresses (masked) |
webhooks:manage | Register or update webhook URLs |
verify:send | Send email verification codes to your users |
Keys without the required scope receive HTTP 403 with code: "api_key_scope".
Session tokens
Use when a logged-in person manages their account — creating keys, adding wallets, or viewing their own data.
| Item | Value |
|---|---|
| Header | Authorization: Bearer <session_token> |
| Obtained via | Email sign-in or Discord OAuth (see Account endpoints) |
| Lifetime | Short-lived; sign in again to refresh |
Payout wallets
Before accepting crypto through the API, add wallet addresses you control in Account → Developer → Payout wallets. V3XY never asks for private keys or seed phrases.
| Field | Description |
|---|---|
asset | e.g. LTC, XRP, USDT_BSC, USDT_TRC20 |
address | Your public receive address |
label | Optional name for your reference |
is_default | Used when a payment does not specify an asset-specific wallet |
Payments already in flight keep the address they were created with. Supported assets: BTC, LTC, DOGE, BCH, ETH, BNB, MATIC, SOL, TRX, XRP, and USDT on BEP20, TRC20, and ERC20.
API reference
All paths below are relative to the base URL. Unless marked Session, authenticate with
X-V3XY-API-Key.
Creates a crypto payment intent. Funds are sent to your payout wallet. V3XY monitors the chain and updates status; webhooks fire on detection and confirmation.
Request body
{
"asset": "LTC",
"amount_usd_cents": 4999,
"customer_email": "[email protected]",
"external_id": "your-order-12345",
"metadata": { "cart_id": "abc" }
}
| Field | Required | Description |
|---|---|---|
asset | Yes | Crypto asset code |
amount_usd_cents | Yes | Integer USD cents (minimum 100) |
customer_email | Yes | Buyer email for receipts |
external_id | No | Your order / idempotency reference (max 128 chars) |
metadata | No | Opaque JSON returned in webhooks (max 4 KB) |
Response 200
{
"success": true,
"payment_ref": "cp_8f3a…",
"asset": "LTC",
"wallet_address": "ltc1q…",
"amount_crypto": "0.08421500",
"amount_usd": "49.99",
"expires_at": "2027-05-22T18:45:00.000Z",
"confirmations_required": 1
}
Reusing the same external_id returns the original payment instead of creating a duplicate.
Returns the current status of a payment you created, refreshing it against the chain.
{
"success": true,
"payment_ref": "cp_8f3a…",
"status": "awaiting",
"asset": "LTC",
"amount_crypto": "0.08421500",
"amount_usd_cents": 4999,
"confirmations": 0,
"confirmations_required": 1,
"tx_hash": null,
"external_id": "your-order-12345",
"expires_at": "2027-05-22T18:45:00.000Z"
}
| status | Meaning |
|---|---|
awaiting | No matching transaction yet |
detected | Transaction seen; waiting for confirmations |
confirmed | Paid — webhook delivered |
expired | Quote window ended unpaid |
cancelled | Voided before payment |
Sends a 6-digit verification code to an email address your integration is verifying. Subject to per-account rate limits and the acceptable-use policy.
{ "email": "[email protected]", "purpose": "signup" }
{ "success": true, "message": "Verification code sent.", "expires_in_seconds": 900 }
Confirm the code with POST /developer/verify/check-code using
{ "email": "...", "code": "123456" }, which responds with { "verified": true }.
Account endpoints Session
For people signing into a V3XY account. Use Authorization: Bearer <session_token>.
| Method | Path | Description |
|---|---|---|
| POST | /auth/email/send-code | Send register or login code |
| POST | /auth/email/register | Create account with email + code |
| POST | /auth/email/login-challenge | Step 1 — password check, sends code |
| POST | /auth/email/login | Sign in with password, or with an emailed code |
| GET | /auth/me | Resolve the current session |
| POST | /auth/logout | Revoke every token issued to the account |
| GET | /developer/status | Approval state for developer access |
| GET | /developer/api-keys | List your API keys (prefix only) |
| POST | /developer/api-keys | Create key — secret shown once |
| DELETE | /developer/api-keys?id= | Revoke a key |
| GET | /developer/wallets | List payout wallets |
| POST | /developer/wallets | Add or update wallet |
| DELETE | /developer/wallets?id= | Remove wallet |
| GET | /developer/webhooks | Read the registered webhook |
| POST | /developer/webhooks | Register a webhook, returns the signing secret |
Discord sign-in for browser users: open https://api.nexusstar.org/v1/auth/login and complete
OAuth. You are redirected back to the storefront with a session attached.
Webhooks
Register an HTTPS URL in Account → Developer → Webhooks. V3XY signs each delivery.
Header: X-V3XY-Signature: t=<unix>,v1=<hmac_hex>
expected = HMAC_SHA256(webhook_secret, "<t>.<raw_body>")
| Event | When |
|---|---|
payment.detected | Incoming transaction seen on chain |
payment.confirmed | Required confirmations reached |
payment.expired | Payment window closed unpaid |
{
"type": "payment.confirmed",
"created_at": "2027-05-22T18:12:00.000Z",
"data": {
"payment_ref": "cp_8f3a…",
"external_id": "your-order-12345",
"asset": "LTC",
"amount_usd_cents": 4999,
"tx_hash": "abc…",
"metadata": { "cart_id": "abc" }
}
}
Respond with 2xx within 10 seconds. Always verify the signature before trusting an event.
Errors
{ "success": false, "error": "Human-readable message", "code": "machine_code" }
| HTTP | code | Meaning |
|---|---|---|
| 400 | invalid_amount | Amount missing or below the minimum |
| 401 | api_key_missing | No X-V3XY-API-Key header |
| 401 | session_required | Session missing or expired |
| 403 | api_key_invalid | Key revoked or unknown |
| 403 | api_key_scope | Key not permitted for this endpoint |
| 403 | api_key_origin | Developer key used from a browser origin |
| 403 | api_pending_approval | Developer account not approved yet |
| 429 | rate_limited | Too many requests — slow down |
| 503 | wallet_not_configured | No payout wallet for that asset |
Rate limits
| Area | Typical limit |
|---|---|
| Payment creation | 60 requests / minute per key |
| Payment status | Refreshed against the chain at most every few seconds |
| Verification email | 10 messages / hour per recipient |
| Account sign-in | 12 attempts / 15 minutes per email |
Storefront surface (/v2)
The V3XY storefront uses a separate versioned surface so customer integrations stay stable while the shop evolves. It is documented here for transparency; it is not intended for third-party use and is restricted by CORS to V3XY origins.
| Area | Endpoints |
|---|---|
| Session | /v2/auth/login, /v2/auth/callback, /v2/auth/email/*, /v2/auth/me |
| Storefront | /v2/site-status, /v2/catalog-prices, /v2/stock |
| Checkout | /v2/create-checkout, /v2/crypto/create, /v2/crypto/status, /v2/check-status |
| Portal | /v2/orders, /v2/get-order, /v2/loyalty/* |
| Staff tooling | /v2/admin/*, /v2/staff-apply/* |
Security practices
- Never commit API keys to version control or expose them in front-end code.
- Use separate keys for staging and production environments.
- Revoke keys immediately if you suspect a leak.
- Register webhook URLs on HTTPS endpoints you control only.
- Always verify webhook signatures before trusting payment events.
- Use
external_idfor idempotency on your side. - Only add payout wallets you control — V3XY cannot recover misdirected funds.
Terms of Service
These Terms of Service (“Terms”) govern your access to and use of the Nexus Star Developer API (“API”) operated by Nexus Star Services, whose parent company is Nexus Star Enterprises LLC (“V3XY”, “we”, “us”). By creating a developer account, generating an API key, or making API requests, you agree to these Terms.
1. Eligibility
You must be at least 18 years old (or the age of majority in your jurisdiction) and able to form a binding contract. You represent that your use of the API complies with all applicable laws, including financial, consumer-protection, and anti-money-laundering regulations in your region.
2. API access
We grant you a limited, non-exclusive, non-transferable, revocable license to use the API according to this documentation and the scopes assigned to your keys. We may change, suspend, or discontinue any endpoint with reasonable notice when possible.
3. Your responsibilities
- Keep API keys, webhook secrets, and session tokens confidential.
- Ensure payout wallet addresses are accurate and under your control.
- Provide accurate customer email addresses when required for receipts and support.
- Implement idempotency and error handling suitable for production workloads.
- Do not probe, scan, or circumvent rate limits, authentication, or security controls.
4. Crypto payments
Crypto payment endpoints generate payment instructions to blockchain addresses you configure. V3XY monitors public chain data to detect payments. We do not custody private keys, hold funds on your behalf, or guarantee blockchain confirmation times. Network fees, exchange-rate movement, and user error are your and your customers’ responsibility to communicate clearly.
5. Verification email
Verification endpoints may only be used for legitimate identity or account-verification flows. You must not send unsolicited marketing email through the API. You are responsible for obtaining any consent required under CAN-SPAM, GDPR, or similar laws before sending codes to end users.
6. Fees
API access may be subject to fees, usage tiers, or transaction-based pricing as published on the storefront or in your account dashboard. We will provide notice before fee changes apply to your account.
7. Suspension and termination
We may suspend or revoke API keys immediately for security risk, abuse, fraud, chargeback patterns, legal requirements, or breach of these Terms. You may revoke your own keys at any time in the account dashboard.
8. Disclaimers
THE API IS PROVIDED “AS IS” AND “AS AVAILABLE” WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. WE DO NOT WARRANT UNINTERRUPTED OR ERROR-FREE OPERATION.
9. Limitation of liability
TO THE MAXIMUM EXTENT PERMITTED BY LAW, V3XY AND ITS AFFILIATES SHALL NOT BE LIABLE FOR INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL, OR PUNITIVE DAMAGES, OR FOR LOSS OF PROFITS, DATA, OR GOODWILL, ARISING FROM YOUR USE OF THE API. OUR AGGREGATE LIABILITY FOR ANY CLAIM RELATING TO THE API SHALL NOT EXCEED THE GREATER OF (A) AMOUNTS YOU PAID US FOR API SERVICES IN THE TWELVE MONTHS BEFORE THE CLAIM OR (B) ONE HUNDRED U.S. DOLLARS (USD $100).
10. Indemnification
You agree to indemnify and hold harmless V3XY from claims arising out of your applications, your customers’ use of your integrations, your violation of these Terms, or your violation of applicable law.
11. Governing law
These Terms are governed by the laws of the State of Florida, United States, without regard to conflict-of-law principles, except where mandatory consumer protections in your country of residence apply.
12. Contact
Questions about these Terms: contact support through the email on your V3XY account or the help channels listed at v3xyservices.com.
Privacy Policy
This Privacy Policy describes how Nexus Star Services and its parent company, Nexus Star Enterprises LLC, collect and use information when you use the Developer API and related account features.
Information we collect
- Account data: email, display name, Discord identifier (if linked), and authentication metadata.
- Developer data: API key prefixes, scopes, wallet addresses you register, webhook URLs, and usage timestamps.
- Payment data: payment references, amounts, assets, transaction hashes, customer emails you submit, and
external_id/metadatafields. - Technical data: IP address, request timestamps, user-agent, and security logs for abuse prevention.
How we use information
- Provide, secure, and improve the API.
- Detect fraud, abuse, and unauthorized access.
- Send verification codes and payment-related emails you or your integration request.
- Comply with legal obligations and respond to lawful requests.
Retention
We retain account and transaction records as needed for operations, dispute resolution, and legal compliance. Revoked API keys are retained in hashed form for audit purposes but cannot be used for authentication.
Sharing
We do not sell personal information. We may share data with infrastructure providers (hosting, email delivery, database) under contractual confidentiality obligations, or when required by law.
Your choices
You may update account details, revoke API keys, and delete payout wallets from the account dashboard. Contact support to request account deletion, subject to legal retention requirements.
Acceptable use
You may not use the V3XY API to:
- Process payments for illegal goods, services, or sanctions-violating activity.
- Harass, phish, spam, or send verification codes without appropriate consent.
- Impersonate V3XY, another merchant, or misrepresent affiliation with Nexus Star Services.
- Overload, reverse-engineer, or attempt unauthorized access to V3XY systems.
- Store or transmit private keys, seed phrases, or cardholder data through API metadata fields.
Violations may result in immediate key revocation and account suspension.
Credits
Nexus Star Services — official digital commerce, developer API, and customer platform. Parent company: Nexus Star Enterprises LLC. Star Services LLC has been discontinued.
| Resource | Link |
|---|---|
| Storefront | https://nexusstar.org |
| Customer API | https://api.nexusstar.org/v1 |
| Storefront API | https://api.nexusstar.org/v2 |
| Staff applications | https://apply.v3xyservices.com |
Changelog — initial public developer documentation: gateway /v1, developer keys, crypto payments,
verification, webhooks, and legal terms.