Hermos API
Concepts

IDs

Opaque public IDs and their registered prefixes.

Public IDs consist of a resource prefix, an underscore, and a 26-character lower-case Crockford Base32 representation of a UUID. The first encoded character is between 0 and 7. The alphabet is 0123456789abcdefghjkmnpqrstvwxyz.

Treat public IDs as opaque strings. Keep the prefix when storing or sending them; a resource accepts only its own registered prefix. Invalid or mismatched IDs fail validation.

This table is built from the generated OpenAPI schemas, which register every entry of the API's ID prefix catalogue. A prefix does not imply that its resource endpoint is available yet; use the API Reference for available routes.

PrefixResource
abp_account binding proof
abr_account binding request
acn_assistant connection
acs_account session
aff_affiliate
apv_approval
arq_affiliate request
att_payment attempt
bil_merchant billing account
cab_customer account binding
chd_checkout domain
chk_checkout instance
cks_checkout instance step
clk_settlement clock
cmp_company
cpl_commission plan
cpn_coupon
cse_customer session
cst_customer
dmr_domain registration
dsp_dispute
egr_entitlement grant
ems_embed session
ent_entitlement
erv_entitlement revocation
evd_event delivery
evn_event
exj_export job
fcn_feed connection
fev_feed event
hin_Hermos invoice
hlt_health check
htr_health transition
inl_invoice line
inv_invoice
ipl_installment plan
key_API key
lk_licence key
lkp_licence key pool
mem_membership
ofr_offer
opr_operation
ord_order
pac_processor account
pay_payment
pcf_payment confirmation link
pcl_purchase claim
pfl_payment failure
pln_plan
pms_payment method setup
pmt_payment method
prc_price
prd_product
prg_affiliate program
psc_payment setup change
pst_payment setup
pyd_payout destination
pyo_payout
rcd_reconciliation difference
rcs_reconciliation summary
rfd_refund
rvi_review item
sas_staff access session
sbi_subscription item
sbs_subscription
scl_Stripe connect link
seq_offer sequence
sil_sign-in link
ssc_subscription schedule
syn_synthetic run
txr_tax registration
ubr_unpaid balance record
usr_usage report record
ust_usage settlement
whk_webhook endpoint