Get Crossborder Rate

GET 
/v1/crossborder/rates

Returns an exchange rate for the requested currency pair, side, and amount. The rate is valid for a limited period. To lock in the rate and proceed with the exchange, submit the returned rate ID to the quote endpoint (POST /crossborder/quotes).

Request

Query Parameters

base_currency_symbol stringrequired

Base currency symbol.

quote_currency_symbol stringrequired

Quote currency symbol.

amount_currency stringrequired

Possible values: [BASE_CURRENCY, QUOTE_CURRENCY]

Amount currency.

amount numberrequired

Amount in cents.

side stringrequired

Possible values: [BUY, SELL]

Side.

settlement_date_code stringrequired

Possible values: [D0, D1, D2]

Settlement date code.

client_extra_spread number

Client extra spread in percentage.

client_id stringrequired

Client ID.

client_account_id string

Client account ID.

client_wallet_id string

Client wallet ID.

counterparty_id stringrequired

Counterparty ID.

counterparty_account_id string

Counterparty account ID.

counterparty_wallet_id string

Counterparty wallet ID.

Header Parameters

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.

x-wallet-uuid string

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

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.

Responses

200

Rate returned successfully.

application/json

Schema

Schema

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.

Example (from schema)

{
  "id": "f6e2e084-29b9-4935-a059-5473b13033aa",
  "base_currency_symbol": "USD",
  "base_currency_decimals": 2,
  "quote_currency_symbol": "BRL",
  "quote_currency_decimals": 2,
  "side": "BUY",
  "price": 5.1234,
  "price_decimals": 4,
  "fees": [
    {
      "name": "SYSTEM_SPREAD",
      "fee": 1,
      "fee_format": "PERCENTAGE",
      "amount": 100,
      "amount_decimals": 4,
      "amount_currency_symbol": "BRL"
    }
  ],
  "vet": 5.1234,
  "base_currency_amount": 10000,
  "quote_currency_amount": 51234,
  "settlement_date_code": "D0",
  "settlement_date": "2026-03-26",
  "expires_at": "2026-03-26T14:02:59.411Z",
  "created_at": "2026-03-26T14:02:59.411Z"
}

401

User authentication failed.

application/json

Schema

Schema

any

Example (from schema)

{
  "statusCode": 401,
  "error": "USER",
  "message": "Access is denied."
}

403

User access denied.

application/json

Schema

Schema

any

Example (from schema)

{
  "statusCode": 403,
  "error": "USER",
  "message": "Access denied to requested resource. User may not have sufficient permission."
}

422

If any required params are missing or have invalid format or type.

application/json

Schema

Schema

any

Example (from schema)

{
  "statusCode": 422,
  "error": "USER",
  "message": "Invalid quote currency amount. The minimum allowed is 100, and you requested 61.",
  "code": "INVALID_QUOTE_CURRENCY_MIN_AMOUNT"
}

Loading...