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
Alviere API
Accounts (Collapsed)
- get/accounts
- post/accounts
- get/accounts/{account_uuid}
- patch/accounts/{account_uuid}
- delete/accounts/{account_uuid}
- put/accounts/{account_uuid}/deactivate
- put/accounts/{account_uuid}/activate
- put/accounts/{account_uuid}/onboarding
- post/accounts/{account_uuid}/addresses
- get/accounts/{account_uuid}/addresses
- patch/accounts/{account_uuid}/addresses/{address_uuid}
- delete/accounts/{account_uuid}/addresses/{address_uuid}
Authentication (Collapsed)
Wallets (Collapsed)
- get/accounts/{account_uuid}/wallets/{wallet_uuid}
- get/wallets/{wallet_uuid}/transactions/statement
- get/accounts/{account_uuid}/wallets
- get/wallets/{wallet_uuid}/transactions
- post/wallets/{wallet_uuid}/load
- post/wallets/{wallet_uuid}/withdraw
- post/wallets/{wallet_uuid}/send
- post/wallets/{wallet_uuid}/transfer
- post/wallets/{wallet_uuid}/promo
- post/wallets/{wallet_uuid}/credit
- post/wallets/{wallet_uuid}/debit
Early Pay (Collapsed)
Transactions (Collapsed)
- post/transactions/release
- get/transactions/{transaction_uuid}
- post/transactions/{transaction_uuid}/reverse
- get/transactions
- get/transactions/limits
- put/transactions/{transaction_uuid}/cancel
- put/transactions/{transaction_uuid}/refund
- get/transactions/{transaction_uuid}/child_transactions
- get/transactions/{transaction_uuid}/receipt
- post/transactions/summary-data
Payment methods (Collapsed)
- patch/payment-methods/cards/{payment_method_uuid}
- patch/payment-methods/bank-accounts/{payment_method_uuid}
- post/accounts/{account_uuid}/payment-methods/cards
- get/accounts/{account_uuid}/payment-methods/cards
- post/accounts/{account_uuid}/payment-methods/bank-accounts
- get/accounts/{account_uuid}/payment-methods/bank-accounts
- get/accounts/{account_uuid}/payment-methods/cards/{payment_method_uuid}
- delete/accounts/{account_uuid}/payment-methods/cards/{payment_method_uuid}
- get/accounts/{account_uuid}/payment-methods/bank-accounts/{payment_method_uuid}
- delete/accounts/{account_uuid}/payment-methods/bank-accounts/{payment_method_uuid}
- post/accounts/{account_uuid}/payment-methods/plaid-bank-accounts
- put/accounts/{account_uuid}/payment-methods/plaid-bank-accounts/{payment_method_uuid}/activate
Card Payments (Collapsed)
Transactions v3 (Collapsed)
Dossiers (Collapsed)
Beneficiaries (Collapsed)
- post/beneficiaries/{beneficiary_uuid}/payout-methods
- get/beneficiaries/{beneficiary_uuid}/payout-methods
- get/payout-methods/{payout_method_uuid}
- delete/payout-methods/{payout_method_uuid}
- patch/payout-methods/{payout_method_uuid}
- post/accounts/{account_uuid}/beneficiaries
- get/accounts/{account_uuid}/beneficiaries
- patch/accounts/{account_uuid}/beneficiaries/{beneficiary_uuid}
- get/accounts/{account_uuid}/beneficiaries/{beneficiary_uuid}
- delete/accounts/{account_uuid}/beneficiaries/{beneficiary_uuid}
Card issuance (Collapsed)
- get/wallets/{wallet_uuid}/issued-cards
- post/wallets/{wallet_uuid}/issued-cards
- post/issued-cards/{card_uuid}/reissue_replace
- put/issued-cards/{card_uuid}/pin
- get/wallets/{wallet_uuid}/issued-cards/{card_uuid}
- delete/wallets/{wallet_uuid}/issued-cards/{card_uuid}
- patch/wallets/{wallet_uuid}/issued-cards/{card_uuid}
- put/wallets/{wallet_uuid}/issued-cards/{card_uuid}/activate
- put/wallets/{wallet_uuid}/issued-cards/{card_uuid}/unfreeze
- put/wallets/{wallet_uuid}/issued-cards/{card_uuid}/freeze
- put/wallets/{wallet_uuid}/issued-cards/{card_uuid}/mobile-wallet
- get/wallets/{wallet_uuid}/issued-cards/{card_uuid}/image
- get/wallets/{wallet_uuid}/issued-cards/{card_uuid}/sensitive-data
Check Deposits (Collapsed)
Global payments (Collapsed)
- get/cash-pickup/locations
- get/cash-pickup/cities
- get/cash-pickup/locations/{cash_pickup_location_uuid}
- post/global-payments/quote-preview
- post/wallets/{wallet_uuid}/quote
- post/wallets/{wallet_uuid}/remittances
- get/payout-methods/banks/{bank_uuid}
- get/payout-methods/banks
- get/fx/supported-payout-method-currencies
- get/fx/field-validations
Treasury management (Collapsed)
Service fees (Collapsed)
Rewards and Incentives (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.

