Skip to main content
POST
Simulate a collection (sandbox only)

Authorizations

Authorization
string
header
required

Your Jenzy API key: Authorization: Bearer jz_live_…

Headers

HERMES-ORG
string<uuid>

The id of one of your Child orgs. The call then acts on that Child org, not on your organization. If you do not send it, the call acts on your organization. An id that is not one of your Child orgs gives 404.

Example:

"3f1c2a9e-8b7d-4e21-9a6f-0c5d4b3e2a10"

Body

application/json
amount
required

An exact decimal string in the asset’s major unit, with at most the asset’s decimals ("250000.00", "12.5"), or a JSON integer of whole units. Fractional JSON numbers are rejected — send a string. Parse with a decimal library, never a float.

Example:

"250000.00"

asset
string
required

An asset code as GET /v2/assets lists it — uppercase, never compound (USDC, USD; never USDC-ETHEREUM). Network and rail live on the payment object.

Minimum string length: 1
Example:

"USDC"

network
string

For a stablecoin deposit to your deposit address: the network by name (ethereum, solana). The asset must run on it, else unsupported_network (422). If you omit it, your default network is used. A USD deposit always lands on ethereum, whatever your default; any other network is unsupported_network (422).

Example:

"ethereum"

Response

Accepted, not yet credited. id is null (and status is pending) for a stablecoin deposit to your deposit address or a USD deposit, or when the sandbox’s answer was lost — the deposit may still land, so poll rather than retry.

id
string | null
required

The sandbox deposit id, or null for a stablecoin deposit to your deposit address or a USD deposit, or when the request reached the sandbox but its answer was lost — the deposit may still land. Do NOT retry on null; poll GET /v2/collections.

asset
string
required

An asset code as GET /v2/assets lists it — uppercase, never compound (USDC, USD; never USDC-ETHEREUM). Network and rail live on the payment object.

Minimum string length: 1
Example:

"USDC"

amount
string
required
Example:

"1000.00"

status
string
required

processing at accept, or pending for a stablecoin or USD deposit or when the answer was lost; either way the credit appears in GET /v2/collections within a few minutes.

Example:

"processing"