Skip to main content
POST
/
quotes
cURL
curl --request POST \
  --url https://dev-api.hyperail.io/api/v1/quotes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sourceCurrency": "NGN",
  "destinationCurrency": "USDT",
  "amount": 123,
  "destinationNetwork": "BASE"
}
'
[
  {
    "quoteId": "qte_123456",
    "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "sourceCurrency": "NGN",
    "destinationCurrency": "USDT",
    "destinationNetwork": "BASE",
    "rate": 1540.25,
    "providerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "providerBalanceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "amount": 20,
    "receiveAmount": 12.98,
    "totalAmount": 20.5,
    "expiresAt": "2025-12-17T13:20:41.005Z",
    "createdAt": "2025-12-17T13:20:41.005Z",
    "HyperRailReference": "HR-REF-239012",
    "status": "PENDING",
    "metadata": {
      "bankPayIn": {
        "accountName": "John Doe",
        "accountNumber": "0123456789",
        "bankName": "Access Bank"
      },
      "cryptoPayIn": {
        "addressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "address": "0xabc123...",
        "addressType": "EVM",
        "expectedAmount": 20,
        "externalReference": "EXT-REF-001",
        "status": "AWAITING_PAYMENT",
        "createdAt": "2025-12-17T13:20:41.005Z",
        "expiresAt": "2025-12-17T14:20:41.005Z",
        "virtualAccountId": "VA-001",
        "derivationIndex": 0,
        "warningMessage": "Send exact amount only"
      }
    },
    "fees": [
      {
        "name": "Processing Fee",
        "amount": 0.5,
        "feeType": "FLAT"
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
sourceCurrency
string
required

According, to our currently supported currencies, this is in NGN and GHS.

Example:

"NGN"

​
destinationCurrency
string
required
Example:

"USDT"

​
amount
number<int32>
required
​
destinationNetwork
string

The network for the destination currency

Example:

"BASE"

Response

Create quotes for exchange

​
quoteId
string
Example:

"qte_123456"

​
merchantId
string<uuid>
Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

​
sourceCurrency
string
Example:

"NGN"

​
destinationCurrency
string
Example:

"USDT"

​
destinationNetwork
string
Example:

"BASE"

​
rate
number<float>
Example:

1540.25

​
providerId
string<uuid>
Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

​
providerBalanceId
string<uuid>
Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

​
amount
number<float>
Example:

20

​
receiveAmount
number<float>
Example:

12.98

​
totalAmount
number<float>
Example:

20.5

​
expiresAt
string<date-time>
Example:

"2025-12-17T13:20:41.005Z"

​
createdAt
string<date-time>
Example:

"2025-12-17T13:20:41.005Z"

​
HyperRailReference
string
Example:

"HR-REF-239012"

​
status
string
Example:

"PENDING"

​
metadata
object
​
fees
object[]