Solicitar cotação

Retorna o preço para o cliente: valores, taxa de referência, taxa aplicada e spread em %. A cotação não é vinculada a remetente nem a operação. Não valida remetente, não reserva limite, não contrata câmbio e não cria remessa. Elegibilidade do remetente, limites, habilitação de funding, limite de crédito e saldo PREFUNDED são verificados na criação da remessa (POST /v1/remittances/withdrawals). Uma cotação pode ser usada por uma única remessa.

Com usage = INVENTORY a cotação é usada uma única vez para criar um Inventory Lot (POST /v1/inventories) e não pode ser usada em withdrawal; a resposta informa inventoryExpiresAt, a validade que o lote terá se for criado. Cotações sem usage são REMITTANCE e mantêm o comportamento atual.

POST /v1/fx/quotes

cURL

fixedSource

curl --request POST \
  --url https://api.lbpay.example.com/v1/fx/quotes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "fromCurrency": "USD",
  "toCurrency": "BRL",
  "sourceAmount": "1000.00"
}
'

201

{
  "quoteId": "qt_01J9Z3",
  "status": "AVAILABLE",
  "fromCurrency": "USD",
  "toCurrency": "BRL",
  "source": {
    "currency": "USD",
    "amount": "1000.00"
  },
  "destination": {
    "currency": "BRL",
    "amount": "5383.20"
  },
  "referenceRate": "5.44000000",
  "rate": "5.39920000",
  "spread": {
    "percentage": "0.75",
    "amount": {
      "currency": "USD",
      "amount": "7.50"
    }
  },
  "expiresAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "remittanceId": "<string>",
  "externalId": "<string>",
  "usage": "REMITTANCE",
  "inventoryId": "<string>",
  "inventoryExpiresAt": "2023-11-07T05:31:56Z"
}

Autorizações

Authorization · string · header · obrigatório

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

Cabeçalhos

Idempotency-Key · string · obrigatório

Unique key to prevent duplicate creation or execution.

Required string length: 8 - 128

Corpo

application/json

Option 1

Option 2

Informe exatamente um entre sourceAmount (valor fixo em fromCurrency, enviado pela MSB) e destinationAmount (valor fixo em toCurrency, recebido pelo beneficiário).

fromCurrency · enum<string> · obrigatório

v1: apenas USD.

Opções disponíveis: USD

toCurrency · enum<string> · obrigatório

v1: apenas BRL.

Opções disponíveis: BRL

sourceAmount · string · obrigatório

Decimal como string, estritamente maior que zero.

Pattern: ^(0\.(0[1-9]|[1-9][0-9]?)|[1-9][0-9]*(\.[0-9]{1,2})?)$

Exemplo:

"1000.00"

destinationAmount · string

Decimal como string, estritamente maior que zero.

Pattern: ^(0\.(0[1-9]|[1-9][0-9]?)|[1-9][0-9]*(\.[0-9]{1,2})?)$

Exemplo:

"1000.00"

usage · enum<string> · padrão: 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.

Opções disponíveis: REMITTANCE, INVENTORY

Resposta

201

application/json

Quote created

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 · obrigatório

Exemplo:

"qt_01J9Z3"

status · enum<string> · obrigatório

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

Opções disponíveis: AVAILABLE, USED, EXPIRED

fromCurrency · enum<string> · obrigatório

Opções disponíveis: USD

toCurrency · enum<string> · obrigatório

Opções disponíveis: BRL

source · object · obrigatório

Valor em USD enviado pela MSB.

Show child attributes

Exemplo:

{ "currency": "USD", "amount": "1000.00" }

destination · object · obrigatório

Valor exato em BRL que o beneficiário recebe.

Show child attributes

Exemplo:

{ "currency": "BRL", "amount": "5383.20" }

referenceRate · string · obrigatório

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

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

Exemplo:

"5.44000000"

rate · string · obrigatório

Taxa aplicada à remessa, já com o spread.

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

Exemplo:

"5.39920000"

spread · object · obrigatório

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

Show child attributes

expiresAt · string<date-time> · obrigatório

createdAt · string<date-time> · obrigatório

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> · padrão: 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.

Opções disponíveis: 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.