Get offers

List of purchase offers from On-Ramp providers.

HTTP request

get

/v1/offers

Request

Header parameters

Requires authentification.

Query parameters

Name	Type	Required	Description
amountFrom	string	true	Amount of currency the user is going to pay.
country	string	true	Country ISO 3166-1 code (Alpha-2).
state	string	false	State ISO 3166-2 code. Is required if provided country is US.
currencyFrom	string	true	Ticker of the payin currency in uppercase.
currencyTo	string	true	Ticker of the payout currency in uppercase.
externalUserID	string	false	User ID provided by you.
ip	string	false	User's IP address.
providerCode	string	false	The On-Ramp provider code. Possible values.

Sample cURL

curl --location --request GET
'https://fiat-api.changelly.com/v1/offers?externalUserId=122hd&currencyFrom=EUR&currencyTo=ETH&amountFrom=150&country=FR'
--header 'X-Api-Key: {{apiKey}}'
--header 'X-Api-Signature: {{signature}}'

Response

Response params

Name	Type	Description
offers	array of objects	Array of offers. The array can contain an object with the invalid offer.

offer item schema

Name	Type	Required	Description
amountExpectedTo	string	true	The largest amount of funds among all payment methods that the user is expected to get after the purchase.
amountFrom	string	true	Amount of currency the user is going to pay.
fee	string	true	The lowest value of the total fee of purchase among all payment methods.
invertedRate	string	true	Inverted rate of purchase.
offerId	string	true	Offer ID provided by Fiat API.
paymentMethodOffer	array of objects	true	Purchase details for each available payment type.
providerCode	string	true	The On-Ramp provider code. Possible values.
rate	string	true	The best rate of purchase among all payment methods. The rate includes all the fees.

paymentMethodOffer item schema

Name	Type	Required	Description
amountExpectedTo	string	true	The amount of funds that the user is expected to get after the purchase.
fee	string	true	Total fee of purchase.
invertedRate	string	true	Inverted rate of purchase.
method	string	true	The payment method code. Possible values.
methodName	string	true	The payment method name. Possible values.
offerId	string	true	Offer ID provided by Fiat API.
rate	string	true	Current rate of purchase, which includes all the fees.

Sample response

application/json

[
  {
    "providerCode": "wert",
    "errorType": "currency",
    "errorMessage": "Unsupported exchange pair",
    "errorDetails": null
  },
  {
    "providerCode": "moonpay",
    "offerId": "e38e0d37-8a70-4d20-b4e0-14aca4a3de4b",
    "rate": "0.00000753333333333333",
    "invertedRate": "132743.36283185846581564727",
    "fee": "5.32",
    "amountFrom": "150",
    "amountExpectedTo": "0.00113",
    "paymentMethodOffer": [
      {
        "offerId": "e38e0d37-8a70-4d20-b4e0-14aca4a3de4b",
        "amountExpectedTo": "0.00113",
        "method": "revolut",
        "methodName": "Revolut",
        "rate": "0.00000753333333333333",
        "invertedRate": "132743.36283185846581564727",
        "fee": "5.32"
      },
      {
        "offerId": "fa4a96a8-b95a-4880-8a49-b5faa053792c",
        "amountExpectedTo": "0.00105",
        "method": "card",
        "methodName": "Visa / Mastercard",
        "rate": "0.000007",
        "invertedRate": "142857.14285714285714285714",
        "fee": "9.09"
      }
    ]
  },
  {
    "providerCode": "banxa",
    "offerId": "5cf80399-c5a8-4154-88de-218c8b3437da",
    "rate": "0.0000075532",
    "invertedRate": "132394.21702060054016840544",
    "fee": "3.15",
    "amountFrom": "150",
    "amountExpectedTo": "0.00113298",
    "paymentMethodOffer": [
      {
        "offerId": "5cf80399-c5a8-4154-88de-218c8b3437da",
        "amountExpectedTo": "0.00113298",
        "method": "apple_pay",
        "methodName": "Apple Pay",
        "rate": "0.0000075532",
        "invertedRate": "132394.21702060054016840544",
        "fee": "3.15"
      }
    ]
  }
]

Error response

Error response parameters

Check the error response schema.

Possible error types in the errorType item:

Type	Description
country	Specified country is not supported by the provider.
state	Offer requested for the United States, but the state parameter is not provided.
currency	Specified currency pair is not supported by the provider.
invalidOffer	On-Ramp provider returned an invalid offer.
limits	Specified payin amount is less than the minimum or more than the maximum value for the fiat currency.
paymentMethod	Specified payment method is not supported by the provider.
timeout	Request to the provider was not completed in the allotted time.
unavailable	Request failed at the provider's end.
validation	Validation error.

The errorDetails item schema:

Name	Type	Required	Description
cause	string	true	Error cause. For example, it can equal min or max for the limits error type.
value	string	true	Error value. For example, it can equal the min or max supported value for the limits error type.

Error codes

Code	Message
400	Bad request
401	Unauthorized
404	Not found
429	Too many requests
500	Internal server error

400

Bad Request

{
  "providerCode": "moonpay",
  "errorType": "limits",
  "errorMessage": "Too low in amount",
  "errorDetails": [
    {
      "cause": "min",
      "value": "20"
    }
  ]
}

401

Unauthorized

{
  "errorType": "unauthorized",
  "errorMessage": "Unauthorized",
  "errorDetails": null
}

404

Not Found

{
  "errorType": "notFound",
  "errorMessage": "Not found",
  "errorDetails": null
}

429

Too Many Requests

{
  "errorType": "tooManyRequests",
  "errorMessage": "Too many requests",
  "errorDetails": null
}

500

Internal Server Error

{
  "errorType": "internalServerError",
  "errorMessage": "Internal Server Error",
  "errorDetails": null
}