Get offers

GET /v1/offers

List of purchase offers from On-Ramp providers.

HTTP request

https://fiat-api.changelly.com/v1/offers

Request

Request

Header parameters

Name	Type	Required	Description
X-Api-Key	string	true	Your public API key.
X-Api-Signature	string	true	The query's serialized body signed by your private key according to the RSA-SHA256 method.

Query parameters

Name	Type	Required	Description
providerCode	string	false	The On-Ramp provider code. Possible values.
externalUserID	string	false	User ID provided by you.
currencyFrom	string	true	Ticker of the pay-in currency in uppercase.
currencyTo	string	true	Ticker of the payout currency in uppercase.
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.
ip	string	false	User's IP address.

cURL

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

Response

Sample response

application/json

[
  {
    "providerCode": "moonpay",
    "rate": "0.00032333333333333335",
    "invertedRate": "3092.7835051546390158359",
    "fee": "6.46",
    "amountFrom": "150",
    "amountExpectedTo": "0.0485",
    "paymentMethodOffers": [
      {
        "amountExpectedTo": "0.0485",
        "method": "card",
        "methodName": "Visa / Mastercard",
        "rate": "0.00032333333333333335",
        "invertedRate": "3092.7835051546390158359",
        "fee": "6.46"
      },
      {
        "amountExpectedTo": "0.0484",
        "method": "apple_pay",
        "methodName": "Apple Pay / Google Pay",
        "rate": "0.00032266666666666663",
        "invertedRate": "3099.17355371900861664162",
        "fee": "6.46"
      }
    ]
  },
  {
    "providerCode": "banxa",
    "rate": "0.00032044666666666664",
    "invertedRate": "3120.6441009424347781758",
    "fee": "2.93",
    "amountFrom": "150",
    "amountExpectedTo": "0.04807",
    "paymentMethodOffers": [
      {
        "amountExpectedTo": "0.04807",
        "method": "card",
        "methodName": "Visa / Mastercard",
        "rate": "0.00032044666666666664",
        "invertedRate": "3120.6441009424347781758",
        "fee": "2.93"
      },
      {
        "amountExpectedTo": "0.04807",
        "method": "apple_pay",
        "methodName": "Apple Pay / Google Pay",
        "rate": "0.00032044666666666664",
        "invertedRate": "3120.6441009424347781758",
        "fee": "2.93"
      }
    ]
  },
  {
    "providerCode": "wert",
    "rate": "0.00031434813333333335",
    "invertedRate": "3181.18637892341001223344",
    "fee": "9.39",
    "amountFrom": "150",
    "amountExpectedTo": "0.04715",
    "paymentMethodOffers": [
      {
        "amountExpectedTo": "0.04715",
        "method": "card",
        "methodName": "Visa / Mastercard",
        "rate": "0.00031434813333333335",
        "invertedRate": "3181.18637892341001223344",
        "fee": "9.39"
      },
      {
        "amountExpectedTo": "0.04715",
        "method": "apple_pay",
        "methodName": "Apple Pay / Google Pay",
        "rate": "0.00031434813333333335",
        "invertedRate": "3181.18637892341001223344",
        "fee": "9.39"
      }
    ]
  },
  {
    "providerCode": "transak",
    "rate": "0.00032253533333333336",
    "invertedRate": "3100.43550784100114299121",
    "fee": "6.63",
    "amountFrom": "150",
    "amountExpectedTo": "0.04838",
    "paymentMethodOffers": [
      {
        "amountExpectedTo": "0.04838",
        "method": "apple_pay",
        "methodName": "Apple Pay / Google Pay",
        "rate": "0.00032253533333333336",
        "invertedRate": "3100.43550784100114299121",
        "fee": "6.63"
      },
      {
        "amountExpectedTo": "0.04804",
        "method": "card",
        "methodName": "Visa / Mastercard",
        "rate": "0.00032026186666666667",
        "invertedRate": "3122.4447993392073827663",
        "fee": "7.63"
      }
    ]
  }
]  

Response params

Name	Type	Description
offers	array of objects	Array of offers.

offers item schema

Name	Type	Required	Description
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.
invertedRate	string	true	Inverted rate of purchase.
fee	string	true	The lowest value of the total fee of purchase among all payment methods.
amountFrom	string	true	Amount of currency the user is going to pay.
amountExpectedTo	string	true	The largest amount of funds among all payment methods that the user is expected to get after the purchase.
paymentMethodOffers	array of objects	true	Purchase details for each available payment type.

paymentMethodOffers item schema

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

Error schema

Name	Type	Required	Description
providerCode	string	true	The On-Ramp provider code. Possible values.
errorType	string	true	Error type.
errorMessage	string	true	Error message.
errorDetails	array of objects	true	If the error contains no details, errorDetails equals null.

Possible error types:

Type	Description
validation	Validation error.
timeout	Request to the provider was not completed in the allotted time.
unavailable	Request failed at the provider's end.
limits	Specified pay-in amount is less than the minimum or more than the maximum value for the fiat currency.
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.
paymentMethod	Specified payment method is not supported by the provider.
invalidOffer	On-Ramp provider returned an invalid offer.

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	BadRequest
401	Unauthorized
429	TooManyRequests
500	InternalServerError

400

BadRequest

{
  "errorType": "validation",
  "errorMessage": "Validation error",
  "errorDetails": [
    {
      "cause": "providerCode",
      "value": "Incorrect provider code"
    }
  ]
}

401

Unauthorized

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

429

TooManyRequests

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

500

InternalServerError

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