POST /account/credit
Claim synthetic USDX credit
Claim synthetic USDX credit.
operationId: claimCredit
Declared server:
https://api.testnet.nexus.xyz/v1. See Networks.
Not reachable through CCXT. Testnet-only balance credit and the internal deposit callback. Not client-facing in CCXT terms.
Authentication: agentAuth, 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.
HMAC API key authentication. Send three headers:
X-API-Key: your key ID (e.g.nx_a1b2c3...)X-Timestamp: current time in unix millisecondsX-Signature:hex(hmac_sha256(secret, timestamp + "\n" + METHOD + "\n" + path + "\n" + query + "\n" + sha256_hex(body)))
Timestamp must be within 30 seconds of server time.
The key is network-scoped; the signature is not. The canonical string above has no network component, so the same signed request is byte-identical on every host. What stops a testnet key from authenticating against mainnet is that the key does not exist in that host's key store — sign only for the host that minted the key, and never replay a signed payload against another network. Presented to the wrong host, a key is refused with the same opaque 401 as an unknown key and must not be retried there. See “API keys are bound to one network” in the API description.
Claims synthetic USDX against the per-API-key daily allowance. Testnet only: mainnet collateral arrives through the bridge and there is no faucet or credit there. Omitting amount claims the whole remaining allowance for the day, so the field is a cap on the request rather than a required input.
Synthetic USDX to credit (decimal string). Omit to claim the full remaining daily allowance.
Credit applied
What a credit claim granted, and what remains of the day's allowance. All three fields are required and all are decimal strings. amount is what this request credited, which can be less than what was asked for when the daily limit binds — compare credited_today against daily_limit to see the remaining headroom rather than assuming the request was granted in full.
USDX credited by this request (decimal string).
Total USDX credited to this API key so far today (decimal string).
Per-API-key daily credit allowance in USDX (decimal string).
Authentication failed. All 401 responses return the same opaque body to prevent information leakage. A credential minted on a different network is one of the causes it hides — by design, so that a key id cannot be probed for existence on another network. Do not retry it against another host.
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.
Daily credit allowance exhausted (resets at midnight UTC)
POST /v1/account/credit HTTP/1.1
Host: api.testnet.nexus.xyz
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"amount": "500"
}{
"amount": "500",
"credited_today": "500",
"daily_limit": "500"
}Test it cannot sign this request. X-Signature is an HMAC computed per call: see Authentication, or use an SDK.
API version 0.9.122
Last updated