Skip to main content

QR Code Dinâmico

Criação de QR Code Dinâmico

O QR Code dinâmico para pagamento imediato é projetado para facilitar transações de valores específicos em um momento próximo à sua criação. Ele contém informações detalhadas sobre o recebedor da transação e permite a inclusão de dados sobre o pagador, facilitando a identificação posterior de quem efetuou o pagamento.

Adicionalmente, esse tipo de QR Code oferece a flexibilidade para o emissor definir um valor fixo para a transação ou permitir que o pagador ajuste a quantia a ser paga no momento da operação.

Observações

  1. Para utilizar este endpoint, é indispensável que a chave de endereçamento Pix seja válida. Caso contrário, a emissão não poderá ser realizada.

  2. Caso a chave de endereçamento vinculada ao QR Code seja excluída após a sua criação, o QR Code se tornará inválido para realizar pagamentos.

Requisição

POST /baas/api/v1/sellers/:sellerId/charges

Parâmetros da requisição | Request Body Schema

NomeTipoTamanhoObrgDescrição
correlationIdString26-35SimIdentificador para conciliação do recebedor
amountNumber12,2SimValor da cobrança
expiresInNumber10NãoExpiração do QR Code em segundos. Se não for informado será utilizado o valor default de 86400
formatResponseEnum-NãoIndica qual o formato de resposta das informações. Utilize sempre PAYLOAD_AND_IMAGEBASE64 para retornar o pix copia e cola e a imagem do qrcode
sellerObject-SimInformações do seller. Vendedor da plataforma
seller.nameString255SimNome do seller
seller.emailString255NãoE-mail do seller
seller.documentString14NãoDocumento (CPF ou CNPJ) do seller
payerObject-SimInformações do seller. Vendedor da plataforma
payer.nameString50SimNome do payer da cobrança
payer.documentString14SimDocumento (CPF ou CNPJ) do payer da cobrança
additionalInfoObject []-NãoInformações adicionais que devem ser mostradas ao pagador
additionalInfo[].nameString100SimNome da informação adicional
additionalInfo[].valueString100SimValor da informação adicional

Exemplo de requisição

{
"correlationId": "063167328be14489a9419f17e85129ff",
"formatResponse": "PAYLOAD_AND_IMAGEBASE64",
"amount": 111,
"expiresIn": 1800,
"seller": {
"name": "NOT REQUired",
"email": "[email protected]",
"document": "03987110000187"
},
}

Retorno da requisição | Response Schema

NomeTipoTamanhoObrgDescrição
qrCodePayloadString-SimPayload pix copia e cola do pagamento
qrCodeImageBase64String-SimQRCode da cobrança em imagem base64

Exemplo de retorno da requisição

{
"qrCodePayload": "00020101021226850014br.gov.bcb.pix2563pix-h.delbank.com.br/v1/qrcode/vcharge5b13c75992e74c448688e11e75204000053039865802BR5907DELBANK6007ARACAJU62070503***630409C2"
}