API Reference
Log In

Gera cobrança Pix

Este endpoint tem como objetivo gerar cobrança Pix

❗️

A validade padrão para os QR codes gerados é de 24 horas. No entanto, há opção de personalizar esse prazo de validade, escolhendo qualquer valor entre 5 minutos (300s) e 24 horas(86400s). Esse valor deverá ser enviado em segundos para garantir a configuração correta.

❗️

O order é um parâmetro opcional, que reflete o número associado a encomenda/venda no comprovante de pagamento do PIX, onde é exibido no campo Informações Adicionais.

Respostas das requisições​

Para esta consulta será retornada uma lista dos seguintes dados:

VariávelTipoDescrição
tradeNameStringNome fantasia do estabelecimento
legalDocumentStringDocumento do estabelecimento
streetStringRua do endereço cadastrado no estabelecimento
numberStringNúmero do endereço cadastrado no estabelecimento
cityStringCidade do endereço cadastrado no estabelecimento
stateStringEstado do endereço cadastrado no estabelecimento
districtStringBairro do endereço cadastrado no estabelecimento
dateTimeStringData e hora que a cobrança foi gerada
codeCopyPasteStringCódigo de Copia e Cola do Pix gerado
JustaPIXBase64StringImagem do QRcode a ser renderizada em tela, recebida via Base64
txIdStringIdentificador da cobrança
valueBigIntegerValor total da cobrança EM CENTAVOS. Ex: 500 equivale à R$5,00
qrCodeUrlStringURL de acesso ao Código QR do Pix gerado
Language
Click Try It! to start a request and see the response here!