Gerar QRCode Pix

Este endpoint foi desenvolvido como uma ferramenta auxiliar para quem deseja gerar a imagem de um QR Code a partir do código EMV (copia e cola) diretamente via API da Paytime.

🔽

GETurlServidor/v1/marketplace/transactions/{id}/qrcode

Obs: A palavra urlServidor deve ser substituída pela url do servidor.

📘

Importante:

Finalidade: Este endpoint não é obrigatório para a integração com o Pix. Ele serve para facilitar a geração de imagens do QR Code, caso deseje utilizar a API da Paytime para obter o hash em Base64.

Flexibilidade: Você pode optar por utilizar qualquer biblioteca ou ferramenta no frontend para criar a imagem do QR Code a partir do hash gerado.


O que é o Código EMV (Copia e Cola)?

O EMV (copia e cola) é o padrão que contém todas as informações necessárias para realizar um pagamento Pix. Ele pode ser utilizado de duas formas:

  • Colar diretamente no aplicativo do pagador.
  • Gerar uma imagem QR Code para ser escaneada, facilitando a experiência do usuário.

Como funciona a geração do QR Code?

  1. O endpoint da API Paytime retorna o hash do QR Code em formato Base64, que é a representação codificada da imagem do QR Code.
  2. Após receber o hash, cabe ao frontend utilizar uma biblioteca de sua escolha para:
    • Decodificar o hash Base64.
    • Gerar a imagem do QR Code.
    • Ajustar a exibição na aplicação, garantindo que o QR Code esteja visível e acessível para escaneamento.

Parâmetros da Requisição

Headers

ParâmetroTipoObrigatórioDescrição
integration-keystringSimChave de integração.
x-tokenstringSimToken utilizado para autenticação. Pode ser encontrado no portal, na guia de integração.
AuthorizationAuth Type Bearer TokenSimInserir o Bearer Token, gerado na rota Auth

Path Parameters

ParâmetroTipoObrigatórioDescrição
idstringSimID da transação do tipo PIX para geração do QRCode.

Exemplo de Requisição

curl -X GET "https://urlServidor/v1/marketplace/transactions/12345/qrcode" \
-H "integration-key: your_integration_key" \
-H "x-token: your_x_token" \

⚠️

Atenção

A chave de integração integration-key e o token x-token devem ser obtidos através do portal do desenvolvedor.

O ID da transação (id) é obrigatório e deve ser válido para que o QRCode seja gerado com sucesso.

Resposta da Requisição

Se a requisição for processada com sucesso, será retornado um status 200 com a seguinte estrutura JSON:

{
    "qrcode": "data:image/gif;base64,R0lGODdhqwCrAIAAAAAAAP///ywAAAAAqwCrAAAC/4yPqcvtD6OctNqLs968+w+G4kiW5omm6sq27gvH8kzX9o3n+s73/g8MCoc0gPGITCoPR6bRqURCG01GNXCFLhPRJ9eL7YqzmLF5ariaAegFGaEGa5MKcR28tm/y3XZ83HbHZoUnl9b3FSU4x2d48UblCJmo57AFhxgm9fB3OenmaPG5mAixZkpHmao5ejjIutqK+ZohG+iKCsi5ytgZWurq+QtKW1aoiJs8m3s7W/lWGfkqPJ1pu1uNrNks+yf9LJkpzehnPTzhu7mt3Ey6TgxeDKs+Hnzce793TF0u796urJs4Veqg7Yt1TkI6bwETvgP4TqA2QfyAzWOoYWG+iP8ODfpr+NEZL4IY+1XMeLDgxm9n7GVrJBFivYsrjb1EmC3XKZf48jBjpzBlSZs9++lsOa/nTks1I2jMqS/kP6A0pVL9RO3pzKlMrTp1yC3cRELysOLUSnYrNg7XHl4dSIwrOZ4uzYZs25YlTKMg+XKE+tcvxsEw6dksDJhw4o2KBTN+fHNvVMSOF1uujLmv5qpLhyCOZvGo5bxEKHyGK5OgSbClRZ2+JJesYtIpOoNslPovZapz477VRpsi3KfxfnJGatduWOCsu4LWzSc3ceTDYFv0eLIW9bJIe8ek67ypR67Bg+pye5y7Sq/pRC8nL7bEUuzDcRq3Dk98/NC8PeD/V7ofetONtQx/IgGWGXpsjXQgfkNB51NaBnoXYGMh/FcXgw8OiKGA1dl3HWQiKCdhUhmuByCKIRoWGHjuPOfaXR9GluJq543n4mYdooWSjD5SeKNQ5qjXW2UkVvXBScmlFJuJ6cFHY45fITiZiLIxOSF4tnkYpZPoNKWdigpqqeGMA0IJJG0PhvmlejgW6GRx/XHZ3pxvLujVcnfeJuRlJaYJ5m9JNkcfkSvyuOZvdY7JJZ47minWc3u2+OSJZ0rpKIMQOdidoCvWaGmfiw5K4KZlnvfep6FGltWQ5T2iKZl+HuiXqYbGCSmBr7p35ayF1mpnhSDmp2tzMS7pa6RW/8KJpqx6cZqnf502OqdwrEKG17RborDlm9mup2SsxEIL4wndChstrsx1KRq5qB1mLLzgKutjodA2C+eumF7oKr16WXuvgd7GSyy3/bqZK8Cn4gssrLfa2OGz9MrpW3qJQognvtti426QP6568ahECSwqwZJGF+y1684UsXnWvjgxoafiZl7AzKoW1cuqNigzi7tNabOt+tKJrsLpdrzxuAEKTTDMs+pMbcUQvwv0zMtmrGPCnkrNJ6oVnCzm0AkimyrXEJZbtc/Dis3x0lsXRVKuFDsN9cWkTop3faWCHCilQOaW6cNvn2i0xCuX+OtmWCu97sAIf/Yv4XFHeHOPhv+3equ9hUWO5OTnpmuc0ZjT7TnKBUvOM+WAf41lxRv2bevqlVbeMKlF7ux46Du3uzDiTbu8L6W5r+X70drOKHuY4aq8KKJ9j67osnbLa+Hsyy/PeXbOZg16zWuX3KXzVNK6PfnCwz4yo0F3rX3liXcV+5/Sjn971PMhTzKLpJudPPDq956v7aiFaOx5Hv5MQDMv8W1elPvc5TbXggQibTsSPF69XvO7Ht1PbZKx2Fn09sAO2o51T1Mc91LUvvrFT4EOi1HDXpesDpJNfgHUHwldaEK/nXCBIRPXkVoGgvZVb2rjk8iRyoY2+QwrQUQsG+cYxr4MKk8/JTwbFXllNsf/AbFNx/ogB7mYJdNQ7XpUA6MYGwdA3TGqTY8K27RweEbMTWqAQ0MbGffmMJvxaIBqXGEP6UfDKX4xigXs3v8+psMamjFww+sc/G4YyB26rmcjsiCgCpk0kT2ShTBUotcwFjwUHnCLXdtf/+IIQlkZ8Y2l9J8e3daBDaqQel6EGyjNNxspeu9wLBQk9BypSeyFcn4UI2XafllMq8WQbfyTV92u1kp1FS6ap1xklR7HxGgKcUj1Y2aTuohNSdrob5MbZxgDZ8pqrYplS2xb+FrnglcKjnE/bGd43smuCAJwjqVDZAp7Rc5eqsCY6TzdGmn4M9Gl8qBpY5M6pQnJ1NkR/4KKvKZDGfrPTYrShh4cJEPNuMccas5jbdxoPOSoy4o68oUxI6kPwbdBlBqSnSor6EhP+lLmmQ6nHI2nFyeKT+m0VJ58hIFMS1q+70h0nwcswk/H2LrpERBsK1zcNFVKU1C5z54XXQGyGpnVdeZPqtasjdyKRjwrejSgVh0oVBl4n6Hu9HvGW2ZKbfnMnooUg0F96NjEBc4ZChSrPDxY7YpnTg3m9KimUygeE9qrCs60nJGFKSs7+tXLmpSrJGwjY1XXT882trINvOs1kak3wWa2kGH9qLko2Ceo5dVwfRSnUWFbU5wZdLW1Pd9kl/rJkQZUmIkU3xCHeczRTjWqzP+NodNQW0TA7jKBeqqlNqWHLuhW97eyO+IuD3vL92WUny303zcBmsPEipezUWurRs+J3kSq11/lg6LlUAfWBRIRssB8qsdG2N/MydWNfG3pJWU5P1vmt6P7paiC/Tu3nOHXgPMUbAhfdakRiK+qgzPfhTOY4UrmVr4dtjBpCXqoMko4wOAlLtNcKiY4zvKMD67icGG50Rp3Fblx5eUfj3vImLJXjShu5iQBSU/6tjdl61tyLCmZ3hMrOW8XXGuH3dvab4Gtk2Gkav5E/DOk1nDLyuQyRO9Zx9PMWIupLfMV60taRs6Vo2wulp232Vc0m7Y1fO6zn/8M6EALetCELrQWoQ+N6EQretGMbrSjHw3pSEt60pEuAAA6"
}

InformaçãoModelo de imagem gerada a partir do hash em base 64.
Modelo de imagem gerada a partir do hash em base 64, através de uma ferramenta pública na internet.

Campos da Resposta


ParâmetroTipoDescrição
qrcodestringHash do QRCode Pix gerado em base 64. Contém todos os dados necessários para efetuar o pagamento.

Códigos de Resposta

Consulte a página com os status: Status de respostas

Para mais detalhes sobre os parâmetros e funcionamento da API, acesse a documentação oficial da Paytime.


Did this page help you?