Get Quotation

Get Quotation

GET{{Environment_URL}}/vendors/v1/vendors/quotation/:amount/:currency

Before starting the process of creating a payment, it is necessary to obtain a quotation for the desired amount.

Field
Type
Description
Required

amount

Number

Amount desired (given in cents). The minimum and maximum amounts for the get quotation route are denominated in USD, set at USD 0.01 and USD 22.000,00 respectively.

true

currency

String

Original currency

true

The response will have the quotation id, you must use it to create a new charge.

Important note about currency.clamp

When consuming the quotation endpoint, developers must always check the currency.clamp field in the response. This field can have two possible values:

NORMAL → The quotation was calculated normally, without hitting any limits.

MAXIMUM → The quotation has reached the maximum allowed value. In this case, the returned amount is already capped at the defined limit, currently 22,000 USD.

⚠️ Attention: If the response indicates MAXIMUM, it means the amount used for the calculation is already the maximum allowed. This exact value will also be applied in the create charge operation, so it is essential not to recalculate or assume a different amount than the one returned by the quotation.

💡 Note: The maximum allowed value is also exposed in the field currency.maxValueSimplePay.

Path Params

Name
Type
Description
Value

amount

number

desired amount

5197

currency

string

currency

USD

Response

{
    "id": "951d2271db9925770dfdcc29c76dfd6b77eefda0",
    "metadata": {
        "type": "CHARGE",
        "externalId": "vnd_01..."
    },
    "currency": {
        "code": "USD",
        "name": "Dólar Americano",
        "commercialExchangeRate": {
            "value": 60830,
            "divisor": 10000,
            "currency": "BRL",
            "precision": 4,
            "updatedAt": "2023-08-14T20:08:25.000Z"
        },
        "countryFlagUrl": "https://s3.amazonaws.com/simple-exchanges-demo/new-flags/united-states.svg",
        "levelingRate": {
            "value": 60830,
            "divisor": 10000,
            "currency": "BRL",
            "precision": 4
        },
        "maxValueSimplePay": {
            "value": 2000000,
            "divisor": 100,
            "currency": "USD",
            "precision": 2
        },
        "minValueSimplePay": {
            "value": 1,
            "divisor": 100,
            "currency": "USD",
            "precision": 2
        },
        "clamp": "MAXIMUM",
        "offer": {
            "value": 2000000,
            "divisor": 100,
            "currency": "USD",
            "precision": 2
        },
        "offerUSD": {
            "value": 2000000,
            "divisor": 100,
            "currency": "USD",
            "precision": 2
        },
        "price": {
            "withoutSpread": {
                "value": 60830,
                "divisor": 10000,
                "currency": "BRL",
                "precision": 4
            },
            "withoutTax": {
                "value": 63263,
                "divisor": 10000,
                "currency": "BRL",
                "precision": 4
            },
            "withTax": {
                "value": 63504,
                "divisor": 10000,
                "currency": "BRL",
                "precision": 4
            },
            "withTaxesAndFees": {
                "value": 63507,
                "divisor": 10000,
                "currency": "BRL",
                "precision": 4
            },
            "withFutureTax": {
                "value": 63507,
                "divisor": 10000,
                "currency": "BRL",
                "precision": 4
            }
        },
        "spreads": [
            {
                "name": "SPREAD_VENDOR",
                "type": "percentage",
                "percentage": 4,
                "receiver": "VENDOR_FEE",
                "netValue": {
                    "value": 486640,
                    "divisor": 100,
                    "currency": "BRL",
                    "precision": 2
                }
            },
            {
                "name": "SPREAD_FC",
                "type": "percentage",
                "percentage": 0,
                "receiver": "PLATFORM_FEE",
                "netValue": {
                    "value": 0,
                    "divisor": 100,
                    "currency": "BRL",
                    "precision": 2
                }
            },
            {
                "name": "SPREAD_SUPER_VENDOR",
                "type": "percentage",
                "percentage": 0,
                "receiver": "SUPER_VENDOR",
                "netValue": {
                    "value": 0,
                    "divisor": 100,
                    "currency": "BRL",
                    "precision": 2
                }
            }
        ],
        "fees": [
            {
                "name": "FEE_FC",
                "type": "absolute",
                "value": 0,
                "receiver": "PLATFORM_FEE",
                "netValue": {
                    "value": 0,
                    "divisor": 100,
                    "currency": "BRL",
                    "precision": 2
                }
            },
            {
                "name": "FEE_VENDOR",
                "type": "absolute",
                "value": 100,
                "receiver": "VENDOR_FEE",
                "netValue": {
                    "value": 608,
                    "divisor": 100,
                    "currency": "BRL",
                    "precision": 2
                }
            },
            {
                "name": "FEE_SUPER_VENDOR",
                "type": "absolute",
                "value": 0,
                "receiver": "SUPER_VENDOR",
                "netValue": {
                    "value": 0,
                    "divisor": 100,
                    "currency": "BRL",
                    "precision": 2
                }
            }
        ]
    },
    "tax": {
        "iof": {
            "percentage": 0,
            "total": {
                "value": 0,
                "divisor": 100,
                "currency": "BRL",
                "precision": 2
            }
        }
    },
    "taxesAndCosts": {
        "value": 48080,
        "divisor": 100,
        "currency": "BRL",
        "precision": 2
    },
    "futureTax": {
        "ir": {
            "percentage": 0,
            "total": {
                "value": 0,
                "divisor": 100,
                "currency": "BRL",
                "precision": 2
            }
        }
    },
    "total": {
        "withoutSpread": {
            "value": 12166000,
            "divisor": 100,
            "currency": "BRL",
            "precision": 2
        },
        "withoutTax": {
            "value": 12652640,
            "divisor": 100,
            "currency": "BRL",
            "precision": 2
        },
        "withTax": {
            "value": 12700720,
            "divisor": 100,
            "currency": "BRL",
            "precision": 2
        },
        "withTaxesAndFees": {
            "value": 12701328,
            "divisor": 100,
            "currency": "BRL",
            "precision": 2
        },
        "withFutureTax": {
            "value": 12701328,
            "divisor": 100,
            "currency": "BRL",
            "precision": 2
        }
    },
    "createdAt": "2025-09-26T18:23:44.450Z"
}