Qr Code - Dinâmico com Vencimento - Criar

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

  • Pode ser pago apenas uma vez.
  • Vence, significando que pode ser pago após o vencimento e as parametriações de juros e multas serão aplicadas.
  • Expira, significando que não poderá ser mais pago.
  • 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
Body Params
string
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]{26,35}
calendario
object
required

Os campos aninhados sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança.

devedor
object

Os campos aninhados sob o objeto devedor são opcionais e identificam o devedor, ou seja, a pessoa ou a instituição a quem a cobrança está endereçada. Não identifica, necessariamente, quem irá efetivamente realizar o pagamento. Um CPF pode ser o devedor de uma cobrança, mas pode acontecer de outro CPF realizar, efetivamente, o pagamento do documento. Não é permitido que o campo devedor.cpf e campo devedor.cnpj estejam preenchidos ao mesmo tempo. Se o campo devedor.cnpj está preenchido, então o campo devedor.cpf não pode estar preenchido, e vice-versa. Se o campo devedor.nome está preenchido, então deve existir ou um devedor.cpf ou um campo devedor.cnpj preenchido.

int64 | null

Identificador da localização do payload.

valor
object

Dados do valor do qrcode.

string
required

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

string | null

O campo solicitacaoPagador, opcional, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor. Esse texto será preenchido, na pacs.008, pelo PSP do pagador, no campo RemittanceInformation . O tamanho do campo na pacs.008 está limitado a 140 caracteres.

infoAdicionais
array of objects | null

Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.

infoAdicionais
Responses

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json