Sign in

v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB
QR Code - Cliente

Qr Code - Dinâmico - Criar

Realiza a criação de um novo qr code dinâmico.
Caracteristicas:

  • Pode ser pago apenas uma vez.
  • Expira.
  • Deve ser parâmetrizado com um identificador único "txId" do cliente para fins de conciliação.
  • Seu status pode ser consultado em Qr Code - Consultar.
  • Os dados do pagamento realizado podem ser consultados em Cobrança - Consulta por TxId
  • Ao ser pago dispara um webhook sob o evento "Recebimento" com o txId parametrizado. Veja Configurando webhook de recebimentos
post/pix/direto/forintegration/v1/qrcodes/dinamico

Request body

txIdstring required

Identificador da transação que pode ser parametrizado pelo cliente. É a informação que será utilizada em webhook para realização da conciliação.

  • O campo TxId deve ter entre 26 e 35 caracteres. [a-zA-z0-9]
validaPagadorboolean

Se marcado como True, o sistema irá validar se o CPF/CNPJ do pagador corresponde ao CPF/CNPJ informado na criação da cobrança.

Response

QR Code criado com sucesso.

status'ATIVA' | 'CONCLUIDA' | 'REMOVIDA_PELO_USUARIO_RECEBEDOR' | 'REMOVIDA_PELO_PSP'
txIdstring nullable
revisaointeger
locationstring nullable
qrCodestring nullable
chavestring nullable
solicitacaoPagadorstring nullable