The pay namespace covers three sub-surfaces underDocumentation Index
Fetch the complete documentation index at: https://nyuchidocs-mintlify-nyuchi-api-gateway-1778247744.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
/v1/pay. Each one is wired to the nyuchi_pay_db Supabase project, but the database schema is not yet provisioned—data endpoints currently return HTTP 501. Use the status endpoint to discover readiness without triggering a 501.
| Sub-namespace | Purpose |
|---|---|
/v1/pay/wallet | User wallets, balances, and transaction history. |
/v1/pay/tokens | Token types and lifecycle stage (MIT, MXT, NST). |
/v1/pay/gateway | Fiat on/off-ramps, deposits, withdrawals, third-party processors. |
Check readiness
GET /v1/pay/status is always available. It tells the caller whether the gateway has credentials for the pay database and whether the schema is ready.
configured is false, the gateway has no pay-DB credentials in this environment. When configured is true but schema_ready is false, data endpoints return 501 until the schema lands.
Endpoints
| Method | Path | Auth | Status today |
|---|---|---|---|
GET | /v1/pay/status | Public | Always live. |
GET | /v1/pay/wallet/ | Required | 501 — schema pending. |
GET | /v1/pay/wallet/transactions | Required | 501 — schema pending. |
GET | /v1/pay/tokens/ | Required | 501 — schema pending. |
GET | /v1/pay/tokens/{token_symbol} | Required | 501 — schema pending. |
GET | /v1/pay/gateway/providers | Required | 501 — schema pending. |
POST | /v1/pay/gateway/deposit | Required | 501 — schema pending. |
POST | /v1/pay/gateway/withdraw | Required | 501 — schema pending. |
Build clients against the documented shapes today. When the schema is provisioned, endpoints will switch from 501 to live responses without route changes.
Configuring the pay database
status—reports configured: false.