Skip to main content
POST
Criar cobrança PIX
Cria uma cobrança PIX e retorna um QR Code pronto para apresentar ao cliente.

Obrigatório

method (fixo em "PIX") e amount (em centavos, mínimo 100). Os demais campos são opcionais.
Exemplo:

Como apresentar o QR Code

A resposta traz dois formatos — escolha o melhor para seu canal:

brCode (texto)

String copia-e-cola. Ideal para web/mobile com botão “Copiar código”.

imageBase64 (imagem)

PNG em base64 (data:image/png;base64,...). Renderize com <img src={...}>.

Validações importantes

O merchant precisa ter cobranças habilitadas e uma chave PIX ativa cadastrada. Sem isso, a criação retorna 400 BAD_REQUEST.
Sua conta tem minTicket e maxTicket definidos, além do limite fixo de 100 a 100.000.000 centavos. Valores fora do intervalo retornam 400 BAD_REQUEST.
Se o customer não existir (ou pertencer a outro merchant), você recebe 404 NOT_FOUND.
Mínimo 1 minuto, máximo 30 dias. Padrão: 86400 segundos (24h). Atenção: o campo é em segundos, não minutos.
Texto exibido para o cliente no app de pagamento. Não envie dados sensíveis (PII, senhas, tokens).

Authorizations

Authorization
string
header
required

Autentique suas requisições enviando o token no header Authorization: Bearer <token>.

O token pode ser:

Não há distinção de ambiente — toda chave vale para o único ambiente disponível (produção).

Body

application/json
method
enum<string>
required

Método de pagamento — hoje só "PIX" é suportado.

Available options:
PIX
Example:

"PIX"

amount
integer
required

Valor da cobrança em centavos, sujeito ao limite do merchant.

Required range: 100 <= x <= 100000000
Example:

5000

description
string

Texto que aparece para o cliente no momento do pagamento.

Maximum string length: 140
Example:

"Pedido"

customerId
string

Opcional. ID de um cliente já cadastrado para anexar à cobrança.

Maximum string length: 50
Example:

"cust_018f3a2b7c4d7c40a1b2"

expiresIn
integer
default:86400

Tempo de validade do QR Code em segundos (60 a 2.592.000 = 30 dias). Padrão 86400 = 24h.

Required range: 60 <= x <= 2592000
Example:

1800

Response

Cobrança criada — apresente brCode ou imageBase64 ao cliente.

data
object
required
error
null
required
Example:

null

success
enum<boolean>
required
Available options:
true
Example:

true