Consultar Inventory Lot

Get an inventory lot with balances

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

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

fetch('https://api.lbpay.example.com/v1/inventories/{inventoryId}', 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/inventories/{inventoryId}",
  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/inventories/{inventoryId}"

	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/inventories/{inventoryId}")

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

{
  "inventoryId": "inv_01JA2B",
  "quoteId": "<string>",
  "status": "ACTIVE",
  "fromCurrency": "USD",
  "toCurrency": "BRL",
  "rate": "5.40000000",
  "total": {
    "source": {
      "currency": "USD",
      "amount": "1000.00"
    },
    "destination": {
      "currency": "USD",
      "amount": "1000.00"
    }
  },
  "available": {
    "source": {
      "currency": "USD",
      "amount": "1000.00"
    },
    "destination": {
      "currency": "USD",
      "amount": "1000.00"
    }
  },
  "reserved": {
    "source": {
      "currency": "USD",
      "amount": "1000.00"
    },
    "destination": {
      "currency": "USD",
      "amount": "1000.00"
    }
  },
  "used": {
    "source": {
      "currency": "USD",
      "amount": "1000.00"
    },
    "destination": {
      "currency": "USD",
      "amount": "1000.00"
    }
  },
  "expiresAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "externalId": "<string>",
  "referenceRate": "5.43210000",
  "spread": {
    "percentage": "0.75",
    "amount": {
      "currency": "USD",
      "amount": "7.50"
    }
  },
  "pendingSettlement": {
    "currency": "USD",
    "amount": "1000.00"
  },
  "settlementId": "<string>",
  "metadata": {}
}

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

inventories

{inventoryId}

Get an inventory lot with balances

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

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

fetch('https://api.lbpay.example.com/v1/inventories/{inventoryId}', 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/inventories/{inventoryId}",
  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/inventories/{inventoryId}"

	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/inventories/{inventoryId}")

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

{
  "inventoryId": "inv_01JA2B",
  "quoteId": "<string>",
  "status": "ACTIVE",
  "fromCurrency": "USD",
  "toCurrency": "BRL",
  "rate": "5.40000000",
  "total": {
    "source": {
      "currency": "USD",
      "amount": "1000.00"
    },
    "destination": {
      "currency": "USD",
      "amount": "1000.00"
    }
  },
  "available": {
    "source": {
      "currency": "USD",
      "amount": "1000.00"
    },
    "destination": {
      "currency": "USD",
      "amount": "1000.00"
    }
  },
  "reserved": {
    "source": {
      "currency": "USD",
      "amount": "1000.00"
    },
    "destination": {
      "currency": "USD",
      "amount": "1000.00"
    }
  },
  "used": {
    "source": {
      "currency": "USD",
      "amount": "1000.00"
    },
    "destination": {
      "currency": "USD",
      "amount": "1000.00"
    }
  },
  "expiresAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "externalId": "<string>",
  "referenceRate": "5.43210000",
  "spread": {
    "percentage": "0.75",
    "amount": {
      "currency": "USD",
      "amount": "7.50"
    }
  },
  "pendingSettlement": {
    "currency": "USD",
    "amount": "1000.00"
  },
  "settlementId": "<string>",
  "metadata": {}
}

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

Autorizações

Authorization

string

header

obrigatório

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

Parâmetros de caminho

inventoryId

string

obrigatório

Resposta

Inventory Lot

Inventory Lot: câmbio contratado antecipadamente pela MSB e promessa de pagamento em USDC. Cada aceite de cotação INVENTORY cria um lote independente, com taxa, volume e validade próprios. total = available + reserved + used. A obrigação em USDC existe independentemente de withdrawals e se refere ao volume não utilizado; o evento e a data de apuração e cobrança serão comunicados antes da disponibilidade geral.

inventoryId

string

obrigatório

Exemplo:

"inv_01JA2B"

quoteId

string

obrigatório

Cotação INVENTORY que originou o lote.

status

enum<string>

obrigatório

ACTIVE: dentro da validade, com volume disponível. DEPLETED: sem volume disponível (todo reservado ou utilizado); volta a ACTIVE se uma reserva for liberada dentro da validade. EXPIRED: passou de expiresAt; não aceita novos withdrawals. O tratamento do volume remanescente após a expiração será comunicado antes da disponibilidade geral. Enum extensível.

Opções disponíveis:

ACTIVE,

DEPLETED,

EXPIRED

fromCurrency

enum<string>

obrigatório

Opções disponíveis:

USD

toCurrency

enum<string>

obrigatório

Opções disponíveis:

BRL

rate

string

obrigatório

Taxa contratada entre a MSB e a LB Pay (BRL por USD), já com o spread. Aplicada a todas as remessas do lote.

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

Exemplo:

"5.40000000"

total

object

obrigatório

Volume contratado.

Show child attributes

available

object

obrigatório

Volume disponível para novos withdrawals.

Show child attributes

reserved

object

obrigatório

Volume reservado por withdrawals em andamento.

Show child attributes

used

object

obrigatório

Volume já utilizado por withdrawals.

Show child attributes

expiresAt

string<date-time>

obrigatório

Validade do lote.

createdAt

string<date-time>

obrigatório

updatedAt

string<date-time>

obrigatório

externalId

string | null

referenceRate

string

BRL por USD, até 8 casas decimais.

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

Exemplo:

"5.43210000"

spread

object

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

Show child attributes

pendingSettlement

object | null

Obrigação em USDC referente ao volume não utilizado. null até a apuração, cujo evento será comunicado antes da disponibilidade geral.

Show child attributes

settlementId

string | null

Lote de liquidação da obrigação, quando existir.

metadata

object

Visão geral

Saúde

Cotações

Inventories

Remessas

Remetentes

Beneficiários

Linha de crédito

Limites

Wallets

Liquidações

Webhooks

Autorizações

Parâmetros de caminho

Resposta