Gerar QRCode Estático

Este endpoint realiza a geração de um QRCode estático de pagamento Pix. Para fazê-lo deve ser efetuada a chamada para a API, como especificado abaixo:

Fazendo Requisição

A chamada deverá ser feita utilizando o método POST.

URL

  /v1/pix/qrcodes/static

HTTP Request Body

{
    "external_reference": "Teste2"
}

Descrição dos atributos

ATRIBUTOS	DESCRIÇÃO	TIPO
external_reference (Opcional)	Valor informado pelo parceiro como identificação do qrcode gerado.	STRING limite de 255 caracteres

Sucesso

Após a chamada, é retornado um JSON com o status 201 - Created caso o procedimento tenha ocorrido com sucesso.

HTTP 201 Response Body - Exemplo

{
    "qrcode": {
        "reference_code": "ZENDRYTESTPIXQRCODE6",
        "external_reference": "Teste2",
        "content": "00000000000000000000br.gov.bcb.pix012345678900-1234-1234-1234-12345678901234567890123456789000.012345BR5925Zendry Solucoes em Paga6009SAO PAULO62230519ZENDRYPIXQRCODETESTE00000"
    }
}

Descrição dos Atributos

PARÂMETRO	DESCRIÇÃO	TIPO
qrcode (Obrigatório)	Objeto de dados do qrcode cadastrado.	OBJECT
qrcode.external_reference (Opcional)	Valor informado pelo parceiro como identificação do qrcode gerado.	STRING limite de 255 caracteres
qrcode.reference_code (Obrigatório)	Identificador único do QRCode.	STRING limite de 100 caracteres
qrcode.content (Obrigatório)	Conteúdo do QRCode. (Código copia e cola Pix)	STRING limite de 255 caracteres padrão: 30

Erros

Em caso de erros, será retornado um json com o atributo error especificando o motivo de a operação ter sido invalidada.

HTTP 400 Response Body - Exemplo

  {
    "error": "generator_document not_a_number | generator_document required | generator_name required"
  }

HTTP 403 Response Body - Exemplo

  {
    "error": "Generator not allowed"
  }

HTTP 500 Response Body - Exemplo

  {
    "error": "Operation failed! Please try again or contact our support team"
  }