Skip to main content

Create Quote

POST 
/v1/crossborder/quotes

Create a new crossborder quote. The quote will be associated with the specified user, wallet, rate, client, and counterparty.

Request​

Header Parameters

    x-include-replay-protection-schema string

    The replay-protection-schema allows the user to choose between 3 options:

    • If there's no value: The default protection checks that the values in this request are equal: { method, params, path, query, body, userId }. This means that if a request repeats the same values, it will be blocked.
    • 'nonce': The nonce and { method, params, path, query, body, userId } value are checked. When the protection schema is this, requests will be OK if this nonce value is different in each request.
    • 'x-transaction-uuid': The transactionId and { method, params, path, query, body, userId } value are checked. Requests will be OK if this x-transaction-uuid value is different in each request.
    • 'x-transaction-uuid&nonce' or 'nonce&x-transaction-uuid': The nonce, transactionId value and { method, params, path, query, body, userId } are checked, i.e. if requests are repeated the same value in both fields, they will be blocked. But if any field has a different value, the request is OK.

    x-transaction-uuid stringrequired

    The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

    x-product-uuid string

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

    x-wallet-uuid string

    Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

Body

required
    rate_id stringrequired

    Rate ID.

    client_id stringrequired

    Client ID.

    counterparty_id stringrequired

    Counterparty ID.

    client_account_id string

    Client account ID.

    client_wallet_id string

    Client wallet ID.

    counterparty_account_id string

    Counterparty account ID.

    counterparty_wallet_id string

    Counterparty wallet ID.

    description string

    Description.

    purpose stringrequired

    Purpose of the quote.

Responses​

Quote created successfully.

Schema
    id stringrequired

    Quote ID.

    status stringrequired

    Possible values: [PENDING, CREATED, APPROVED, PAID, SETTLED, FAILED]

    Status.

    rate objectrequired
    id stringrequired

    Rate ID.

    base_currency_symbol stringrequired

    Possible values: [USD, BRL, EUR, MXN, ARS, COP, CLP, PEN, ECU, UYU, PYG, USDC, USDT]

    Base currency symbol.

    base_currency_decimals numberrequired

    Base currency decimals.

    quote_currency_symbol stringrequired

    Possible values: [USD, BRL, EUR, MXN, ARS, COP, CLP, PEN, ECU, UYU, PYG, USDC, USDT]

    Quote currency symbol.

    quote_currency_decimals numberrequired

    Quote currency decimals.

    side stringrequired

    Possible values: [BUY, SELL]

    Side.

    price numberrequired

    Price.

    price_decimals numberrequired

    Price decimals.

    fees object[]required

    Fees charged.

  • Array [
    • name stringrequired

    Possible values: [SYSTEM_SPREAD, CLIENT_EXTRA_SPREAD, IOF]

    Fee name.

    fee numberrequired

    Fee.

    fee_format stringrequired

    Possible values: [PERCENTAGE]

    Fee format.

    amount numberrequired

    Fee total amount charged in cents.

    amount_decimals numberrequired

    Amount decimals.

    amount_currency_symbol stringrequired

    Possible values: [USD, BRL, EUR, MXN, ARS, COP, CLP, PEN, ECU, UYU, PYG, USDC, USDT]

    Amount currency symbol.

  • ]
    • vet numberrequired

    VET.

    base_currency_amount numberrequired

    Base currency amount in cents.

    quote_currency_amount numberrequired

    Quote currency amount in cents.

    settlement_date_code stringrequired

    Possible values: [D0, D1, D2]

    Settlement date code.

    settlement_date date-timerequired

    Settlement date in YYYY-MM-DD format.

    expires_at date-timerequired

    Expiration date in YYYY-MM-DDTHH:mm:ss.SSSZ format.

    created_at date-timerequired

    Creation date in YYYY-MM-DDTHH:mm:ss.SSSZ format.

    client objectrequired
    id stringrequired

    Client ID.

    name stringrequired

    Client name. For legal entities, the name field corresponds to the legal name.

    email string

    Client email.

    type string

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Client type.

    country object

    Client country.

    phone_number string

    Client phone number.

    document string

    Client document.

    client_account objectrequired
    id stringrequired

    Client account ID.

    account_type string

    Possible values: [CHECKING, SAVINGS]

    Client account type.

    account_number string

    Client account number.

    branch string

    Client branch.

    bank_name string

    Client bank name.

    bank_code string

    Client bank code.

    client_wallet objectrequired
    id stringrequired

    Client wallet ID.

    counterparty objectrequired
    id stringrequired

    Counterparty ID.

    name stringrequired

    Counterparty name. For legal entities, the name field corresponds to the legal name.

    email string

    Counterparty email.

    type string

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Counterparty type.

    country object

    Counterparty country.

    phone_number string

    Counterparty phone number.

    document string

    Counterparty document.

    counterparty_account object
    id stringrequired

    Counterparty account ID.

    account_type string

    Possible values: [CHECKING, SAVINGS]

    Counterparty account type.

    account_number string

    Counterparty account number.

    branch string

    Counterparty branch.

    bank_name string

    Counterparty bank name.

    bank_code string

    Counterparty bank code.

    counterparty_wallet object
    id stringrequired

    Counterparty wallet ID.

    deposit_info objectrequired
    currency_symbol stringrequired

    Possible values: [USD, BRL, EUR, MXN, ARS, COP, CLP, PEN, ECU, UYU, PYG, USDC, USDT]

    Currency symbol.

    country_code string

    Possible values: [US, BR, MX, AR, CO, CL, PE, EC, UY, PY]

    Country code.

    type stringrequired

    Possible values: [TED]

    Type.

    details objectrequired

    Beneficiary document.

    description string

    Description.

    purpose string

    Purpose of the quote.

    created_at date-timerequired

    Quote created date.

Loading...