Hevn Inc Transactions API is one of 31 APIs that Hevn Inc publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Transactions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
9 operations
across 9 paths,
and defines 39 schemas.
It is described by OpenAPI 3.1.0, at version 0.1.2.
Requests are made against a single base URL, https://api.hevn.finance.
9 operations9 paths39 schemas5 GET3 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.1.0
API Version
0.1.2
Base URL
https://api.hevn.finance/api/v1
Authentication
HTTP Bearer, API Key
Resource Areas
1
Authentication & Security 2
Hevn Inc Transactions API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (HTTPBearer).
An API key is passed in the header as x-api-key (ApiKeyAuth).
ApiKeyAuth — Alternative HEVN API key header. The CLI defaults to Authorization Bearer unless configured with HEVNAPIKEYHEADER=X-Api-Key.
Paths & Operations 9
Across 9 paths, the API surfaces 9 operations — 5 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are TransactionDetailResponse (25 properties), UnifiedTransactionItem (22 properties), IBANAccountDetails-Output (14 properties), USExternalAccountDetails-Output (13 properties). Each schema is shown below with its type and property counts.
TransactionBreakdownItem
object
One bucket in a breakdown — volume + count for a tag/type value.
3 properties3 required
app__schemas__base__ContactRelationship
string
Unified contact relationship / transfer purpose. Values match Align AlignTransferPurpose (the more granular set). Mapped to Swipelux AccountHolderRelationship…
ValidationError
object
3 properties3 required
TransactionStatus
string
Unified transaction status.
TransactionAmountDetail
object
Currency / amount / rate leg of a transaction.
4 properties2 required
TransactionSortBy
string
Field to sort the transaction list by.
HTTPValidationError
object
1 property
TransactionSummary
object
Aggregate volumes and counts over the filtered transaction set. Computed without LIMIT/OFFSET — represents the entire filtered scope, not just the current page…
8 properties8 required
TransactionGroupBy
string
Field to group breakdown analytics by.
MemoUpdateResponse
object
Response for memo update.
2 properties1 required
MemoUpdateRequest
object
Request to update a transaction memo (description).
1 property
TransactionDetailResponse
object
Detailed transaction response with wallet/IBAN info.
25 properties6 required
UnifiedTransactionItem
object
Unified transaction item for the transaction list. Legacy directional fields are still included for compatibility.
Lightweight user preview (for transaction participants, etc.).
5 properties2 required
TransactionCardDetail
object
Card and merchant info for card transactions.
5 properties
TransactionBreakdownResponse
object
Volume + count grouped by tag or type, with the same filters as the list.
2 properties2 required
USAccountDetails
object
US domestic account details (ACH).
2 properties2 required
TransactionBreakdownGranularity
string
Time bucket size for the breakdown series.
SwiftDetails
object
SWIFT (international wire) account details.
3 properties2 required
AlignAccountHolderType
string
Account holder type.
UserAddress
object
Address schema for user. Canonical field names: streetaddress, addressline2, city, state, country, zip. Accepts legacy Align/IBAN field names (streetline1, str…
6 properties
TransactionWalletDetail
object
Wallet details for transaction list/detail views.
2 properties
TransactionBreakdownSeriesBucket
object
One time-bucket in a breakdown series, with the per-key items inside it.
3 properties3 required
TransactionInvoiceDetail
object
Invoice info embedded in transaction details.
10 properties1 required
IBANAccountDetails-Output
object
IBAN (SEPA) external account.
14 properties4 required
TransactionAttachment
object
A user-attached document on a transaction.
4 properties2 required
SortOrder
string
Sort direction.
TagUpdateResponse
object
Response for tag update.
2 properties1 required
TransactionShareLinkResponse
object
Share link for a transaction receipt.
2 properties2 required
CountryCode
string
ISO 3166-1 alpha-2 country codes.
TransactionBreakdownSeriesResponse
object
Time-bucketed volume + count grouped by tag or type. Granularity is auto-picked from the fromDate/toDate range: months for ranges longer than 6 months, weeks f…
3 properties3 required
TransactionContactDetail
object
Contact details for transaction detail view.
4 properties2 required
TagUpdateRequest
object
Request to update a transaction tag.
1 property
UnifiedTransactionListResponse
object
Unified transaction list response.
2 properties1 required
SwiftAccountDetails-Output
object
SWIFT (international wire) external account.
13 properties4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
