O QR CODE é um código bidimensional que permite ao pagador iniciar um pagamento. Nessa seção, disponibilizamos funcionalidades que possibilitam a geração de QR CODES a partir de uma cobrança.

Criação de QR CODE Estático

Funcionalidade permite gerar QR CODES estáticos. Esta cobrança pode ser paga mais de uma vez e não expira.

Solicitamos os campos:

CampoDescriçãoFormatoObrigatório
chaveTipo de QR CODE, que pode ser Estático ou DinâmicostringSim
valorIdentificador da transação de cobrançanumber Sim
campoLivreStatus do QR CODEstringNão
txIdIdentificador da transaçãodate-timeSim

Resposta:

CampoDescriçãoFormatoNullable
txIdIdentificador da transaçãostringSim
qrCodeCódigo do QR CODE com informações da cobrançaintegerNão
dataCriacaoData de criação do QR CODEstringNão

Qr Code - Estático - Criar

Criação de QR CODE Dinâmico

Funcionalidade permite gerar QR Codes dinâmicos. Esta cobrança pode ser paga somente uma vez.

Solicitamos os campos:

CampoDescriçãoFormatoObrigatório
txIdIdentificador da transaçãodate-timeSim
cobrancaDados de cobrança (expiração, valor, chave Pix, dado do devedor, informações ao pagador)stringSim
validaPagadorSe marcado como 'True', o sistema irá validar se o CPF/CNPJ do pagador corresponde ao CPF/CNPJ informado na criação da cobrança.booleanSim

Resposta:

CampoDescriçãoFormatoNullable
calendarioApresenta a data de criação da cobrança, data de vencimento e data de validade após o vencimento (caso informada)objectNão
statusApresenta o status da cobrança, conforme tabela Status da CobrançastringNão
txIdIdentificador da transação da cobrançastringSim
revisaoDenota a revisão da cobrança, iniciada em zero e varia em acréscimos de 1. O incremento em uma cobrança deve ocorrer sempre que um objeto da cobrança em questão for alterado. O campo loc é uma exceção esta regra. Se em uma determinada alteração em uma cobrança, o único campo alterado for o campo `loc, então não há incremento.integerNão
locationLocalização do payloadstringSim
qrCodeCódigo do QR CODE com informações da cobrançaintegerNão
devedorDados da pessoa física ou jurídica a quem a cobrança será endereçadaobjectNão
valorValores da cobrança, são eles: valor original, juros, multa, abatimento e descontoobjectNão
chaveChave Pix para geração da cobrançastringSim
solicitacaoPagadorMensagem destinada ao pagador (limitado a 140 caracteres)stringNão
infoAdicionaisCada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagadorArraySim

Qr Code - Dinâmico - Criar

Criação de QR CODE Dinâmico com Vencimento

Funcionalidade permite gerar QR CODES dinâmicos para pagamento em data futura, e além do valor da cobrança é possível também configurar juros, multa e descontos. Esta cobrança pode ser paga somente uma vez e expira após o pagamento.

Solicitamos o campo:

CampoDescriçãoFormatoObrigatório
txIdIdentificador da transaçãostringSim

Resposta:

CampoDescriçãoFormatoNullable
txIdIdentificador da transação da cobrançastringSim
calendarioApresenta a data de criação da cobrança, data de vencimento e data de validade após o vencimento (caso informada)objectNão
devedorDados da pessoa física ou jurídica a quem a cobrança será endereçadaobjectNão
locApresenta a identificação da localização do payload (identificador, localização, tipo da cobrança ("COB" ou "COBV") e data/hora criação)objectNão
valorValores da cobrança, são eles: valor original, juros, multa, abatimento e descontoobjectNão
chaveChave Pix para geração da cobrançastringSim
solicitacaoPagadorMensagem destinada ao pagador (limitado a 140 caracteres)stringNão
infoAdicionaisCada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagadorArraySim

Qr Code - Dinâmico com Vencimento - Criar

Consulta a QR CODEs

Funcionalidade permite consultar os QR CODES dos tipos estáticos e dinâmicos gerados, apresentando seu status.

Solicitamos os campos:

CampoDescriçãoFormatoObrigatório
TipoTipo de QR CODE, que pode ser: Estático ou DinâmicostringSim
TxIdIdentificador da transação de cobrançastringNão
StatusStatus do QR CODEstringSim
InicioInício do período desejado de pesquisadate-timeSim
FimFim do período desejado de pesquisadate-timeSim

Resposta:

CampoDescriçãoFormatoNullable
qrCodeIdIdentificador do QR CODEintegerNão
tipoTipo de QR CODE, que pode ser: Estático ou DinâmicostringNão
txIdIdentificador da transação de cobrançastringSim
dataCriacaoData de criação do QR CODEdate-timeNao
dataValidadeData de validade do QR CODEdate-timeNão
valorValor do QR CODEnumber Não
statusStatus da cobrança, conforme tabela Status da CobrançastringNão
campoLivreCampo informado pelo pagador no momento do pagamentostringSim
chaveChave Pix utilizada na geração do QR CODEobjectNão
linkLink para uso interno do Banco BS2stringSim
recebedorDados do recebedor (dados bancários, nome, nome fantasia e documento)objectSim
qrCodeCódigo 'copia e cola' do QR CODEstringSim
valorRecebimentoValor recebido por meio do QR CODEnumber Não
quantidadePagamentoQuantidade de recebimentos do QR CODEobjectNão

QR Code - Consultar

Desativação de QR CODE

Funcionalidade permite cancelar um QR CODE gerado. Ao desativá-lo, ele não poderá mais ser pago.

Solicitamos o campo:

CampoDescriçãoFormatoObrigatório
qrCodeIdIdentificador do QR CODEstringSim

Resposta:

CampoDescriçãoFormatoNullable
statusCodeStatus do QR CODEstringSim

QR Code - Desativar

Alteração de QR CODE Dinâmico com Vencimento

Funcionalidade permite alterar as configurações de um QR CODE dinâmico com vencimento, enquanto não tiver sido pago.

Solicitamos os campos:

CampoDescriçãoFormatoObrigatório
txIdIdentificador da transaçãostringSim
cobrancaApresenta os dados da cobrança (dados do pagador, datas, valores, etc.)objectSim
statusStatus da cobrança, conforme tabela Status da CobrançastringNão

Resposta:

CampoDescriçãoFormatoNullable
txIdIdentificador da transação da cobrançastringSim
revisaoDenota a revisão da cobrança, iniciada em zero e varia em acréscimos de 1. O incremento em uma cobrança deve ocorrer sempre que um objeto da cobrança em questão for alterado. O campo loc é uma exceção a esta regra. Se em uma determinada alteração em uma cobrança, o único campo alterado for o campo `loc, então não há incremento.integerNão
locApresenta a identificação da localização do payload (identificador, localização, tipo da cobrança ("COB" ou"COBV") e data/hora criação)objectNão
qrCodeCódigo do QR CODE com informações da cobrançaintegerNão
statusApresenta o status da cobrança, conforme tabela Status da CobrançastringNão

QR Code - Dinâmico com Vencimento - Alterar.

Alteração de QR CODE Dinâmico

Funcionalidade permite alterar as configurações de um QR CODE dinâmico sem vencimento, enquanto não tiver sido pago.

Solicitamos o campo:

Solicitamos os campos:

CampoDescriçãoFormatoObrigatório
qrCodeIdIdentificador do QR CODEstringSim
calendarioApresenta a data de criação da cobrança, data de vencimento e data de validade após o vencimento (caso informada)objectNão
pagadorApresenta os dados do pagador do Pix (banco, agência, conta, documento)objectSim
valorValores da cobrança, são eles: valor original, juros, multa, abatimento e descontoobjectNão
chaveChave Pix para geração da cobrançastringSim
solicitacaoMensagem destinada ao pagador (limitado a 140 caracteres)stringNão
idLocationIdentificador da localização do payloadstringNão
infoAdicionaisCada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagadorArraySim
statusApresenta o status da cobrança, conforme tabela Status da CobrançastringNão

Resposta:

CampoDescriçãoFormatoNullable
calendarioData de criação da cobrança, data de vencimento e data de validade após o vencimento (caso informada)objectNão
documentoCPF/CNPJ do pagadorobjectSim
pagadorApresenta os dados do pagador do Pix (banco, agência, conta, documento)objectSim
valorValores da cobrança, são eles: valor original, juros, multa, abatimento e descontoobjectNão
chaveChave Pix para geração da cobrançastringSim
identificadorTransacaoIdentificador da transação de cobrançastringSim
solicitacaoMensagem destinada ao pagador (limitado a 140 caracteres)stringSim
infoAdicionaisCada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagadorArraySim

QR Code - Dinâmico - Alterar.