List immediate collections or retrieve one by txId

cURL with fictitious data

curl --request GET \
  --url https://api.example.com/cob-hub/v1/collections/immediate \
  --header 'Authorization: Bearer demo-access-token' \
  --header 'X-Account-Id: 019606a1-3b4c-7d8e-9f01-234567890abc'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/cob-hub/v1/collections/immediate"

	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/immediate', 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/immediate"

headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

{
  "items": [
    {
      "accountId": "0196a7b2-3e5f-7061-ac12-34567890abcd",
      "additionalInfo": [
        {
          "key": "orderId",
          "value": "12345"
        }
      ],
      "amount": "100.50",
      "createdAt": "2026-05-06T10:30:00Z",
      "currency": "BRL",
      "debtor": {
        "document": "39053344705",
        "name": "João da Silva"
      },
      "description": "Pagamento do pedido 12345",
      "emvPayload": "00020101021226500014br.gov.bcb.pix2528pix.example.com/qr/v2/abc1235204000053039865802BR5910Loja Teste6007Goiania62070503***63041206",
      "expirationSeconds": 3600,
      "expiresAt": "2026-05-06T11:30:00Z",
      "externalId": "0196a7b2-4f60-7172-bd23-4567890abcde",
      "id": "0196a7b2-1c3d-7e4f-8a90-1234567890ab",
      "keyType": "EVP",
      "keyValue": "123e4567-e12b-12d1-a456-426655440000",
      "locationUrl": "https://pix.example.com/qr/v2/abc123",
      "merchantCity": "Goiania",
      "merchantDocument": "39053344705",
      "merchantName": "Loja Teste",
      "organizationId": "0196a7b2-2d4e-7f50-9b01-234567890abc",
      "status": "ACTIVE",
      "txId": "TX1234567890123456789012345",
      "type": "IMMEDIATE",
      "updatedAt": "2026-05-06T10:30:00Z"
    }
  ],
  "limit": 20,
  "page": 1,
  "total": 1
}

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

GET

collections

immediate

cURL with fictitious data

curl --request GET \
  --url https://api.example.com/cob-hub/v1/collections/immediate \
  --header 'Authorization: Bearer demo-access-token' \
  --header 'X-Account-Id: 019606a1-3b4c-7d8e-9f01-234567890abc'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/cob-hub/v1/collections/immediate"

	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/immediate', 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/immediate"

headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

{
  "items": [
    {
      "accountId": "0196a7b2-3e5f-7061-ac12-34567890abcd",
      "additionalInfo": [
        {
          "key": "orderId",
          "value": "12345"
        }
      ],
      "amount": "100.50",
      "createdAt": "2026-05-06T10:30:00Z",
      "currency": "BRL",
      "debtor": {
        "document": "39053344705",
        "name": "João da Silva"
      },
      "description": "Pagamento do pedido 12345",
      "emvPayload": "00020101021226500014br.gov.bcb.pix2528pix.example.com/qr/v2/abc1235204000053039865802BR5910Loja Teste6007Goiania62070503***63041206",
      "expirationSeconds": 3600,
      "expiresAt": "2026-05-06T11:30:00Z",
      "externalId": "0196a7b2-4f60-7172-bd23-4567890abcde",
      "id": "0196a7b2-1c3d-7e4f-8a90-1234567890ab",
      "keyType": "EVP",
      "keyValue": "123e4567-e12b-12d1-a456-426655440000",
      "locationUrl": "https://pix.example.com/qr/v2/abc123",
      "merchantCity": "Goiania",
      "merchantDocument": "39053344705",
      "merchantName": "Loja Teste",
      "organizationId": "0196a7b2-2d4e-7f50-9b01-234567890abc",
      "status": "ACTIVE",
      "txId": "TX1234567890123456789012345",
      "type": "IMMEDIATE",
      "updatedAt": "2026-05-06T10:30:00Z"
    }
  ],
  "limit": 20,
  "page": 1,
  "total": 1
}

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

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)

Response

List envelope in list mode, or a single ImmediateCollectionOutput 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

DICT and Pix keys

Collections and BR Codes

Payments and refunds

Error handling

List immediate collections or retrieve one by txId

Authorizations

Headers

Query Parameters

Response