Get a settlement batch

Lote de liquidação (resumo)

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

import requests

url = "https://api.lbpay.example.com/v1/settlements/{settlementId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

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

	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/settlements/{settlementId}")

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

{
  "settlementId": "<string>",
  "status": "OPEN",
  "dueDate": "2023-12-25",
  "cutoffAt": "2023-11-07T05:31:56Z",
  "itemCount": 1,
  "amount": {
    "currency": "USD",
    "amount": "1000.00"
  },
  "obligationType": "CREDIT_REPAYMENT",
  "direction": "PAYABLE",
  "periodStart": "2023-11-07T05:31:56Z",
  "periodEnd": "2023-11-07T05:31:56Z",
  "closedAt": "2023-11-07T05:31:56Z",
  "principalTotal": {
    "currency": "USD",
    "amount": "1000.00"
  },
  "fundingCostTotal": {
    "currency": "USD",
    "amount": "1000.00"
  },
  "paymentInstructions": {},
  "reference": "<string>",
  "completedAt": "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

settlements

{settlementId}

Lote de liquidação (resumo)

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

import requests

url = "https://api.lbpay.example.com/v1/settlements/{settlementId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

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

	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/settlements/{settlementId}")

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

{
  "settlementId": "<string>",
  "status": "OPEN",
  "dueDate": "2023-12-25",
  "cutoffAt": "2023-11-07T05:31:56Z",
  "itemCount": 1,
  "amount": {
    "currency": "USD",
    "amount": "1000.00"
  },
  "obligationType": "CREDIT_REPAYMENT",
  "direction": "PAYABLE",
  "periodStart": "2023-11-07T05:31:56Z",
  "periodEnd": "2023-11-07T05:31:56Z",
  "closedAt": "2023-11-07T05:31:56Z",
  "principalTotal": {
    "currency": "USD",
    "amount": "1000.00"
  },
  "fundingCostTotal": {
    "currency": "USD",
    "amount": "1000.00"
  },
  "paymentInstructions": {},
  "reference": "<string>",
  "completedAt": "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

settlementId

string

required

Response

Settlement details

Lote diário de liquidação do crédito (CREDIT). Existe um lote por data de vencimento: reúne todas as remessas antecipadas cuja obrigação vence nessa data, inclusive as criadas em fins de semana. "Quanto pago hoje" = GET /v1/settlements?dueDate=. Ciclo: OPEN (acumulando; valor muda) → CLOSED (corte atingido; valor final) → DUE (vence hoje) → COMPLETED ou OVERDUE. v1 sem compensação: remessas antecipadas que terminam RETURNED ou FUNDS_HELD_BRL continuam no lote; o BRL correspondente fica na BRL Wallet. A contraparte é a LB Pay. Itens em GET /v1/settlements/{settlementId}/items.

settlementId

string

required

status

enum<string>

required

OPEN: acumulando. CLOSED: valor final, aguardando vencimento. DUE: vence hoje. OVERDUE: vencido sem pagamento. COMPLETED: pago e conciliado.

Available options:

OPEN,

CLOSED,

DUE,

OVERDUE,

COMPLETED

dueDate

string<date>

required

Data de vencimento; única por lote.

cutoffAt

string<date-time>

required

Horário de corte do lote. Remessas criadas depois entram no lote seguinte.

itemCount

integer

required

Required range: x >= 0

amount

object

required

Valor a pagar = principalTotal + fundingCostTotal. Muda enquanto OPEN; final a partir de CLOSED.

Show child attributes

obligationType

enum<string>

Enum extensível.

Available options:

CREDIT_REPAYMENT

direction

enum<string>

v1: apenas PAYABLE (a MSB paga). Enum extensível.

Available options:

PAYABLE

periodStart

string<date-time>

Criação de remessa mais antiga incluída no lote.

periodEnd

string<date-time> | null

Criação de remessa mais recente incluída; final após o fechamento.

closedAt

string<date-time> | null

principalTotal

object

Soma dos valores antecipados.

Show child attributes

fundingCostTotal

object

Soma dos custos de antecipação.

Show child attributes

paymentInstructions

object | null

Dados para pagamento da obrigação, quando a MSB deve efetuá-lo.

reference

string | null

completedAt

string<date-time> | null

Overview

Health

FX Quotes

Inventories

Remittances

Senders

Beneficiaries

Credit line

Limits

Wallets

Settlements

Webhooks

Authorizations

Path Parameters

Response