Poll the provider's current view of a due-date collection
curl --request GET \
--url https://api.example.com/cob-hub/v1/collections/duedate/provider-status \
--header 'Authorization: Bearer <token>' \
--header 'X-Account-Id: <x-account-id>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/cob-hub/v1/collections/duedate/provider-status"
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))
}const options = {
method: 'GET',
headers: {'X-Account-Id': '<x-account-id>', Authorization: 'Bearer <token>'}
};
fetch('https://api.example.com/cob-hub/v1/collections/duedate/provider-status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.example.com/cob-hub/v1/collections/duedate/provider-status"
headers = {
"X-Account-Id": "<x-account-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text){
"divergent": false,
"local": {
"accountId": "0196a7b2-3e5f-7061-ac12-34567890abcd",
"amount": "150.75",
"calendar": {
"dueDate": "2026-09-01",
"validityAfterDue": 30
},
"createdAt": "2026-08-02T10:30:00Z",
"currency": "BRL",
"debtor": {
"document": "12345678909",
"name": "Maria Souza"
},
"emvPayload": "00020126360014br.gov.bcb.pix2562https://pix.example.com/qr/v2/cobv-abc1235204000053039865802BR5910Loja Exemplo6009Sao Paulo62070503***63041D3F",
"expiresAt": "2026-10-01T00:00:00Z",
"externalId": "0196a7b2-4f60-7172-bd23-4567890abcde",
"id": "0196a7b2-1c3d-7e4f-8a90-1234567890ab",
"isExpired": false,
"keyType": "EMAIL",
"keyValue": "loja@example.com",
"locationUrl": "https://pix.example.com/qr/v2/cobv-abc123",
"merchantCity": "Sao Paulo",
"merchantDocument": "39053344705",
"merchantName": "Loja Exemplo",
"organizationId": "0196a7b2-2d4e-7f50-9b01-234567890abc",
"status": "ACTIVE",
"txId": "TX1234567890123456789012345",
"type": "DUE_DATE",
"updatedAt": "2026-08-02T10:30:00Z"
},
"provider": {
"amount": "150.75",
"calendar": {
"dueDate": "2026-09-01",
"validityAfterDue": 30
},
"createdAt": "2026-08-02T10:30:00Z",
"currency": "BRL",
"debtor": {
"document": "12345678909",
"name": "Maria Souza"
},
"emvPayload": "00020126360014br.gov.bcb.pix2562https://pix.example.com/qr/v2/cobv-abc1235204000053039865802BR5910Loja Exemplo6009Sao Paulo62070503***63041D3F",
"expiresAt": "2026-10-01T00:00:00Z",
"externalId": "0196a7b2-4f60-7172-bd23-4567890abcde",
"locationUrl": "https://pix.example.com/qr/v2/cobv-abc123",
"revision": 0,
"status": "PENDING",
"txId": "TX1234567890123456789012345"
}
}{
"type": "https://errors.lerian.studio/v1/PIX-0200",
"title": "Bad Request",
"status": 400,
"detail": "Missing or malformed required fields.",
"code": "PIX-0200"
}{
"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-0226",
"title": "Conflict",
"status": 409,
"detail": "The collection is in a conflicting state at the provider.",
"code": "PIX-0226"
}{
"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"
}{
"type": "https://errors.lerian.studio/v1/PIX-0223",
"title": "Bad Gateway",
"status": 502,
"detail": "Provider adapter is unreachable.",
"code": "PIX-0223"
}{
"type": "https://errors.lerian.studio/v1/PIX-0054",
"title": "Gateway Timeout",
"status": 504,
"detail": "The request timed out. Please try again later.",
"code": "PIX-0054"
}{
"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"
}
}Poll the provider's current view of a due-date collection
Reads the configured provider’s current view of a due-date collection identified by its BACEN tx_id query parameter, alongside the Hub’s persisted view, and reports whether they diverge. This operation is read-only and does not update the local collection. Authorization may be required when the deployment enables access management.
GET
/
collections
/
duedate
/
provider-status
Poll the provider's current view of a due-date collection
curl --request GET \
--url https://api.example.com/cob-hub/v1/collections/duedate/provider-status \
--header 'Authorization: Bearer <token>' \
--header 'X-Account-Id: <x-account-id>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/cob-hub/v1/collections/duedate/provider-status"
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))
}const options = {
method: 'GET',
headers: {'X-Account-Id': '<x-account-id>', Authorization: 'Bearer <token>'}
};
fetch('https://api.example.com/cob-hub/v1/collections/duedate/provider-status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.example.com/cob-hub/v1/collections/duedate/provider-status"
headers = {
"X-Account-Id": "<x-account-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text){
"divergent": false,
"local": {
"accountId": "0196a7b2-3e5f-7061-ac12-34567890abcd",
"amount": "150.75",
"calendar": {
"dueDate": "2026-09-01",
"validityAfterDue": 30
},
"createdAt": "2026-08-02T10:30:00Z",
"currency": "BRL",
"debtor": {
"document": "12345678909",
"name": "Maria Souza"
},
"emvPayload": "00020126360014br.gov.bcb.pix2562https://pix.example.com/qr/v2/cobv-abc1235204000053039865802BR5910Loja Exemplo6009Sao Paulo62070503***63041D3F",
"expiresAt": "2026-10-01T00:00:00Z",
"externalId": "0196a7b2-4f60-7172-bd23-4567890abcde",
"id": "0196a7b2-1c3d-7e4f-8a90-1234567890ab",
"isExpired": false,
"keyType": "EMAIL",
"keyValue": "loja@example.com",
"locationUrl": "https://pix.example.com/qr/v2/cobv-abc123",
"merchantCity": "Sao Paulo",
"merchantDocument": "39053344705",
"merchantName": "Loja Exemplo",
"organizationId": "0196a7b2-2d4e-7f50-9b01-234567890abc",
"status": "ACTIVE",
"txId": "TX1234567890123456789012345",
"type": "DUE_DATE",
"updatedAt": "2026-08-02T10:30:00Z"
},
"provider": {
"amount": "150.75",
"calendar": {
"dueDate": "2026-09-01",
"validityAfterDue": 30
},
"createdAt": "2026-08-02T10:30:00Z",
"currency": "BRL",
"debtor": {
"document": "12345678909",
"name": "Maria Souza"
},
"emvPayload": "00020126360014br.gov.bcb.pix2562https://pix.example.com/qr/v2/cobv-abc1235204000053039865802BR5910Loja Exemplo6009Sao Paulo62070503***63041D3F",
"expiresAt": "2026-10-01T00:00:00Z",
"externalId": "0196a7b2-4f60-7172-bd23-4567890abcde",
"locationUrl": "https://pix.example.com/qr/v2/cobv-abc123",
"revision": 0,
"status": "PENDING",
"txId": "TX1234567890123456789012345"
}
}{
"type": "https://errors.lerian.studio/v1/PIX-0200",
"title": "Bad Request",
"status": 400,
"detail": "Missing or malformed required fields.",
"code": "PIX-0200"
}{
"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-0226",
"title": "Conflict",
"status": 409,
"detail": "The collection is in a conflicting state at the provider.",
"code": "PIX-0226"
}{
"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"
}{
"type": "https://errors.lerian.studio/v1/PIX-0223",
"title": "Bad Gateway",
"status": 502,
"detail": "Provider adapter is unreachable.",
"code": "PIX-0223"
}{
"type": "https://errors.lerian.studio/v1/PIX-0054",
"title": "Gateway Timeout",
"status": 504,
"detail": "The request timed out. Please try again later.",
"code": "PIX-0054"
}{
"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"
}
}Autorizações
JWT bearer token issued by the identity provider.
Cabeçalhos
Receiver merchant account UUID
Exemplo:
"019606a1-3b4c-7d8e-9f01-234567890abc"
Bearer token; required when Access Manager is enabled
Parâmetros de consulta
BACEN transaction identifier
Required string length:
26 - 35Pattern:
^[a-zA-Z0-9]+$Exemplo:
"T1234567890123456789012345A"
Esta página foi útil?

