Pular para o conteúdo principal
POST
Gerar QR Code PIX

Autorizações

x-api-key
string
header
obrigatório

API Key da organização

Corpo

application/json
idempotency
string
obrigatório

Identificador único da cobrança por organização. Garante que a mesma cobrança não seja criada duas vezes.

Minimum string length: 1
value
number
obrigatório

Valor da cobrança em reais (ex.: 49.90). Deve ser positivo e respeitar os limites configurados.

Intervalo obrigatório: 1 <= x <= 30000
customer
object
obrigatório

Dados do cliente pagador. fullName e document (CPF/CNPJ) são obrigatórios; email e phone são opcionais.

description
string
padrão:""

Descrição opcional exibida ao cliente na cobrança.

expiration
integer
padrão:3600

Tempo de validade do QR Code em segundos. Mínimo 300 (5 min), máximo 86400 (24h). Padrão: 3600 (1h).

Intervalo obrigatório: 300 <= x <= 86400

Resposta

Requisição processada com sucesso

Requisição processada com sucesso

response
object
obrigatório

Dados retornados pela operação; null quando não há conteúdo.

message
string
obrigatório

Mensagem que descreve o resultado.