Skip to main content
POST
Criar uma cobrança PIX

Cabeçalhos

X-API-Key
string
obrigatório

Chave de API de integração (pd_live_* para produção, pd_test_* para sandbox)

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"

customerId
string<uuid>

ID de um cliente existente. Informe customerId ou customer, não ambos. Se ambos forem omitidos, o endpoint cria um QR Code estático (disponível apenas para contas cujo PSP suporta o caminho estático; caso contrário retorna 400).

customer
object

Informações do cliente. Informe customerId ou customer, não ambos. Se ambos forem omitidos, o endpoint cria um QR Code estático (disponível apenas para contas cujo PSP suporta o caminho estático; caso contrário retorna 400).

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,...)

externalReference
string

Seu ID de referência externa

Exemplo:

"pedido-12345"

customerId
string<uuid>

ID do cliente. Ausente quando criado como QR Code estático (sem pagador).