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 Onramp API

Onramp endpoints

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

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

This API exposes 6 operations across 5 paths, and defines 23 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.

6 operations 5 paths 23 schemas 3 GET3 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 Onramp API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 6

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

Onramp 6

Onramp endpoints

POST
/v2/onramps
Create an onramp
body → 200401404500
GET
/v2/onramps
List all onramps
4 params → 200401404500
GET
/v2/onramps/{transferId}
Retrieve an onramp
1 param → 200401404500
POST
/v2/onramps/{transferId}/quote/accept
Accept an onramp quote
1 param → 200401404500
POST
/v2/onramps/{transferId}/quote/refresh
Refresh an onramp quote
1 param → 200401404500
GET
/v2/onramps/rates
Retrieve an onramp rate
2 params → 200401404500

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are InboundObject (12 properties), OnrampDepositInfoObject (10 properties), CreateBrlOnramp (6 properties), CreateMxnOnramp (6 properties). Each schema is shown below with its type and property counts.

CreateBrlOnramp
object
6 properties 3 required
OnrampAcceptedQuoteObject
object
MxnOnrampSource
object
3 properties 2 required
AfricaOnrampSource
object
4 properties 3 required
OnrampSource
object
5 properties 2 required
OnrampDestination
object
5 properties
OnrampQuoteObject
BrlOnrampSource
object
3 properties 2 required
OnrampAllRecordsObject
object
3 properties
CreateUsdOnramp
object
4 properties 3 required
InternalServerError
object
1 property
OnrampStatusEnum
string
Refer to [here](https://docs.hifibridge.com/docs/transfers/onrampstransaction-status) for more details on each onramp status.
OnrampRecordObject
OnrampObject
object
2 properties
FiatToCryptoConversionRateObject
object
4 properties
OnrampFee
object
2 properties 2 required
OnrampDepositInfoObject
object
10 properties
InboundObject
object
12 properties
CreateAfricaOnramp
object
6 properties 4 required
Unauthorized
object
1 property
CreateOnramp
object
6 properties 3 required
CreateMxnOnramp
object
6 properties 3 required
UsdOnrampSource
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hifi-onramp-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 Reporting API
Hifi Settlement Rules API
Hifi Token Swap API
Hifi Transfer Approvals API
Hifi User API