Skip to navigation
Agora Sandbox APIEndpointsSandbox Tools

Simulate a Wire

Sandbox only. Simulates an incoming USD wire into one of your mint-fiat routes. The route’s token is sent to its destination wallet on testnet, and the mint appears in your transactions. No real money moves.

Authentication

AuthorizationBearer

Session JWT from POST /v0/auth/token, sent as Authorization: Bearer <sessionJwt>.

See Authentication for more details.

Request

This endpoint expects an object.
amountstringRequiredformat: "^(0|[1-9]\d*)(\.\d{1,2})?$"
USD the simulated wire sends, as a decimal string. The route pays the same amount of its token.
routeIdstringRequiredformat: "uuid"

The mint-fiat route the wire is sent to.

sourceAccountIdstringRequiredformat: "uuid"

A bank account registered to your organization (POST /v0/accounts, kind bank). The wire comes from it.

Response

OK
amountstring
USD sent, as a decimal string.
idstringformat: "uuid"
The simulated wire's id.
routeIdstringformat: "uuid"
sandboxany

Always true: this endpoint exists only in the sandbox.

statusenum

The wire is recorded and the route’s token sent shortly after this response. Poll GET /v0/transactions to see the mint.

Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error