Quotations

Quotations

GET {{Environment_URL}}/v1/exchanges/paper-money/quotations/:merchant_id?currency=USD&value=23500&reverse=false

This route is responsible for the return of quotation information about all currencies.

It is possible to inform the quotation of a specific currency and value should all query params are passed.

If the quotation exceeds the minimum or the maximum limit, the offer will rounded for the limits range and a rounding attribute will be returned with information about it.

• NORMAL: The value is in the limits range

• MINIMUM: The value is lower than minimum to sell

• MAXIMUM: The value is higher than maximum to sell

The value passed in the URL parameter must be multiplied by 100, as it has precision of two decimal places, for example, for a quote of 100, it would send 10000. For structures with value and divisor, value refers to the entire value, and the divisor refers to the precision of that value. To obtain the result with decimal places, just divide the value by the divisor.

For more information check the examples request.

Quotation

Attribute	Description	Type
id	Quotation unique identifier	String
Reverse	Indicates if quotation is from foreign currency to BRL if false or BRL to foreign currency if true	Boolean
purposeCode	Quotation type identifier (nowadays always IR003)	String
currency	Currency info	Currency
tax	Tax applied to current quotation	Tax
price	Price information of current quotation	Price
total	Totals of current quotation	Total
createdAt	Creation date and time	DateTime
expireAt	Expiration date and time	DateTime
timeToLive	Amount in seconds that current quotation is valid	Integer
merchantId	Correspondent store unique identifier	String
rounding	Rounding information for current quotation	Rounding

Value

Attribute	Description	Type
value	amount	Integer
divisor	value precision	Integer

Currency

Attribute	Description	Type
countryFlagUrl	URL for country flag icon	String
code	Currency unique identifier	String
name	Currency name	String
coverageRatePercentage	Percentage of currency coverage rate	Decimal
offer	Final amount offered in current currency with current quotation	Integer
offerUSD	Offer value in USD currency	Value
parityFromUSD	Rate of USD to current currency	Value
parityToUSD	Rate of current currency to USD value	Value
spreadPercentage	Spread percentage of current currency	Decimal
maxToSell	maximum amount to sell for current currency	Integer
minToSell	minimum amount to sell for current currency	Integer
multiples	List of available notes for current currency	Array
commercialExchangeRate	Commercial exchange rate for current currrency	Value
levelingRate	Leveling rate applied to current currency	Value

Tax

Attribute	Description	Type
IOF	IOF tax applied to current quotation	IOF

IOF

Attribute	Description	Type
percentage	Tax percentage applied	Decimal
total	amount in money applied to current quotation	Value

Price

Attribute	Description	Type
withoutTax	price to pay without taxes applied	Value
withTax	price to pay with taxes applied	Value

Total

Attribute	Description	Type
withoutTax	total price to pay without taxes applied	Value
withTax	total price to pay with taxes applied	Value

Rounding

Attribute	Description	Type
method	rounding method used with current quotation	RoundingMethod
rounded	TRUE if quotation was rounded, FALSE otherwise	Boolean

Enum RoundingMethod

Name	Description
NORMAL	Rounded using only multiples
MAXIMUM	Rounded using maximum amount to sell for a given currency
MINIMUM	Rounded using minimum amount to sell for a given currency

Path Params

Name	Value	Description
merchant_id	WL-FRENTE-SP	Correspondent store unique identifier

Query Params

Name	Value	Description
currency	USD	(Required) Currency to generate quotation for
value	23500	(Required) Value proposal to generate
reverse	false	(Required) If generation should be reversed, that is, if TRUE will generate quotation from BRL to given currency

Response

200 - Success

{
  "id": "933acc3df6e91f365c016506fc9ad783f0e4af41",
  "reverse": false,
  "purposeCode": "IR003",
  "currency": {
    "countryFlagUrl": "https://s3.amazonaws.com/frente-exchanges/flags/united-states.svg",
    "code": "USD",
    "name": "Dólar Americano",
    "coverageRatePercentage": 89,
    "offer": 65320,
    "offerUSD": {
      "value": 653200000,
      "divisor": 10000
    },
    "parityFromUSD": {
      "value": 10000,
      "divisor": 10000
    },
    "parityToUSD": {
      "value": 10000,
      "divisor": 10000
    },
    "spreadPercentage": 2.52,
    "maxToSell": 65320,
    "minToSell": 184,
    "multiples": [
      20,
      50,
      100
    ],
    "commercialExchangeRate": {
      "value": 38360,
      "divisor": 10000
    },
    "levelingRate": {
      "value": 72500,
      "divisor": 10000
    }
  },
  "tax": {
    "iof": {
      "percentage": 1.1,
      "total": {
        "value": 534054,
        "divisor": 100
      }
    }
  },
  "price": {
    "withoutTax": {
      "value": 74327,
      "divisor": 10000
    },
    "withTax": {
      "value": 75145,
      "divisor": 10000
    }
  },
  "total": {
    "withoutTax": {
      "value": 48550396,
      "divisor": 100
    },
    "withTax": {
      "value": 49084714,
      "divisor": 100
    }
  },
  "createdAt": "2019-11-06T14:06:14.887Z",
  "expiresAt": "2019-11-06T14:16:14.000Z",
  "timeToLive": 600,
  "merchantId": "WL-FRENTE-SP",
  "rounding": {
    "method": "MAXIMUM",
    "rounded": true
  }
}