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.

GET /collections/duedate

cURL with fictitious data

cURL

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'

200

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

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Headers

X-Account-Id · string · required

UUID of the account associated with the operation.

Example:

"019606a1-3b4c-7d8e-9f01-234567890abc"

Query Parameters

txId · string

BCB transaction ID — routes to by-txId lookup

Example:

"T1234567890123456789012345A"

page · string

Page number (1-based, default 1)

Example:

"1"

limit · string

Rows per page (default 20, max 100)

Example:

"20"

status · string

Filter by status

Example:

"ACTIVE"

keyValue · string

Filter by Pix key value (exact match)

dueDateFrom · string

Filter: due date range start (YYYY-MM-DD)

Example:

"2026-08-01"

dueDateTo · string

Filter: due date range end (YYYY-MM-DD)

Example:

"2026-08-31"

Response

200

application/json

List envelope in list mode, or a single DueDateCollectionOutput when txId is supplied.

Option 1

Option 2

items · object[] | null · required

Show child attributes

limit · integer<int64> · required

Example:

20

page · integer<int64> · required

Example:

1

total · integer<int64> · required

Example:

1