Get a quote

Get quote details and validity

curl --request GET \
  --url https://api.lbpay.example.com/v1/fx/quotes/{quoteId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.lbpay.example.com/v1/fx/quotes/{quoteId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lbpay.example.com/v1/fx/quotes/{quoteId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lbpay.example.com/v1/fx/quotes/{quoteId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.lbpay.example.com/v1/fx/quotes/{quoteId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "code": "QUOTE_EXPIRED",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": [
    {
      "field": "<string>",
      "reason": "<string>"
    }
  ]
}

{
  "code": "QUOTE_EXPIRED",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": [
    {
      "field": "<string>",
      "reason": "<string>"
    }
  ]
}

GET

quotes

{quoteId}

Get quote details and validity

curl --request GET \
  --url https://api.lbpay.example.com/v1/fx/quotes/{quoteId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.lbpay.example.com/v1/fx/quotes/{quoteId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lbpay.example.com/v1/fx/quotes/{quoteId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lbpay.example.com/v1/fx/quotes/{quoteId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.lbpay.example.com/v1/fx/quotes/{quoteId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "code": "QUOTE_EXPIRED",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": [
    {
      "field": "<string>",
      "reason": "<string>"
    }
  ]
}

{
  "code": "QUOTE_EXPIRED",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": [
    {
      "field": "<string>",
      "reason": "<string>"
    }
  ]
}

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.

Show child attributes

Example:

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

destination

object

required

Valor exato em BRL que o beneficiário recebe.

Show child attributes

Example:

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

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.

Show child attributes

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.

Overview

Health

FX Quotes

Inventories

Remittances

Senders

Beneficiaries

Credit line

Limits

Wallets

Settlements

Webhooks

Authorizations

Path Parameters

Response