POST /api/v1/account/credit

Claim synthetic USDX credit

Claim synthetic USDX credit.

operationId: creditV1

Declared server differs from the callable one. This path declares its own servers base of https://exchange.nexus.xyz, without the /api/exchange mount the document default carries. Measured 2026-09-02, the override is not routed — https://exchange.nexus.xyz/api/v1/account/credit returns 404 while the gateway form in the sample below is routed. A client generated from this contract will aim at the override; pin the gateway base until the per-network hosts are live. See Networks.

Not reachable through CCXT. Testnet-only balance credit and the internal deposit callback. Not client-facing in CCXT terms.

Authentication: hmacAuth.

Credit synthetic USDX to the authenticated account, up to a per-API-key daily allowance (default 500 USDX, resets at midnight UTC). amount is a decimal string; omit it to claim the full remaining daily allowance. Returns 429 with code daily_limit_exceeded once the allowance is used up, and 403 with code credits_frozen while crediting is administratively frozen. This is a testnet-only faucet: the credited USDX is synthetic and carries no real-world value. Mainnet has no synthetic credit — real-funds collateral arrives through the USDX bridge — so do not build a funding flow that assumes this operation exists on every network.

Request body

Optional. CreditRequest — application/json.

{
  "amount": "500"
}

Responses

Status	Body	Meaning
200	CreditResponse	Credit applied
401	— (no schema declared)	—
403	— (no schema declared)	Refused. Either crediting is administratively frozen (credits_frozen), or a jurisdiction control refused the write (US_RESTRICTED / GEO_UNRESOLVED / RESTRICTED_JURISDICTION) — the latter are permanent for the caller's origin and must not be retried. Branch on code, which for the jurisdiction reasons equals the x-nexus-block-reason header. See “Jurisdiction restrictions” in the API description.
429	— (no schema declared)	Daily credit allowance exhausted (resets at midnight UTC)

Example

cURL

curl -X POST 'https://exchange.nexus.xyz/api/exchange/api/v1/account/credit' \
  -H 'X-API-Key: nx_7f3a1b...' \
  -H 'X-Timestamp: 1776033911836' \
  -H 'X-Signature: <hmac-sha256>' \
  -H 'Content-Type: application/json' \
  -d '{
  "amount": "500"
}'

Python

import requests

headers = {
    "X-API-Key": "nx_7f3a1b...",
    "X-Timestamp": "1776033911836",
    "X-Signature": "<hmac-sha256>",
    "Content-Type": "application/json"
}
payload = {
    "amount": "500"
}

response = requests.post("https://exchange.nexus.xyz/api/exchange/api/v1/account/credit", headers=headers, json=payload)
response.raise_for_status()
print(response.json())

TypeScript

const response = await fetch("https://exchange.nexus.xyz/api/exchange/api/v1/account/credit", {
  method: "POST",
  headers: {
    "X-API-Key": "nx_7f3a1b...",
    "X-Timestamp": "1776033911836",
    "X-Signature": "<hmac-sha256>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "amount": "500"
  }),
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
console.log(await response.json());

X-Signature is a placeholder: it is derived from this specific request. See Authentication for the canonical string and the HMAC rule.

---

_{Generated from eng/apps/exchange/api/openapi.json (spec 0.9.36). Do not edit by hand — regenerate with python3 product/docs/tools/api-reference/generate.py. Hand-authored context lives in the Guides pages.}