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

Offramp endpoints

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

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

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

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

Paths & Operations 5

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

Offramp 5

Offramp endpoints

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

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are OfframpDestination (11 properties), UsdOfframpDestination (8 properties), CreateUsdOfframp (8 properties), CreateOfframp (8 properties). Each schema is shown below with its type and property counts.

CreateMexicoGlobalNetworkOfframp
object
6 properties 3 required
CreateChinaGlobalNetworkOfframp
object
6 properties 3 required
OfframpConversionRateObject
object
4 properties
CreateCopOfframp
object
6 properties 3 required
AfricaOfframpDestination
object
4 properties 2 required
CreateHongKongGlobalNetworkOfframp
object
6 properties 3 required
HongKongOfframpDestination
object
5 properties 2 required
OfframpAcceptedQuoteObject
OfframpAllRecordsObject
object
3 properties
CreateBrazilGlobalNetworkOfframp
object
6 properties 3 required
OfframpDestination
object
11 properties 2 required
MxnOfframpDestination
object
5 properties 2 required
InternalServerError
object
1 property
CreateNigeriaGlobalNetworkOfframp
object
6 properties 3 required
BrlOfframpDestination
object
5 properties 3 required
DeveloperFee
object
1 property 1 required
ArsOfframpDestination
object
4 properties 2 required
CreateMxnOfframp
object
6 properties 3 required
OfframpRecordObject
CreateArsOfframp
object
6 properties 3 required
NigeriaOfframpDestination
object
5 properties 2 required
OfframpDepositInstructionsList
array
OfframpObject
object
2 properties
OfframpSource
object
5 properties 2 required
Unauthorized
object
1 property
CopOfframpDestination
object
4 properties 2 required
OfframpPaymentTrackingObject
object
5 properties
ChinaOfframpDestination
object
5 properties 2 required
UsdOfframpDestination
object
8 properties 2 required
CreateAfricaOfframp
object
6 properties 4 required
CreateBrlOfframp
object
6 properties 3 required
CreateUsdOfframp
object
8 properties 3 required
OfframpStatusEnum
string
Refer to [here](https://docs.hifibridge.com/docs/transfers/offrampstransaction-status) for more details on each offramp status.
CreateOfframp
object
8 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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