Create an immediate Pix collection (cob)

curl --request POST \
  --url https://api.example.com/cob-hub/v1/collections/immediate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "amount": "<string>",
  "expirationSeconds": 3600,
  "keyType": "EVP",
  "keyValue": "123e4567-e12b-12d1-a456-426655440000",
  "merchantCity": "Goiania",
  "merchantName": "Loja Teste",
  "txId": "TX1234567890123456789012345",
  "additionalInfo": [
    {
      "key": "orderId",
      "value": "12345"
    }
  ],
  "currency": "BRL",
  "debtor": {
    "document": "39053344705",
    "name": "João da Silva"
  },
  "description": "Pagamento do pedido 12345"
}
'

package main

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

func main() {

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

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

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	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))

}

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

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"

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

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

print(response.text)

{
  "accountId": "0196a7b2-3e5f-7061-ac12-34567890abcd",
  "amount": "100.50",
  "createdAt": "2026-05-06T10:30:00Z",
  "currency": "BRL",
  "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",
  "additionalInfo": [
    {
      "key": "orderId",
      "value": "12345"
    }
  ],
  "cancelledAt": "2026-05-06T10:40:00Z",
  "cancelledReason": "Customer requested cancellation",
  "debtor": {
    "document": "39053344705",
    "name": "João da Silva"
  },
  "description": "Pagamento do pedido 12345",
  "payment": {
    "amount": "100.50",
    "endToEndId": "E12345678202605061030abcdef12345",
    "paidAt": "2026-05-06T10:35:00Z",
    "payer": {
      "ispb": "12345678",
      "name": "João da Silva",
      "taxId": "39053344705"
    }
  }
}

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

{
  "type": "https://errors.lerian.studio/v1/PIX-0225",
  "title": "Not Found",
  "status": 404,
  "detail": "The requested collection resource was not found at the provider.",
  "code": "PIX-0225"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0012",
  "title": "Conflict",
  "status": 409,
  "detail": "The entity already exists or conflicts with an existing resource.",
  "code": "PIX-0012"
}

{
  "code": "PIX-0031",
  "title": "Idempotency Key Conflict",
  "message": "The X-Idempotency header is held by a request still running or whose receipt could not be stored, or was already used with a different request."
}

{
  "code": "PIX-0016",
  "title": "Unsupported Media Type",
  "message": "The request body must be sent with Content-Type: application/json."
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0201",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Pix key does not exist or is not active.",
  "code": "PIX-0201"
}

{
  "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": "<string>",
  "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

Create an immediate Pix collection (cob)

curl --request POST \
  --url https://api.example.com/cob-hub/v1/collections/immediate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "amount": "<string>",
  "expirationSeconds": 3600,
  "keyType": "EVP",
  "keyValue": "123e4567-e12b-12d1-a456-426655440000",
  "merchantCity": "Goiania",
  "merchantName": "Loja Teste",
  "txId": "TX1234567890123456789012345",
  "additionalInfo": [
    {
      "key": "orderId",
      "value": "12345"
    }
  ],
  "currency": "BRL",
  "debtor": {
    "document": "39053344705",
    "name": "João da Silva"
  },
  "description": "Pagamento do pedido 12345"
}
'

package main

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

func main() {

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

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

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	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))

}

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

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"

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

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

print(response.text)

{
  "accountId": "0196a7b2-3e5f-7061-ac12-34567890abcd",
  "amount": "100.50",
  "createdAt": "2026-05-06T10:30:00Z",
  "currency": "BRL",
  "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",
  "additionalInfo": [
    {
      "key": "orderId",
      "value": "12345"
    }
  ],
  "cancelledAt": "2026-05-06T10:40:00Z",
  "cancelledReason": "Customer requested cancellation",
  "debtor": {
    "document": "39053344705",
    "name": "João da Silva"
  },
  "description": "Pagamento do pedido 12345",
  "payment": {
    "amount": "100.50",
    "endToEndId": "E12345678202605061030abcdef12345",
    "paidAt": "2026-05-06T10:35:00Z",
    "payer": {
      "ispb": "12345678",
      "name": "João da Silva",
      "taxId": "39053344705"
    }
  }
}

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

{
  "type": "https://errors.lerian.studio/v1/PIX-0225",
  "title": "Not Found",
  "status": 404,
  "detail": "The requested collection resource was not found at the provider.",
  "code": "PIX-0225"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0012",
  "title": "Conflict",
  "status": 409,
  "detail": "The entity already exists or conflicts with an existing resource.",
  "code": "PIX-0012"
}

{
  "code": "PIX-0031",
  "title": "Idempotency Key Conflict",
  "message": "The X-Idempotency header is held by a request still running or whose receipt could not be stored, or was already used with a different request."
}

{
  "code": "PIX-0016",
  "title": "Unsupported Media Type",
  "message": "The request body must be sent with Content-Type: application/json."
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0201",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Pix key does not exist or is not active.",
  "code": "PIX-0201"
}

{
  "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": "<string>",
  "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

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency

string

obrigatório

REQUIRED. Client-supplied replay key, at most 64 bytes. A request without it is refused with PIX-0030 @ 400 before the handler runs. Resending under the same key and X-Account-Id within 1 hour returns the original response, with its original 201 and X-Idempotency-Replayed: true, even when the body differs from the first request under this key -- the key alone decides replay for collection creation. To create a different collection, use a new X-Idempotency key and a new txId.

Required string length: 1 - 64

X-Account-Id

string

obrigatório

Receiver merchant account UUID (scopes DICT key validation)

Exemplo:

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

Corpo

application/json

amount

string

obrigatório

Collection amount in BRL

expirationSeconds

integer<int64>

obrigatório

Seconds until the collection expires

Exemplo:

3600

keyType

string

obrigatório

Pix key type

Exemplo:

"EVP"

keyValue

string

obrigatório

Pix key value

Exemplo:

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

merchantCity

string

obrigatório

Merchant city

Exemplo:

"Goiania"

merchantName

string

obrigatório

Merchant name

Exemplo:

"Loja Teste"

txId

string

obrigatório

BACEN transaction identifier

Exemplo:

"TX1234567890123456789012345"

additionalInfo

object[] | null

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

Show child attributes

currency

string

Currency (BRL only)

Exemplo:

"BRL"

debtor

object

Optional debtor block

Show child attributes

description

string

Free-form description

Exemplo:

"Pagamento do pedido 12345"

Resposta

Created

accountId

string

obrigatório

Exemplo:

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

amount

string

obrigatório

Exemplo:

"100.50"

createdAt

string<date-time>

obrigatório

Exemplo:

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

currency

enum<string>

obrigatório

Opções disponíveis:

BRL

Exemplo:

"BRL"

emvPayload

string

obrigatório

Exemplo:

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

expirationSeconds

integer<int64>

obrigatório

Exemplo:

3600

expiresAt

string<date-time>

obrigatório

Exemplo:

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

externalId

string

obrigatório

Exemplo:

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

string

obrigatório

Exemplo:

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

keyType

enum<string>

obrigatório

Opções disponíveis:

CPF,

CNPJ,

PHONE,

EMAIL,

EVP

Exemplo:

"EVP"

keyValue

string

obrigatório

Exemplo:

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

locationUrl

string

obrigatório

Exemplo:

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

merchantCity

string

obrigatório

Exemplo:

"Goiania"

merchantDocument

string

obrigatório

Exemplo:

"39053344705"

merchantName

string

obrigatório

Exemplo:

"Loja Teste"

organizationId

string

obrigatório

Exemplo:

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

status

enum<string>

obrigatório

Opções disponíveis:

ACTIVE,

COMPLETED,

CANCELLED

Exemplo:

"ACTIVE"

txId

string

obrigatório

Exemplo:

"TX1234567890123456789012345"

type

enum<string>

obrigatório

Opções disponíveis:

IMMEDIATE,

DUE_DATE

Exemplo:

"IMMEDIATE"

updatedAt

string<date-time>

obrigatório

Exemplo:

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

additionalInfo

object[] | null

Show child attributes

cancelledAt

string<date-time>

Exemplo:

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

cancelledReason

string

Exemplo:

"Customer requested cancellation"

debtor

object

Show child attributes

description

string

Exemplo:

"Pagamento do pedido 12345"

payment

object

Show child attributes

DICT e chaves Pix

Cobranças e BR Codes

Pagamentos e devoluções

API de Pix Automático

Tratamento de erros

Create an immediate Pix collection (cob)

Autorizações

Cabeçalhos

Corpo

Resposta