Create an immediate Pix collection (cob)

cURL with fictitious data

curl --request POST \
  --url https://api.example.com/cob-hub/v1/collections/immediate \
  --header 'Authorization: Bearer demo-access-token' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: pix-demo-20260903-000001' \
  --header 'X-Account-Id: 019606a1-3b4c-7d8e-9f01-234567890abc' \
  --data '{
  "additionalInfo": [
    {
      "key": "orderId",
      "value": "12345"
    }
  ],
  "amount": "100.50",
  "currency": "BRL",
  "debtor": {
    "document": "39053344705",
    "name": "João da Silva"
  },
  "description": "Pagamento do pedido 12345",
  "expirationSeconds": 3600,
  "keyType": "EVP",
  "keyValue": "123e4567-e12b-12d1-a456-426655440000",
  "merchantCity": "Goiania",
  "merchantName": "Loja Teste",
  "txId": "TX1234567890123456789012345"
}'

import requests

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

payload = {
    "additionalInfo": [
        {
            "key": "orderId",
            "value": "12345"
        }
    ],
    "amount": "100.50",
    "currency": "BRL",
    "debtor": {
        "document": "39053344705",
        "name": "João da Silva"
    },
    "description": "Pagamento do pedido 12345",
    "expirationSeconds": 3600,
    "keyType": "EVP",
    "keyValue": "123e4567-e12b-12d1-a456-426655440000",
    "merchantCity": "Goiania",
    "merchantName": "Loja Teste",
    "txId": "TX1234567890123456789012345"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    additionalInfo: [{key: 'orderId', value: '12345'}],
    amount: '100.50',
    currency: 'BRL',
    debtor: {document: '39053344705', name: 'João da Silva'},
    description: 'Pagamento do pedido 12345',
    expirationSeconds: 3600,
    keyType: 'EVP',
    keyValue: '123e4567-e12b-12d1-a456-426655440000',
    merchantCity: 'Goiania',
    merchantName: 'Loja Teste',
    txId: 'TX1234567890123456789012345'
  })
};

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));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/cob-hub/v1/collections/immediate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'additionalInfo' => [
        [
                'key' => 'orderId',
                'value' => '12345'
        ]
    ],
    'amount' => '100.50',
    'currency' => 'BRL',
    'debtor' => [
        'document' => '39053344705',
        'name' => 'João da Silva'
    ],
    'description' => 'Pagamento do pedido 12345',
    'expirationSeconds' => 3600,
    'keyType' => 'EVP',
    'keyValue' => '123e4567-e12b-12d1-a456-426655440000',
    'merchantCity' => 'Goiania',
    'merchantName' => 'Loja Teste',
    'txId' => 'TX1234567890123456789012345'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"additionalInfo\": [\n    {\n      \"key\": \"orderId\",\n      \"value\": \"12345\"\n    }\n  ],\n  \"amount\": \"100.50\",\n  \"currency\": \"BRL\",\n  \"debtor\": {\n    \"document\": \"39053344705\",\n    \"name\": \"João da Silva\"\n  },\n  \"description\": \"Pagamento do pedido 12345\",\n  \"expirationSeconds\": 3600,\n  \"keyType\": \"EVP\",\n  \"keyValue\": \"123e4567-e12b-12d1-a456-426655440000\",\n  \"merchantCity\": \"Goiania\",\n  \"merchantName\": \"Loja Teste\",\n  \"txId\": \"TX1234567890123456789012345\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("X-Account-Id", "<x-account-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/cob-hub/v1/collections/immediate")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("X-Account-Id", "<x-account-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"additionalInfo\": [\n    {\n      \"key\": \"orderId\",\n      \"value\": \"12345\"\n    }\n  ],\n  \"amount\": \"100.50\",\n  \"currency\": \"BRL\",\n  \"debtor\": {\n    \"document\": \"39053344705\",\n    \"name\": \"João da Silva\"\n  },\n  \"description\": \"Pagamento do pedido 12345\",\n  \"expirationSeconds\": 3600,\n  \"keyType\": \"EVP\",\n  \"keyValue\": \"123e4567-e12b-12d1-a456-426655440000\",\n  \"merchantCity\": \"Goiania\",\n  \"merchantName\": \"Loja Teste\",\n  \"txId\": \"TX1234567890123456789012345\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["X-Account-Id"] = '<x-account-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"additionalInfo\": [\n    {\n      \"key\": \"orderId\",\n      \"value\": \"12345\"\n    }\n  ],\n  \"amount\": \"100.50\",\n  \"currency\": \"BRL\",\n  \"debtor\": {\n    \"document\": \"39053344705\",\n    \"name\": \"João da Silva\"\n  },\n  \"description\": \"Pagamento do pedido 12345\",\n  \"expirationSeconds\": 3600,\n  \"keyType\": \"EVP\",\n  \"keyValue\": \"123e4567-e12b-12d1-a456-426655440000\",\n  \"merchantCity\": \"Goiania\",\n  \"merchantName\": \"Loja Teste\",\n  \"txId\": \"TX1234567890123456789012345\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "code": "PIX-0030",
  "title": "Idempotency Key Required",
  "message": "The Idempotency-Key header is required for this operation and must be within the accepted length."
}

{
  "code": "PIX-0031",
  "title": "Idempotency Key Conflict",
  "message": "The Idempotency-Key was already used with a different request."
}

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

POST

collections

immediate

cURL with fictitious data

curl --request POST \
  --url https://api.example.com/cob-hub/v1/collections/immediate \
  --header 'Authorization: Bearer demo-access-token' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: pix-demo-20260903-000001' \
  --header 'X-Account-Id: 019606a1-3b4c-7d8e-9f01-234567890abc' \
  --data '{
  "additionalInfo": [
    {
      "key": "orderId",
      "value": "12345"
    }
  ],
  "amount": "100.50",
  "currency": "BRL",
  "debtor": {
    "document": "39053344705",
    "name": "João da Silva"
  },
  "description": "Pagamento do pedido 12345",
  "expirationSeconds": 3600,
  "keyType": "EVP",
  "keyValue": "123e4567-e12b-12d1-a456-426655440000",
  "merchantCity": "Goiania",
  "merchantName": "Loja Teste",
  "txId": "TX1234567890123456789012345"
}'

import requests

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

payload = {
    "additionalInfo": [
        {
            "key": "orderId",
            "value": "12345"
        }
    ],
    "amount": "100.50",
    "currency": "BRL",
    "debtor": {
        "document": "39053344705",
        "name": "João da Silva"
    },
    "description": "Pagamento do pedido 12345",
    "expirationSeconds": 3600,
    "keyType": "EVP",
    "keyValue": "123e4567-e12b-12d1-a456-426655440000",
    "merchantCity": "Goiania",
    "merchantName": "Loja Teste",
    "txId": "TX1234567890123456789012345"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    additionalInfo: [{key: 'orderId', value: '12345'}],
    amount: '100.50',
    currency: 'BRL',
    debtor: {document: '39053344705', name: 'João da Silva'},
    description: 'Pagamento do pedido 12345',
    expirationSeconds: 3600,
    keyType: 'EVP',
    keyValue: '123e4567-e12b-12d1-a456-426655440000',
    merchantCity: 'Goiania',
    merchantName: 'Loja Teste',
    txId: 'TX1234567890123456789012345'
  })
};

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));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/cob-hub/v1/collections/immediate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'additionalInfo' => [
        [
                'key' => 'orderId',
                'value' => '12345'
        ]
    ],
    'amount' => '100.50',
    'currency' => 'BRL',
    'debtor' => [
        'document' => '39053344705',
        'name' => 'João da Silva'
    ],
    'description' => 'Pagamento do pedido 12345',
    'expirationSeconds' => 3600,
    'keyType' => 'EVP',
    'keyValue' => '123e4567-e12b-12d1-a456-426655440000',
    'merchantCity' => 'Goiania',
    'merchantName' => 'Loja Teste',
    'txId' => 'TX1234567890123456789012345'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"additionalInfo\": [\n    {\n      \"key\": \"orderId\",\n      \"value\": \"12345\"\n    }\n  ],\n  \"amount\": \"100.50\",\n  \"currency\": \"BRL\",\n  \"debtor\": {\n    \"document\": \"39053344705\",\n    \"name\": \"João da Silva\"\n  },\n  \"description\": \"Pagamento do pedido 12345\",\n  \"expirationSeconds\": 3600,\n  \"keyType\": \"EVP\",\n  \"keyValue\": \"123e4567-e12b-12d1-a456-426655440000\",\n  \"merchantCity\": \"Goiania\",\n  \"merchantName\": \"Loja Teste\",\n  \"txId\": \"TX1234567890123456789012345\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("X-Account-Id", "<x-account-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/cob-hub/v1/collections/immediate")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("X-Account-Id", "<x-account-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"additionalInfo\": [\n    {\n      \"key\": \"orderId\",\n      \"value\": \"12345\"\n    }\n  ],\n  \"amount\": \"100.50\",\n  \"currency\": \"BRL\",\n  \"debtor\": {\n    \"document\": \"39053344705\",\n    \"name\": \"João da Silva\"\n  },\n  \"description\": \"Pagamento do pedido 12345\",\n  \"expirationSeconds\": 3600,\n  \"keyType\": \"EVP\",\n  \"keyValue\": \"123e4567-e12b-12d1-a456-426655440000\",\n  \"merchantCity\": \"Goiania\",\n  \"merchantName\": \"Loja Teste\",\n  \"txId\": \"TX1234567890123456789012345\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["X-Account-Id"] = '<x-account-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"additionalInfo\": [\n    {\n      \"key\": \"orderId\",\n      \"value\": \"12345\"\n    }\n  ],\n  \"amount\": \"100.50\",\n  \"currency\": \"BRL\",\n  \"debtor\": {\n    \"document\": \"39053344705\",\n    \"name\": \"João da Silva\"\n  },\n  \"description\": \"Pagamento do pedido 12345\",\n  \"expirationSeconds\": 3600,\n  \"keyType\": \"EVP\",\n  \"keyValue\": \"123e4567-e12b-12d1-a456-426655440000\",\n  \"merchantCity\": \"Goiania\",\n  \"merchantName\": \"Loja Teste\",\n  \"txId\": \"TX1234567890123456789012345\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "code": "PIX-0030",
  "title": "Idempotency Key Required",
  "message": "The Idempotency-Key header is required for this operation and must be within the accepted length."
}

{
  "code": "PIX-0031",
  "title": "Idempotency Key Conflict",
  "message": "The Idempotency-Key was already used with a different request."
}

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

Idempotency-Key

string

required

Client-generated key used to retry exactly the same request safely.

Required string length: 1 - 64

X-Account-Id

string

required

UUID of the account associated with the operation.

Example:

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

Body

application/json

amount

string

required

Collection amount in BRL

expirationSeconds

integer<int64>

required

Seconds until the collection expires

Example:

3600

keyType

string

required

Pix key type

Example:

"EVP"

keyValue

string

required

Pix key value

Example:

"123e4567-e12b-12d1-a456-426655440000"

merchantCity

string

required

Merchant city

Example:

"Goiania"

merchantName

string

required

Merchant name

Example:

"Loja Teste"

txId

string

required

BCB transaction identifier

Example:

"TX1234567890123456789012345"

additionalInfo

object[] | null

Free-form key/value metadata (max 50 entries)

Show child attributes

currency

string

Currency (BRL only)

Example:

"BRL"

debtor

object

Optional debtor block

Show child attributes

description

string

Free-form description

Example:

"Pagamento do pedido 12345"

Response

Created

accountId

string

required

Example:

"0196a7b2-3e5f-7061-ac12-34567890abcd"

amount

string

required

Example:

"100.50"

createdAt

string<date-time>

required

Example:

"2026-05-06T10:30:00Z"

currency

enum<string>

required

Available options:

BRL

Example:

"BRL"

emvPayload

string

required

Example:

"00020101021226500014br.gov.bcb.pix2528pix.example.com/qr/v2/abc1235204000053039865802BR5910Loja Teste6007Goiania62070503***63041206"

expirationSeconds

integer<int64>

required

Example:

3600

expiresAt

string<date-time>

required

Example:

"2026-05-06T11:30:00Z"

externalId

string

required

Example:

"0196a7b2-4f60-7172-bd23-4567890abcde"

string

required

Example:

"0196a7b2-1c3d-7e4f-8a90-1234567890ab"

keyType

enum<string>

required

Available options:

CPF,

CNPJ,

PHONE,

EMAIL,

EVP

Example:

"EVP"

keyValue

string

required

Example:

"123e4567-e12b-12d1-a456-426655440000"

locationUrl

string

required

Example:

"https://pix.example.com/qr/v2/abc123"

merchantCity

string

required

Example:

"Goiania"

merchantDocument

string

required

Example:

"39053344705"

merchantName

string

required

Example:

"Loja Teste"

organizationId

string

required

Example:

"0196a7b2-2d4e-7f50-9b01-234567890abc"

status

enum<string>

required

Available options:

ACTIVE,

COMPLETED,

CANCELLED

Example:

"ACTIVE"

txId

string

required

Example:

"TX1234567890123456789012345"

type

enum<string>

required

Available options:

IMMEDIATE,

DUE_DATE

Example:

"IMMEDIATE"

updatedAt

string<date-time>

required

Example:

"2026-05-06T10:30:00Z"

additionalInfo

object[] | null

Show child attributes

cancelledAt

string<date-time>

Example:

"2026-05-06T10:40:00Z"

cancelledReason

string

Example:

"Customer requested cancellation"

debtor

object

Show child attributes

description

string

Example:

"Pagamento do pedido 12345"

payment

object

Show child attributes

Pix — Lerian SPI (native messaging)

Pix Lerian

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado — Dataprev

Create an immediate Pix collection (cob)

Authorizations

Headers

Body

Response