/v1. The wrapper has a stable code
and a message for a person to read. Use the code to select the action in
your integration. The text of the message can change.
/v2 too.
Examples are validation_error, unauthorized, not_found, conflict,
rate_limited, internal_error, service_incident, and
service_maintenance. This page lists only the codes that are new or
different on /v2.
Two groups of codes
- Rejections (the first table) — Hermes refused the request. Hermes made no payout, no order, and held no money. Correct the request, or wait, and then send the request again.
- Failure codes — Hermes accepted the request, and it failed later. A
failedpayout has afailure.codefrom the payout failure codes, the same words as/v1.
New rejection codes
Order codes
These codes are for orders only.
Orders also use codes from the first table, with the same meaning:
quote_expired(422) andquote_used(409) — for the order quote.rate_unavailable(503) — the desk has no rate in this direction now.amount_below_minimum(422) — the stablecoin side is below theminof the corridor.unsupported_pair(422) — the pair is not one stablecoin and one corridor currency.corridor_not_enabled(403) — Jenzy did not enable the desk for your org.insufficient_funds(402) — your stablecoinavailableis belowfrom_amount.
503 with
service_maintenance or service_incident. Reads of your orders continue.
GET /v2/orders/corridors shows each corridor with open: false. Hermes
does not use your Idempotency-Key. Send the same request again later.
USD codes
These codes are for USD beneficiaries and USD payouts.
USD payouts also use these codes:
beneficiary_required(422) — a USD payout has a destination type that is notbeneficiary.beneficiary_not_allowed(422) — a payout in a different asset has the typebeneficiary.amount_below_minimum(422) — theamountis below USD 100.unsupported_pair(422) — thesource_assetis notUSDC.unsupported_asset(422) — a payout in a different asset has aninvoice_document_id.payload_too_large(413) andunsupported_media_type(415) — for the invoice file ofPOST /v2/documents.
Codes that are different on /v2
validation_error(400) also covers a create request with noIdempotency-Key. On/v2the key is necessary onPOST /v2/payoutsandPOST /v2/orders.insufficient_funds(402) is about one balance, the balance of the source asset. See the table above.- A wallet destination uses
invalid_wallet_address. amount_limit_exceededandorg_limit_exceededare/v1codes. On/v2the per-payout limits useamount_below_minimumandlimit_exceeded. There is no daily cap.
When Jenzy pauses the API
service_incident and service_maintenance work as on /v1. See
Maintenance and outages. /v2 has its own pause,
apart from /v1. GET /v2/ping tells you the state of /v2. Its status
field is live, maintenance, or outage.
During a /v2 pause, each /v2 route but GET /v2/ping gives 503.
Payouts that Hermes accepted before the pause continue automatically when the
pause ends. Hermes still delivers webhooks.
An access code never names the company that holds the money for Jenzy.
onboarding_incomplete and access_suspended are about your org and
Jenzy only. Speak to Jenzy when you get one.