Geração de QR CODEs
Grande facilitador das jornadas de recebimentos via PIX, detalharemos aqui os tipos de QR CODEs que poderão ser gerados e disponibilizados pelos participantes indiretos para uso de seus clientes. Além disso, possibilitamos a gestão dos QR CODES pelo participante indireto com a listagem, alteração e desativação de QR CODEs.
Geração de QR CODE estático
Nesta funcionalidade, o participante indireto poderá gerar QR CODES estáticos que poderão ser pagos uma única vez ou diversas vezes. Além disso, esta cobrança não expira.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| valor | Valor da cobrança | double | Sim |
| campoLivre | Mensagem destinada ao pagador (limite 140 caracteres) | string | Não |
| reutilizavel | Indica a possibilidade do QR CODE receber mais de um pagamento. Default true | boolean | Não |
| transactionId | Identificador da transação da cobrança. Se não for informado, será gerado pelo Banco BS2. | string | Sim |
| chave | Chave Pix e tipo de chave para geração do QR CODE | object | Sim |
| recebedor | Dados do recebedor (documento, dados bancários, endereço, etc.) | object | Sim |
| retirada | Informações destinadas a QR CODE de Pix Saque (ISPB, modalidade de alteração, modalidade de agente e finalidade) | object | Não |
| chaveIdempotencia | Campo que garante a idempotência para o participante processar a solicitação de cobrança. Dessa forma, o participante poderá garantir que não criará em seu ambiente dois registros para a mesma cobrança. | string | Não |
Resposta:
| Campo | Descrição | Formato | Nullable |
|---|---|---|---|
| id | Identificador da cobrança | string | Não |
| transactionId | Identificador da transação da cobrança | string | Sim |
| status | Status do QR CODE, conforme tabela Status QR CODE | string | Não |
| dataCriacao | Data e hora da criação do QR CODE | date-time | Não |
| tipo | Tipo do QR CODE, conforme tabela Tipo QR CODE | string | Não |
| qrCode | Código 'copia e cola' do QR CODE | string | Sim |
| campoLivre | Mensagem destinada ao pagador | string | Sim |
| chave | Chave Pix utilizada na criação do QR CODE | object | Não |
| valor | Valor do QR CODE | double | Sim |
| retirada | Informações destinadas a QR CODE de Pix Saque (ISPB, modalidade de alteração, modalidade de agente e finalidade) | object | Não |
Geração de QR CODE dinâmico
Funcionalidade possibilita que o participante indireto gere QR Codes dinâmicos. Esta cobrança pode ser paga somente uma vez.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| recebedor | Dados do recebedor da cobrança (nome, documento, dados bancários, endereço, etc.) | object | Sim |
| cobranca | Dados da cobrança (valor, modalidade de alteração, dados do devedor, chave Pix, etc.) | object | Sim |
| retirada | Informações destinadas a QR CODE de Pix Saque e Pix Troco (ISPB, modalidade de alteração, modalidade de agente e finalidade) | object | Não |
| chaveIdempotencia | Campo que garante a idempotência para que o participante indireto garantir que não crie em seu ambiente dois registros para a mesma cobrança | string | Não |
Resposta:
| Campo | Descrição | Formato | Nullable |
|---|---|---|---|
| id | identificador do QR CODE | string | Não |
| status | Status do QR CODE, conforme tabela Status QR CODE | string | Não |
| 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. | int64 | Não |
| dataCriacao | Data de criação do QR CODE | date-time | Não |
| qrCode | Código 'copia e cola' do QR CODE | string | Sim |
| valor | Valor do QR CODE | double | Sim |
| location | Dados da URL que retorna os dados atualizados na cobrança (identificador, link, tipo e data de criação) | object | Sim |
| cobranca | Dados da cobrança (valor, modalidade de alteração, dados do devedor, chave Pix, etc.) | object | Sim |
| retirada | Informações destinadas a QR CODE de Pix Saque e Pix Troco (ISPB, modalidade de alteração, modalidade de agente e finalidade) | string | Não |
Geraçã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 os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| recebedor | Dados do recebedor da cobrança (nome, documento, dados bancários, endereço, etc.) | string | Não |
| cobranca | Dados da cobrança (valor, modalidade de alteração, dados do devedor, chave Pix, etc.) | object | Sim |
| chaveIdempotencia | Campo que garante a idempotência para que o participante indireto garantir que não crie em seu ambiente dois registros para a mesma cobrança | string | Não |
Resposta:
| Campo | Descrição | Formato | Nullable |
|---|---|---|---|
| id | Identificador do QR CODE | string | Não |
| transactionId | Identificador da transação da cobrança | string | Sim |
| status | Status do QR CODE, conforme tabela Status QR CODE | string | Não |
| 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. | ||
| dataCriacao | Data de criação do QR CODE | ||
| qrCode | Código 'copia e cola' do QR CODE | ||
| solicitacaoPagador | Mensagem destinada ao pagador | ||
| chave | Chave Pix utilizada na criação do QR CODE | ||
| devedor | Dados do devedor (nome, documento, endereço, etc.) | ||
| calendario | Data de vencimento e validade após o vencimento do QR CODE | ||
| informacoesAdicionais | Informações adicionais da cobrança | ||
| valor | Define os valores da cobrança de QR CODE com vencimento (valor original, juros, multa, desconto e abatimento) | ||
| location | Dados da URL que retorna os dados atualizados da cobrança (identificador, link, tipo e data de criação) |
Criar Qr Code Dinâmico com Vencimento
Listagem de QR CODES
Nesta funcionalidade possibilitamos a obtenção de uma lista de QR CODEs a partir dos parâmetros informados.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| DataInicio | Data de início do período de pesquisa | date-time | Sim |
| DataFim | Data fim do período de pesquisa | date-time | Sim |
| TransactionId | Identificador da transação da cobrança | string | Não |
Resposta:
| Campo | Descrição | Formato | Nullable |
|---|---|---|---|
| id | Identificador do QR CODE | string | Não |
| tipo | Tipo do QR CODE, conforme tabela Tipos de QR CODEs | string | Sim |
| transactionId | Identificador da transação de cobrança | string | Sim |
| criadoEmUtc | Data de criação do QR CODE | date-time | Não |
| valor | Valor da cobrança | double | Sim |
| status | Status do QR CODE, conforme tabela Status QR CODE | string | Sim |
| campoLivre | Mensagem destinado ao recebedor | string | Sim |
| qrCode | Código 'copia e cola' do QR CODE | String | Sim |
| chave | Chave Pix e tipo de chave utilizada na criação do QR CODE | object | Não |
| recebedor | Dados do recebedor da cobrança (nome, documento, dados bancários, endereço, etc.) | object | Sim |
Alteração de QR CODEs dinâmico com vencimento
Nesta funcionalidade possibilitamos a alteração de algumas informações de QR CODEs dinâmicos.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| transactionId | Identificador da transação da cobrança | string | Sim |
| cobranca | Dados da cobrança (valor, modalidade de alteração, dados do devedor, chave Pix, etc.) | object | Sim |
Resposta:
| Campo | Descrição | Formato | Nullable |
|---|---|---|---|
| id | Identificador do QR CODE | string | Não |
| transactionId | Identificador da transação da cobrança | string | Sim |
| status | Status do QR CODE, conforme tabela Status QR CODE | string | Não |
| 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. | int64 | Não |
| dataCriacao | Data da criação do QR CODE | date-time | Não |
| qrCode | Código 'copia e cola' do QR CODE | string | Sim |
| solicitacaoPagador | Mensagem destinada ao pagador | string | Sim |
| chave | Chave Pix e tipo de chave utilizada na criação do QR CODE | object | Não |
| devedor | Dados do devedor (nome, documento, endereço, etc.) | object | Sim |
| calendario | Data de vencimento e validade do QR CODE após o vencimento | object | Sim |
| informacoesAdicionais | Informações adicionais da cobrança | array of objects | Sim |
| valor | Valores da cobrança de QR CODE com vencimento (valor original, juros, multa, desconto, abatimento) | object | Não |
| location | Dados da URL que retorna os dados atualizado da cobrança (identificador, link, tipo e data de criação) | object | Sim |
Alterar informações de um Qr Code com vencimento
Alteração de QR CODEs dinâmico imediato
Nesta funcionalidade possibilitamos a alteração de algumas informações de QR CODEs dinâmicos imediatos.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| qrCodeId | Identificador do QR CODE | object | Sim |
| cobranca | Dados da cobrança (valor, modalidade de alteração, dados do devedor, chave Pix, etc.) | object | Sim |
Resposta:
| Campo | Descrição | Formato | Nullable |
|---|---|---|---|
| id | Identificador do QR CODE | string | Não |
| status | Status do QR CODE, conforme tabela Status QR CODE | 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. | int | Não |
| dataCriacao | Data de criação do QR CODE | date-time | Não |
| valor | Valor do QR CODE | double | Sim |
| location | Dados da URL que retorna os dados atualizado da cobrança (identificador, link, tipo e data de criação) | object | Sim |
| cobranca | Dados da cobrança (valor, modalidade de alteração, dados do devedor, chave Pix, etc.) | object | Sim |
Alterar informações de um Qr Code
Desativação de QR CODEs
Nesta funcionalidade possibilitamos a desativação de um QR CODE, que pode ser estático ou dinâmico.
Solicitamos o campo:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| qrCodeId | Identificador do QR CODE | string | Sim |
Resposta: HTTP 200 success.
Updated 4 months ago