QR Code
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.
QR CODE - Estático - Criar
Funcionalidade permite gerar QR CODES estáticos. Esta cobrança pode ser paga mais de uma vez e não expira.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| chave | Tipo de QR CODE, que pode ser Estático ou Dinâmico | string | Sim |
| valor | Identificador da transação de cobrança | number | Sim |
| campoLivre | Status do QR CODE | string | Não |
| txId | Identificador da transação | date-time | Sim |
Resposta:
| Campo | Descrição | Formato | Nullablle |
|---|---|---|---|
| txId | Identificador da transação | string | Sim |
| qrCode | Código do QR CODE com informações da cobrança | integer | Não |
| dataCriacao | Data de criação do QR CODE | string | Não |
QR CODE- Dinâmico - Criar
Funcionalidade permite gerar QR Codes dinâmicos. Esta cobrança pode ser paga somente uma vez.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| txId | Identificador da transação | date-time | Sim |
| cobranca | Dados de cobrança (expiração, valor, chave Pix, dado do devedor, informações ao pagador) | string | Sim |
| validaPagador | 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. | boolean | Sim |
Resposta:
| Campo | Descrição | Formato | Nullablle |
|---|---|---|---|
| calendario | Apresenta a data de criação da cobrança, data de vencimento e data de validade após o vencimento (caso informada) | object | Não |
| status | Apresenta o status da cobrança, conforme tabela [Status da Cobrança] | string | Não |
| txId | Identificador da transação da cobrança | string | Sim |
| revisao | Denota 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. | integer | Não |
| location | Localização do payload | string | Sim |
| qrCode | Código do QR CODE com informações da cobrança | integer | Não |
| devedor | Dados da pessoa física ou jurídica a quem a cobrança será endereçada | object | Não |
| valor | Valores da cobrança, são eles: valor original, juros, multa, abatimento e desconto | object | Não |
| chave | Chave Pix para geração da cobrança | string | Sim |
| solicitacaoPagador | Mensagem destinada ao pagador (limitado a 140 caracteres) | string | Não |
| infoAdicionais | Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador | Array | Sim |
QR CODE - Dinâmico com Vencimento - Criar
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:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| txId | Identificador da transação | string | Sim |
Resposta:
| Campo | Descrição | Formato | Nullablle |
|---|---|---|---|
| txId | Identificador da transação da cobrança | string | Sim |
| calendario | Apresenta a data de criação da cobrança, data de vencimento e data de validade após o vencimento (caso informada) | object | Não |
| devedor | Dados da pessoa física ou jurídica a quem a cobrança será endereçada | object | Não |
| loc | Apresenta a identificação da localização do payload (identificador, localização, tipo da cobrança ("COB" ou"COBV") e data/hora criação) | object | Não |
| valor | Valores da cobrança, são eles: valor original, juros, multa, abatimento e desconto | object | Não |
| chave | Chave Pix para geração da cobrança | string | Sim |
| solicitacaoPagador | Mensagem destinada ao pagador (limitado a 140 caracteres) | string | Não |
| infoAdicionais | Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador | Array | Sim |
Qr Code - Dinâmico com Vencimento - Criar
QR CODE - Consultar
Funcionalidade permite consultar os QR CODES dos tipos estáticos e dinâmicos gerados, apresentando seu status.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| Tipo | Tipo de QR CODE, que pode ser: Estático ou Dinâmico | string | Sim |
| TxId | Identificador da transação de cobrança | string | Não |
| Status | Status do QR CODE | string | Sim |
| Inicio | Início do período desejado de pesquisa | date-time | Sim |
| Fim | Fim do período desejado de pesquisa | date-time | Sim |
Resposta:
| Campo | Descrição | Formato | Nullablle |
|---|---|---|---|
| qrCodeId | Identificador do QR CODE | integer | Não |
| tipo | Tipo de QR CODE, que pode ser: Estático ou Dinâmico | string | Não |
| txId | Identificador da transação de cobrança | string | Sim |
| dataCriacao | Data de criação do QR CODE | date-time | Nao |
| dataValidade | Data de validade do QR CODE | date-time | Não |
| valor | Valor do QR CODE | number | Não |
| status | Status da cobrança, conforme tabela [Status da cobrança] | string | Não |
| campoLivre | Campo informado pelo pagador no momento do pagamento | string | Sim |
| chave | Chave Pix utilizada na geração do QR CODE | object | Não |
| link | Link para uso interno do Banco BS2 | string | Sim |
| recebedor | Dados do recebedor (dados bancários, nome, nome fantasia e documento) | object | Sim |
| qrCode | Código 'copia e cola' do QR CODE | string | Sim |
| valorRecebimento | Valor recebido por meio do QR CODE | number | Não |
| quantidadePagamento | Quantidade de recebimentos do QR CODE | object | Não |
QR CODE - Desativar
Funcionalidade permite cancelar um QR CODE gerado. Ao desativá-lo, ele não poderá mais ser pago.
Solicitamos o campo:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| qrCodeId | Identificador do QR CODE | string | Sim |
Resposta:
| Campo | Descrição | Formato | Nullablle |
|---|---|---|---|
| statusCode | Status do QR CODE | string | Sim |
QR CODE - Dinâmico com Vencimento - Alterar
Funcionalidade permite alterar as configurações de um QR CODE dinâmico com vencimento, enquanto não tiver sido pago.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| txId | Identificador da transação | string | Sim |
| cobranca | Apresenta os dados da cobrança (dados do pagador, datas, valores, etc.) | object | Sim |
| status | Status da cobrança, conforme tabela [Status da cobrança] | string | Não |
Resposta:
| Campo | Descrição | Formato | Nullablle |
|---|---|---|---|
| txId | Identificador da transação da cobrança | string | Sim |
| revisao | Denota 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. | integer | Não |
| loc | Apresenta a identificação da localização do payload (identificador, localização, tipo da cobrança ("COB" ou"COBV") e data/hora criação) | object | Não |
| qrCode | Código do QR CODE com informações da cobrança | integer | Não |
| status | Apresenta o status da cobrança, conforme tabela [Status da Cobrança] | string | Não |
QR Code - Dinâmico com Vencimento - Alterar.
QR CODE - Dinâmico - Alterar
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:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| qrCodeId | Identificador do QR CODE | string | Sim |
| calendario | Apresenta a data de criação da cobrança, data de vencimento e data de validade após o vencimento (caso informada) | object | Não |
| pagador | Apresenta os dados do pagador do Pix (banco, agência, conta, documento) | object | Sim |
| valor | Valores da cobrança, são eles: valor original, juros, multa, abatimento e desconto | object | Não |
| chave | Chave Pix para geração da cobrança | string | Sim |
| solicitacao | Mensagem destinada ao pagador (limitado a 140 caracteres) | string | Não |
| idLocation | Identificador da localização do payload | string | Não |
| infoAdicionais | Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador | Array | Sim |
| status | Apresenta o status da cobrança, conforme tabela [Status da Cobrança] | string | Não |
Resposta:
| Campo | Descrição | Formato | Nullablle |
|---|---|---|---|
| calendario | Data de criação da cobrança, data de vencimento e data de validade após o vencimento (caso informada) | object | Não |
| documento | CPF/CNPJ do pagador | object | Sim |
| pagador | Apresenta os dados do pagador do Pix (banco, agência, conta, documento) | object | Sim |
| valor | Valores da cobrança, são eles: valor original, juros, multa, abatimento e desconto | object | Não |
| chave | Chave Pix para geração da cobrança | string | Sim |
| identificadorTransacao | Identificador da transação de cobrança | string | Sim |
| solicitacao | Mensagem destinada ao pagador (limitado a 140 caracteres) | string | Sim |
| infoAdicionais | Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador | Array | Sim |
Status da cobrança
A tabela abaixo apresenta o status da cobrança:
| Campo | Descrição |
|---|---|
| ATIVA | O QR CODE está apto para pagamento |
| CONCLUIDA | O QR CODE foi pago |
| REMOVIDA_PELO_USUARIO_RECEBEDOR | O QR CODE foi cancelado pelo usuário |
| REMOVIDA_PELO_PSP | O QR CODE foi removido pelo Banco BS2 |
Updated 4 months ago