Sign in

v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB
QR Code - Cliente

Qr Code - Estático - Criar

Realiza a criação de um novo qr code estático.
Caracteristicas:

  • Pode ser pago mais de uma vez.
  • Não expira.
  • 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" porém sem o txId parametrizado. Veja Configurando webhook de recebimentos
post/pix/direto/forintegration/v1/qrcodes/estatico

Request body

chavestring required

Chave pix que pode ser cadastrada na plataforma web. Seguir os passos para criar sua chave em Cadastrando sua chave pix

valornumber double required

Valor do qrcode a ser pago.

  • Se > 0 o pagador não pode alterar o valor do pagamento.
  • Se = 0 ou null o pagador pode especificar o valor à ser pago.
campoLivrestring nullable

Campo utilizado para texto livre que pode ser apresentado na tela do pagador.

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 1 e 25 caracteres. [a-zA-z0-9]

Response

QR Code criado com sucesso.

txIdstring nullable

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 1 e 25 caracteres. [a-zA-z0-9]
qrCodestring nullable

O texto copia e cola do qrcode.

dataCriacaostring date-time

Data de criação do qrcode.