API Reference
Log In
API Reference

Gera cobrança Pix

Este endpoint tem como objetivo gerar cobrança Pix

Log in to see full request history

❗️

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
Path Params
string
required
Defaults to 123456789101

Documento cadastrado na criação do estabelecimento, informado pelo técnico responsável pela integração. Apenas dígitos

Body Params
int32
required
Defaults to 500

Valor total da cobrança. Enviar o valor EM CENTAVOS. Ex: 500 equivale à R$5,00

string

Número de identificação do pedido de pagamento Obs.: A ser gerado e enviado pelo integrador para mapeamento interno

int64
Defaults to 86400

Valor em segundos em que o PIX irá expirar. Mínimo 300 - Máximo 86400

Headers
string
required
Defaults to Bearer {access_token}

Autenticação do tipo Bearer a ser enviada. O atributo {access_token} é gerado na requisição para o servidor de autenticação da Justa, como já explicitado na seção de autenticação deste documento

string
required
Defaults to {integratorId}

ID de integrador utilizado para a criação do estabelecimento, informado pelo técnico responsável pela integração

Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json