Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hevn Inc Cards API

The Cards API from Hevn Inc — 28 operation(s) for cards.

Hevn Inc Cards 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 Cards. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 32 operations across 28 paths, and defines 24 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.

32 operations 28 paths 24 schemas 2 DELETE6 GET18 POST6 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 Cards 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 32

Across 28 paths, the API surfaces 32 operations — 2 DELETE, 6 GET, 18 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Cards 32
POST
/api/v1/cards/pre-approve
Pre-approve card issuance
pre_approve_cards_api_v1_cards_pre_approve_post 1 param → 200422
POST
/api/v1/cards/register
Register user for card services
register_for_cards_api_v1_cards_register_post 1 param body → 201422
PUT
/api/v1/cards/phone
Set phone number
set_phone_number_api_v1_cards_phone_put 1 param body → 204422
POST
/api/v1/cards/phone/otp
Send phone OTP
send_phone_otp_api_v1_cards_phone_otp_post 1 param → 200422
POST
/api/v1/cards/phone/otp/verify
Verify phone OTP
verify_phone_otp_api_v1_cards_phone_otp_verify_post 1 param body → 204422
POST
/api/v1/cards/kyc/link
Get KYC verification link
get_kyc_link_api_v1_cards_kyc_link_post 1 param → 200422
POST
/api/v1/cards
Issue new card
issue_card_api_v1_cards_post 1 param body → 201422
GET
/api/v1/cards
Get user's cards
get_cards_api_v1_cards_get 1 param → 200422
GET
/api/v1/cards/{card_id}
Get card by ID
get_card_api_v1_cards__card_id__get 2 params → 200422
DELETE
/api/v1/cards/{card_id}
Delete card
delete_card_api_v1_cards__card_id__delete 2 params → 204422
POST
/api/v1/cards/{card_id}/details
Reveal full card details
reveal_card_api_v1_cards__card_id__details_post 2 params body → 200422
POST
/api/v1/cards/{card_id}/freeze
Freeze card
freeze_card_api_v1_cards__card_id__freeze_post 2 params → 204422
POST
/api/v1/cards/{card_id}/unfreeze
Unfreeze card
unfreeze_card_api_v1_cards__card_id__unfreeze_post 2 params → 204422
PUT
/api/v1/cards/{card_id}/limit
Set card limit
set_card_limit_api_v1_cards__card_id__limit_put 2 params body → 200422
PUT
/api/v1/cards/{card_id}/label
Set card label
set_card_label_api_v1_cards__card_id__label_put 2 params body → 200422
GET
/api/v1/cards/withdrawals/pending
List pending card withdrawals
get_pending_withdrawals_api_v1_cards_withdrawals_pending_get 1 param → 200422
POST
/api/v1/accounts/cards/pre-approve
Pre-approve card issuance
pre_approve_cards_package_alias_api_v1_accounts_cards_pre_approve_post 1 param → 200422
POST
/api/v1/accounts/cards/register
Register user for card services
register_for_cards_package_alias_api_v1_accounts_cards_register_post 1 param body → 201422
PUT
/api/v1/accounts/cards/phone
Set phone number
set_phone_number_package_alias_api_v1_accounts_cards_phone_put 1 param body → 204422
POST
/api/v1/accounts/cards/phone/otp
Send phone OTP
send_phone_otp_package_alias_api_v1_accounts_cards_phone_otp_post 1 param → 200422
POST
/api/v1/accounts/cards/phone/otp/verify
Verify phone OTP
verify_phone_otp_package_alias_api_v1_accounts_cards_phone_otp_verify_post 1 param body → 204422
POST
/api/v1/accounts/cards/kyc/link
Get KYC verification link
get_kyc_link_package_alias_api_v1_accounts_cards_kyc_link_post 1 param → 200422
POST
/api/v1/accounts/cards
Issue new card
issue_card_package_alias_api_v1_accounts_cards_post 1 param body → 201422
GET
/api/v1/accounts/cards
Get user's cards
get_cards_package_alias_api_v1_accounts_cards_get 1 param → 200422
GET
/api/v1/accounts/cards/{card_id}
Get card by ID
get_card_package_alias_api_v1_accounts_cards__card_id__get 2 params → 200422
DELETE
/api/v1/accounts/cards/{card_id}
Delete card
delete_card_package_alias_api_v1_accounts_cards__card_id__delete 2 params → 204422
POST
/api/v1/accounts/cards/{card_id}/details
Reveal full card details
reveal_card_package_alias_api_v1_accounts_cards__card_id__details_post 2 params body → 200422
POST
/api/v1/accounts/cards/{card_id}/freeze
Freeze card
freeze_card_package_alias_api_v1_accounts_cards__card_id__freeze_post 2 params → 204422
POST
/api/v1/accounts/cards/{card_id}/unfreeze
Unfreeze card
unfreeze_card_package_alias_api_v1_accounts_cards__card_id__unfreeze_post 2 params → 204422
PUT
/api/v1/accounts/cards/{card_id}/limit
Set card limit
set_card_limit_package_alias_api_v1_accounts_cards__card_id__limit_put 2 params body → 200422
PUT
/api/v1/accounts/cards/{card_id}/label
Set card label
set_card_label_package_alias_api_v1_accounts_cards__card_id__label_put 2 params body → 200422
GET
/api/v1/accounts/cards/withdrawals/pending
List pending card withdrawals
get_pending_withdrawals_package_alias_api_v1_accounts_cards_withdrawals_pending_get 1 param → 200422

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are CardResponse (10 properties), CardLimit (7 properties), PendingWithdrawal (7 properties), UserAddress (6 properties). Each schema is shown below with its type and property counts.

SetCardLabelRequest
object
Request to set a user-defined card label.
1 property
PendingWithdrawal
object
Single pending withdrawal request as returned by Wirex.
7 properties
ValidationError
object
3 properties 3 required
CardDetailsResponse
object
Sensitive card details.
3 properties 3 required
CardResponse
object
Card response - universal format for any provider.
10 properties 1 required
SetCardLimitRequest
object
Request to set card spending limits.
4 properties
HTTPValidationError
object
1 property
SetPhoneRequest
object
Request to set phone number.
1 property 1 required
SendOtpResponse
object
Response after sending OTP.
1 property 1 required
VerifyOtpRequest
object
Request to verify OTP code.
2 properties 2 required
CardData
object
Card display data (non-sensitive).
6 properties 6 required
CardUserRegisterRequest
object
Request to register user for card services.
2 properties 2 required
CardsListResponse
object
Paginated list of cards.
5 properties 1 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
CardStatus
string
Card status.
IssueCardRequest
object
Request to issue a new card.
1 property
PendingWithdrawalsResponse
object
List of pending withdrawals for a user.
2 properties 2 required
CountryCode
string
ISO 3166-1 alpha-2 country codes.
CardsPreApproveResponse
object
Pre-flight info for issuing Wirex cards.
4 properties
CardRevealRequest
object
Request to reveal card details. Requires wallet signature.
2 properties 2 required
CardLimit
object
Card spending limit.
7 properties
KycStatus
string
KYC verification status.
CardFormat
string
Card format.
KycLinkResponse
object
KYC verification link.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hevn-inc-cards-api-openapi.yml Raw ↑

Other APIs Hevn Inc publishes across the network.

Hevn Inc 2FA API
Hevn Inc Activity API
Hevn Inc apps API
Hevn Inc apps-transfer API
Hevn Inc auth API
Hevn Inc B2B API
Hevn Inc Balance API
Hevn Inc Banks API
Hevn Inc Chat API
Hevn Inc contracts API
Hevn Inc Devices API
Hevn Inc documents API