Hevn Inc Banks 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 Banks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
14 operations
across 14 paths,
and defines 31 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.
14 operations14 paths31 schemas2 GET12 POST
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 Banks 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 14
Across 14 paths, the API surfaces 14 operations — 2 GET, 12 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are BankResponse (20 properties), IBANAccountDetails-Output (14 properties), BankPayinQuoteResponse (13 properties), SwiftAccountDetails-Output (13 properties). Each schema is shown below with its type and property counts.
app__schemas__base__ContactRelationship
string
Unified contact relationship / transfer purpose. Values match Align AlignTransferPurpose (the more granular set). Mapped to Swipelux AccountHolderRelationship…
BankPayinQuoteRequest
object
Request a Swipelux payin quote for a pooled bank rail.
3 properties2 required
ValidationError
object
3 properties3 required
BankRequestedRails
object
Rails the user is interested in opening.
4 properties
BankRequestedRailSettings
object
User interest in a bank rail group.
2 properties
HTTPValidationError
object
1 property
BankPayinQuoteSubmitRequest
object
Submit a previously created Swipelux bank payin quote.
1 property1 required
BankActivateRailsRequest
object
Bulk bank activation request.
1 property1 required
FiatPaymentType
string
Canonical fiat payment rail used for accounttype discrimination, bank-rail methods, and contact/transaction type alignment.
BankPayinQuoteResponse
object
Swipelux payin quote response normalized for bank payins.
13 properties8 required
BankResponse
object
Bank row as returned to clients. Merges static rail metadata (from BANKINFO) with per-user state. For rails the user hasn't activated yet, id / externalaccount…
20 properties13 required
USExternalAccountDetails-Output
object
US domestic (ACH) external account.
13 properties4 required
BankPayinQuoteCancelResponse
object
Response after canceling a locally tracked bank payin quote.
3 properties3 required
BankActivateRailsResponse
object
Bulk bank activation response.
1 property1 required
USAccountDetails
object
US domestic account details (ACH).
2 properties2 required
BanksListResponse
object
List bank rails plus user's requested rail preferences.
3 properties2 required
AlignAccountHolderType
string
Account holder type.
SwiftDetails
object
SWIFT (international wire) account details.
3 properties2 required
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
IBANAccountDetails-Output
object
IBAN (SEPA) external account.
14 properties4 required
BankActivateRailResult
object
Per-rail bulk activation result.
4 properties2 required
BankActivateRailError
object
Per-rail bulk activation error.
3 properties2 required
BankPayinQuoteSubmitResponse
object
Swipelux payin instructions returned after quote submit.
4 properties1 required
CountryCode
string
ISO 3166-1 alpha-2 country codes.
IBANStatus
string
IBAN account status. State machine: notstarted → requested → documentrequested → approved → pending → active - notstarted — default for every rail until the us…
BankPreApproveResponse
object
Read-only KYC info for a rail. Does not mutate Bank rows.
5 properties
BankRail
string
Bank account route: provider rail + bank id ({rail}-{bank}).
KycStatus
string
KYC verification status.
BankTimeToOpen
string
Expected wait time before a bank rail becomes usable.
FiatProvider
string
Supported fiat payment providers.
SwiftAccountDetails-Output
object
SWIFT (international wire) external account.
13 properties4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
