Skip to main content
POST
Criar uma cobrança PIX

Autorizações

Authorization
string
header
obrigatório

Access token obtido no POST /auth (client_id + client_secret). Válido por 300 segundos.

Cabeçalhos

Idempotency-Key
string

Chave única do cliente (8-255 chars) que torna a requisição idempotente. Retentativas com a mesma chave retornam a resposta cacheada (TTL 24h). Mesma chave com body diferente retorna 422.

Required string length: 8 - 255

Corpo

application/json
amount
number
obrigatório

Valor em BRL (ex: 100.50 para R$ 100,50)

Intervalo obrigatório: x >= 1
Exemplo:

150.75

description
string
obrigatório

Descrição da cobrança

Maximum string length: 255
Exemplo:

"Pagamento do pedido #12345"

customer
object

Dados do pagador (todos opcionais).

projectId
string<uuid>

ID do projeto para associar a transação

expiresIn
integer

Segundos até expiração (padrão: 86400 = 24h)

Intervalo obrigatório: 300 <= x <= 604800
Exemplo:

3600

externalReference
string

Seu ID de referência externa

Maximum string length: 255
Exemplo:

"pedido-12345"

metadata
object

Metadados customizados (pares chave-valor)

Exemplo:

Resposta

Cobrança PIX criada com sucesso

id
string<uuid>
obrigatório

ID da cobrança (ID da transação)

status
enum<string>
obrigatório

Status da cobrança

Opções disponíveis:
pending,
completed,
failed,
cancelled
amount
number
obrigatório

Valor em BRL

Exemplo:

150.75

currency
string
obrigatório

Código da moeda

Exemplo:

"BRL"

pixCopyPaste
string
obrigatório

Código PIX copia e cola

Exemplo:

"00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890"

expiresAt
string<date-time>
obrigatório

Data de expiração

createdAt
string<date-time>
obrigatório

Data de criação

qrCodeBase64
string

QR Code do PIX em formato data URI (data:image/png;base64,...)

pspPaymentId
string

ID da transação no provedor de pagamento (PSP). Use para conciliação; ausente se o PSP não retornou o ID na criação.

Exemplo:

"de3516a2-c63a-4c02-b132-a239bf42e183"

externalReference
string

Seu ID de referência externa

Exemplo:

"pedido-12345"