curl --request GET \
--url https://api.example.com/cob-hub/v1/collections/duedate \
--header 'Authorization: Bearer demo-access-token' \
--header 'X-Account-Id: 019606a1-3b4c-7d8e-9f01-234567890abc'import requests
url = "https://api.example.com/cob-hub/v1/collections/duedate"
headers = {
"X-Account-Id": "<x-account-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Account-Id': '<x-account-id>', Authorization: 'Bearer <token>'}
};
fetch('https://api.example.com/cob-hub/v1/collections/duedate', 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.example.com/cob-hub/v1/collections/duedate",
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>",
"X-Account-Id: <x-account-id>"
],
]);
$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.example.com/cob-hub/v1/collections/duedate"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Account-Id", "<x-account-id>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/cob-hub/v1/collections/duedate")
.header("X-Account-Id", "<x-account-id>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/cob-hub/v1/collections/duedate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Account-Id"] = '<x-account-id>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"items": [
{
"abatement": {
"modality": "PERCENTAGE",
"value": "5.00"
},
"accountId": "019606a1-3b4c-7d8e-9f01-234567890abc",
"additionalInfo": [
{
"key": "orderId",
"value": "12345"
}
],
"amount": "100.50",
"calendar": {
"dueDate": "2030-09-01",
"validityAfterDue": 30
},
"createdAt": "2030-08-20T10:30:00Z",
"currency": "BRL",
"debtor": {
"document": "39053344705",
"name": "João da Silva"
},
"description": "Fatura de servicos",
"discount": {
"modality": "VALUE_PER_CALENDAR_DAY_ADVANCE",
"value": "3.00"
},
"emvPayload": "00020126360014br.gov.bcb.pix2562https://pix.example.com/qr/v2/cobv-abc1235204000053039865802BR5910Loja Teste6007Goiania62070503***63041D3F",
"expiresAt": "2030-10-01T23:59:59Z",
"externalId": "0196a7b2-4f60-7172-bd23-4567890abcde",
"fine": {
"modality": "FIXED_VALUE",
"value": "10.00"
},
"id": "0196a7b2-1c3d-7e4f-8a90-1234567890ab",
"interest": {
"modality": "VALUE_CALENDAR_DAYS",
"value": "1.50"
},
"isExpired": false,
"keyType": "EVP",
"keyValue": "123e4567-e12b-12d1-a456-426655440000",
"locationUrl": "https://pix.example.com/qr/v2/cobv-abc123",
"merchantCity": "Goiania",
"merchantDocument": "39053344705",
"merchantName": "Loja Teste",
"organizationId": "0196a7b2-2d4e-7f50-9b01-234567890abc",
"status": "ACTIVE",
"txId": "TX1234567890123456789012345",
"type": "DUE_DATE",
"updatedAt": "2030-08-20T10:30:00Z"
}
],
"limit": 20,
"page": 1,
"total": 1
}{
"type": "https://errors.lerian.studio/v1/PIX-0206",
"title": "Bad Request",
"status": 400,
"detail": "Invalid filter parameter value.",
"code": "PIX-0206"
}{
"type": "https://errors.lerian.studio/v1/PIX-0240",
"title": "Not Found",
"status": 404,
"detail": "No collection found for the given identifiers.",
"code": "PIX-0240"
}{
"type": "https://errors.lerian.studio/v1/PIX-0000",
"title": "Internal Server Error",
"status": 500,
"detail": "The server encountered an unexpected error. Please try again later.",
"code": "PIX-0000"
}{
"code": "ERR-0001",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}List due-date collections or retrieve one by txId
Returns a page-based list envelope of due-date collections, optionally filtered by a dueDateFrom/dueDateTo range. When a txId query parameter is supplied the endpoint switches to a by-txId lookup and returns a single bare collection entity instead — the two 200 shapes are documented as a oneOf.
curl --request GET \
--url https://api.example.com/cob-hub/v1/collections/duedate \
--header 'Authorization: Bearer demo-access-token' \
--header 'X-Account-Id: 019606a1-3b4c-7d8e-9f01-234567890abc'import requests
url = "https://api.example.com/cob-hub/v1/collections/duedate"
headers = {
"X-Account-Id": "<x-account-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Account-Id': '<x-account-id>', Authorization: 'Bearer <token>'}
};
fetch('https://api.example.com/cob-hub/v1/collections/duedate', 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.example.com/cob-hub/v1/collections/duedate",
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>",
"X-Account-Id: <x-account-id>"
],
]);
$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.example.com/cob-hub/v1/collections/duedate"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Account-Id", "<x-account-id>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/cob-hub/v1/collections/duedate")
.header("X-Account-Id", "<x-account-id>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/cob-hub/v1/collections/duedate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Account-Id"] = '<x-account-id>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"items": [
{
"abatement": {
"modality": "PERCENTAGE",
"value": "5.00"
},
"accountId": "019606a1-3b4c-7d8e-9f01-234567890abc",
"additionalInfo": [
{
"key": "orderId",
"value": "12345"
}
],
"amount": "100.50",
"calendar": {
"dueDate": "2030-09-01",
"validityAfterDue": 30
},
"createdAt": "2030-08-20T10:30:00Z",
"currency": "BRL",
"debtor": {
"document": "39053344705",
"name": "João da Silva"
},
"description": "Fatura de servicos",
"discount": {
"modality": "VALUE_PER_CALENDAR_DAY_ADVANCE",
"value": "3.00"
},
"emvPayload": "00020126360014br.gov.bcb.pix2562https://pix.example.com/qr/v2/cobv-abc1235204000053039865802BR5910Loja Teste6007Goiania62070503***63041D3F",
"expiresAt": "2030-10-01T23:59:59Z",
"externalId": "0196a7b2-4f60-7172-bd23-4567890abcde",
"fine": {
"modality": "FIXED_VALUE",
"value": "10.00"
},
"id": "0196a7b2-1c3d-7e4f-8a90-1234567890ab",
"interest": {
"modality": "VALUE_CALENDAR_DAYS",
"value": "1.50"
},
"isExpired": false,
"keyType": "EVP",
"keyValue": "123e4567-e12b-12d1-a456-426655440000",
"locationUrl": "https://pix.example.com/qr/v2/cobv-abc123",
"merchantCity": "Goiania",
"merchantDocument": "39053344705",
"merchantName": "Loja Teste",
"organizationId": "0196a7b2-2d4e-7f50-9b01-234567890abc",
"status": "ACTIVE",
"txId": "TX1234567890123456789012345",
"type": "DUE_DATE",
"updatedAt": "2030-08-20T10:30:00Z"
}
],
"limit": 20,
"page": 1,
"total": 1
}{
"type": "https://errors.lerian.studio/v1/PIX-0206",
"title": "Bad Request",
"status": 400,
"detail": "Invalid filter parameter value.",
"code": "PIX-0206"
}{
"type": "https://errors.lerian.studio/v1/PIX-0240",
"title": "Not Found",
"status": 404,
"detail": "No collection found for the given identifiers.",
"code": "PIX-0240"
}{
"type": "https://errors.lerian.studio/v1/PIX-0000",
"title": "Internal Server Error",
"status": 500,
"detail": "The server encountered an unexpected error. Please try again later.",
"code": "PIX-0000"
}{
"code": "ERR-0001",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}Authorizations
JWT bearer token issued by the identity provider.
Headers
UUID of the account associated with the operation.
"019606a1-3b4c-7d8e-9f01-234567890abc"
Query Parameters
BCB transaction ID — routes to by-txId lookup
"T1234567890123456789012345A"
Page number (1-based, default 1)
"1"
Rows per page (default 20, max 100)
"20"
Filter by status
"ACTIVE"
Filter by Pix key value (exact match)
Filter: due date range start (YYYY-MM-DD)
"2026-08-01"
Filter: due date range end (YYYY-MM-DD)
"2026-08-31"
Was this page helpful?

