/v2 surface of Jenzy Hermes. You hold a balance
in each asset that Jenzy enables for your org. You fund a balance with a
collection. You pay out to a wallet address, or to a USD bank account.
Two APIs, one account
Jenzy has two APIs. Your org, your API keys, and your webhook endpoint are the same on both.
The MWK API stays as it is. Jenzy does not remove it. If you pay only Malawi,
you do not need to change. This tab describes
/v2 only.
What is different on /v2
amountandasset. Each money figure is an exact decimal string in major units, beside anassetfield. An example is{ "amount": "250.5", "asset": "USDC" }. No field name has a currency in it. There is nocurrencyfield.- One payout endpoint.
POST /v2/payoutstakes adestinationobject. Thetypeof the destination selects the rail. See Payouts. - Collections for each asset. A USD bank pay-in and an on-chain deposit are both a collection. See Collections.
- Orders. Change a stablecoin into a local currency for a bank account, or buy a stablecoin with a bank transfer. See Orders.
Idempotency-Keyis necessary onPOST /v2/payoutsandPOST /v2/orders. A create request with no key gets400.- Webhooks. The same endpoint gets the events of both APIs. A
/v2delivery carriesapi_version: "v2". See Webhooks.
Base URL
Production:jz_live_… key that you use
on /v1.
Money values
Hermes sends each amount as an exact decimal string. A fiat asset has two decimal places. An example is"250000.00". A stablecoin has a maximum of six
decimal places, and Hermes removes the zeros at the end. Examples are "12.5"
and "0.000001".
GET /v2/assets gives the decimals of each asset. Read each money field
with a decimal library. Do not use parseFloat.
You can send an amount to Hermes in two forms. Use a JSON integer of whole
units, for example 250000. Or use an exact decimal string with a maximum of
the decimals of the asset, for example "250000.50".
Hermes refuses a fractional JSON number. Send "12.5". Do not send 12.5.
Where to start
Quickstart
Assets, balances, where to send money, and a payout.
Balances
One row for each asset. Available, held, and shortfall.
Payouts
One endpoint, two destination types, and USD payouts.
USD beneficiaries
Register a USD bank account one time. Then pay it.
Child orgs
Open an account for each of your customers, and use the API for them.
Collections
How money comes in, and where to send it.
Orders
Stablecoin to a bank account, and a bank transfer to stablecoin.
Errors
The codes that are new on this API.
Sandbox
What the sandbox can show you, and what it cannot.
Webhooks
The shared event list, with the order events.