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

Hifi Virtual Account API

Virtual Account endpoints

Hifi Virtual Account API is one of 15 APIs that Hifi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Virtual Account. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 6 paths, and defines 12 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.

Requests are made against 2 base URLs: https://production.hifibridge.com, https://sandbox.hifibridge.com.

7 operations 6 paths 12 schemas 2 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.0
Base URL
https://production.hifibridge.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Hifi Virtual Account API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 7

Across 6 paths, the API surfaces 7 operations — 2 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Virtual Account 7

Virtual Account endpoints

POST
/v2/users/{userId}/virtual-accounts
Create a virtual account
1 param body → 200401404500
GET
/v2/users/{userId}/virtual-accounts
List all virtual accounts
7 params → 200401404500
GET
/v2/users/{userId}/virtual-accounts/{accountId}
Retrieve a virtual account
5 params → 200401404500
POST
/v2/users/{userId}/virtual-accounts/{accountId}/update
Update a virtual account
2 params body → 200401404500
POST
/v2/users/{userId}/virtual-accounts/{accountId}/deactivate
Deactivate a virtual account
2 params → 200401404500
POST
/v2/users/{userId}/virtual-accounts/{accountId}/reactivate
Reactivate a virtual account
2 params → 200401404500
POST
/v2/users/{userId}/virtual-accounts/{accountId}/simulate-deposit
Simulate a deposit to a virtual account
2 params body → 200401404500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are InboundObject (12 properties), VirtualAccountObject (10 properties), SimulateVirtualAccountDeposit (7 properties), CreateVirtualAccount (4 properties). Each schema is shown below with its type and property counts.

ReactivateVirtualAccountObject
object
2 properties
UpdateVirtualAccount
object
4 properties 2 required
InternalServerError
object
1 property
CreateVirtualAccountObject
object
2 properties
VirtualAccountListObject
object
3 properties
DeactivateVirtualAccountObject
object
2 properties
VirtualAccountObject
object
10 properties
CreateVirtualAccount
object
4 properties 2 required
InboundObject
object
12 properties
UpdateVirtualAccountObject
object
2 properties
Unauthorized
object
1 property
SimulateVirtualAccountDeposit
object
7 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hifi-virtual-account-api-openapi.yml Raw ↑

Other APIs Hifi publishes across the network.

Hifi Account API
Hifi Common API
Hifi Cross-Chain Bridge API
Hifi Crypto Transfer API
Hifi File API
Hifi Kyc API
Hifi Offramp API
Hifi Onramp API
Hifi Reporting API
Hifi Settlement Rules API
Hifi Token Swap API
Hifi Transfer Approvals API