Error

A valid request URL is required to generate request examples

{
  "version": "faucet-grant/v1",
  "accountId": "<string>",
  "asset": "USD.E",
  "amountAtoms": "<string>",
  "fundingIntentId": "<string>",
  "status": "available",
  "replayed": true
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

Accounts

Request the account's test funds

Grants the authenticated account its one-time faucet funding intent of simulated USD.E collateral, so a new account can trade without waiting for an operator. The amount is fixed by the server and cannot be supplied by the caller. Exactly one grant exists per account: repeating the request returns the same funding intent with replayed true. The capability is composed only on local and development, so it is absent — not merely refused — anywhere else.

Method and path: POST /v1/accounts//faucet-grant

Authentication: DFNS trader bearer required.

Request schema: none.

Response schema: FaucetGrantResponse.

Error envelope: ExternalRestError (external-rest-error/v1).

POST

accounts

{accountId}

faucet-grant

Error

A valid request URL is required to generate request examples

{
  "version": "faucet-grant/v1",
  "accountId": "<string>",
  "asset": "USD.E",
  "amountAtoms": "<string>",
  "fundingIntentId": "<string>",
  "status": "available",
  "replayed": true
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

accountId

string

required

Minimum string length: 1

Response

Success

version

string

required

Allowed value: "faucet-grant/v1"

accountId

string

required

Minimum string length: 1

asset

string

required

Allowed value: "USD.E"

amountAtoms

string

required

Pattern: ^[1-9][0-9]*$

fundingIntentId

string

required

Minimum string length: 1

status

enum<string>

required

Available options:

available,

deposit_bound,

consumed,

cancelled

replayed

boolean

required

Account policy

External REST API

Request the account's test funds

Authorizations

Path Parameters

Response