Pular para o conteúdo principal

Gerar QrCode Cobrança

Este endpoint realiza a geração de um QrCode de pagamento PIX. Para fazê-lo deve ser efetuada a chamada para a API, como especificado abaixo.

Request​

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

URL
{BaseUrl}/api/v1/pix/qrcode
HTTP Request Body
{
    "value": 10000
    "generator_name": "John Doe",
    "generator_document": "12345678910",
    "external_reference": "INVOICE01",
    "expiration_time": 1800,
    "payer_message": "Pagar ate o vencimento",
    "split_link": "47fu7840-wh47-lq93-f4rf-ls43950qte53"
}

Descrição dos Atributos​

ATRIBUTODESCRIÇÃOTIPO
value
(Obrigatório)		Valor, em reais, do qrcode.DOUBLE
maior que 0
generator_name
(Opcional)		Nome do usuário gerador do qrcode. Será utilizado para cadastrar a cobrança.STRING
limite de 100 caracteres
generator_document
(Opcional)		Documento (CPF/CNPJ) do usuário gerador do qrcode. Será utilizado para cadastrar a cobrança. Obrigatório caso seja informado o atributo generator_name.STRING
limite de 14 caracteres Apenas números
external_reference
(Opcional)		Identificador fornecido pelo parceiro para controle interno.STRING
limite de 100 caracteres
expiration_time
(Opcional)		Tempo em segundos de expiração do qrcode. Caso não informado, assume valor 1800 (30 minutos)INTEGER
maior que 0 e menor ou igual a 3600
payer_message
(Opcional)		Mensagem que será exibida para o usuário pagador, após que ele ler o qrcodeSTRING
limite de 100 caracteres
split_link
(Opcional)		Código fornecido pela Pay2m para que o qrcode gerado possua, associado a ele, a configuração de split solicitadaSTRING
36 caracteres, sendo letras e números

Response​

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

HTTP 201 Response Body
{
    "reference_code": "PAY2MPIXQRCODE2",
    "content": "00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-4266554400003549673253039865802BR5913Fulano deTal6008BRASILIA62070503***63041D3D"
}

Descrição dos Atributos​

ATRIBUTODESCRIÇÃOTIPO
reference_code
(Obrigatório)		Identificador único do QrCode.STRING
limite de 100 caracteres
content
(Obrigatório)		NConteúdo do QrCode. (Código copia e cola PIX)STRING
limite de 255 caracteres

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

HTTP 400 Response Body - Exemplo
{
    "error": "generator_document not_a_number | generator_document required | generator_name required"
}
Última atualização em