v6.6.28
OpenAPI 3.1.1

The HIVE APIs

Introduction

Welcome to The HIVE API documentation!

This page provides developer API documentation for integrating into the Alviere HIVE platform.

Notes

  • All times are in UTC time standard
  • All date fields use the RFC 3339 version of the ISO-8601 standard format
Server:https://api.snd.alviere.com

Alviere API

Client Libraries

Card Payments (Collapsed)

​

Transactions v3 (Collapsed)

​

Treasury management (Collapsed)

​

Webhooks (Collapsed)

​

Alviere POSTs webhook events to your configured URL whenever something meaningful happens on the account — KYC state changes, transactions settle, cards are issued, and so on.

Delivery

Each event is delivered as a JSON POST to your configured URL. Return any 2xx within 10 seconds to acknowledge receipt. Anything else — a non-2xx response, a timeout, or a network error — triggers a retry with the same event_uuid and an incremented event_retry counter.

Headers

Header Description
Alviere-Webhook-id UUID for this delivery attempt. Stable across retries — use it as your idempotency key.
Alviere-Webhook-Timestamp RFC 3339 timestamp of when the event was dispatched.
Alviere-Signature Hex-encoded HMAC-SHA256 signature. Present when the subscription is configured with an HMAC secret.
Alviere-Auth Static API key. Present when the subscription is configured with API key auth instead of HMAC.

Signature verification

Build the signing string as {webhook_id}.{webhook_timestamp}.{compact_body}, where compact_body is the raw request body with all insignificant JSON whitespace removed. Compute HMAC-SHA256(secret, signing_string), hex-encode it, and compare against Alviere-Signature using a constant-time comparison. Reject the request if the signatures don't match or the timestamp is more than a few minutes old.

Envelope

Every event body shares the same envelope — event_uuid, event_type, event_version, event_date, event_retry, business_account_uuid, program_uuid — plus an entity field whose shape depends on the event type. See each event below.

Activities (Collapsed)

​

Cash loading (Collapsed)

​