Objective

Allow the partner to generate an outbound or inbound quotation by inputting some specific parameters. The generated quotes will be used later for creating transactions.

Functionalities

Through the quotation module, it is possible to:

Quotation Flow

This is the step in which the customer quotes the international transfer. With the quotation endpoint, the partner can build a calculator where the customer enters the amount they want to send and sees the final amount with costs and taxes applied.

The quote is the first step for creating an international transfer, it is an estimate of the foreign currency value along with the fees and taxes that must be displayed before proceeding to confirm the transfer.

When getting the response from the service, the partner will be able to display to the customer all the detailed information (amount, taxes, fees, VET, etc).

❗️

Quotation Expiration

The generated quote has an expiration time of 5 (five) minutes. After this period, the generated quote will expire and the customer will need to request a new quote.

❗️

VET

VET (Total Effective Value) is a mandatory field to be displayed to the customer on the quotation screen.

📍 1. Data for Creating a Quote

To request a quote, you need to provide the required parameters:

Below you can see an example of a full request for creating an outbound quotation for the purpose of "Own Account Abroad":

curl --request POST \
     --url https://fx-sandbox.remessaonline.com.br/v1/api/quotes \
     --header 'Authorization: Bearer {{token}}' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-token: {{x-token}}' \
     --data '
{
    "direction": "OUTBOUND",
    "purpose": "OWN_ACCOUNT_ABROAD",
    "inputCurrency": "BRL",
    "outputCurrency": "USD",
    "amount": "2332"
}

📍 2. Description of Available Purposes

The purpose corresponds to the reasons behind the international transfer, which could be outbound or inbound. The purposes available are:

📍 3. Description of Accepted Currencies

The destination currencies accepted for quotes are:

📍 4. Description of Accepted Classifications

The classifications accepted by the API are: