Skip to main content
GET
Get quote details and validity

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

quoteId
string
required

Response

Quote details

Preço único para a remessa, igual para PREFUNDED e CREDIT. O valor recebido pelo beneficiário (destination) não depende da modalidade de funding. A única tarifa é o spread: rate = referenceRate × (1 − spread.percentage / 100).

quoteId
string
required
Example:

"qt_01J9Z3"

status
enum<string>
required

AVAILABLE: pode ser usada até expiresAt. USED: consumida por uma remessa (REMITTANCE) ou por um Inventory Lot (INVENTORY). EXPIRED: venceu sem uso.

Available options:
AVAILABLE,
USED,
EXPIRED
fromCurrency
enum<string>
required
Available options:
USD
toCurrency
enum<string>
required
Available options:
BRL
source
object
required

Valor em USD enviado pela MSB.

Example:
destination
object
required

Valor exato em BRL que o beneficiário recebe.

Example:
referenceRate
string
required

Taxa de referência de mercado sobre a qual o spread é calculado.

Pattern: ^[0-9]+(\.[0-9]{1,8})?$
Example:

"5.44000000"

rate
string
required

Taxa aplicada à remessa, já com o spread.

Pattern: ^[0-9]+(\.[0-9]{1,8})?$
Example:

"5.39920000"

spread
object
required

Spread de câmbio: única tarifa da remessa.

expiresAt
string<date-time>
required
createdAt
string<date-time>
required
remittanceId
string | null

Remessa que usou a cotação; preenchido quando status = USED.

externalId
string | null

externalId da remessa ou do Inventory que usou a cotação.

usage
enum<string>
default:REMITTANCE

Uso da cotação. REMITTANCE (padrão): usada por um withdrawal. INVENTORY: usada para criar um Inventory Lot (POST /v1/inventories). Usar a cotação na operação errada retorna QUOTE_USAGE_MISMATCH. Enum extensível.

Available options:
REMITTANCE,
INVENTORY
inventoryId
string | null

Inventory Lot criado a partir da cotação; preenchido quando usage = INVENTORY e status = USED.

inventoryExpiresAt
string<date-time> | null

Somente usage = INVENTORY. Validade que o Inventory Lot terá se for criado com esta cotação. Não confundir com expiresAt, que é a validade da própria cotação.