Cobrança
A partir das informações de cobrança geradas nas funcionalidades abaixo, o cliente pode gerar, por meio da automação própria, um QR CODE, que, ao ser lido, recuperará os dados do pagamento.
Importante:
O código de barras bidimensional QR Code deve ser gerado seguindo as especificações do Banco Central (<https://www.bcb.gov.br/estabilidadefinanceira/participantespix>).
Cobrança com vencimento - Criar cobrança
Funcionalidade permite gerar uma cobrança para pagamento em data futura. Além do valor da cobrança também é possível configurar juros, multa e descontos.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| txId | Identificador único que permite ao recebedor identificar a cobrança | string | Sim |
| calendario | Data de vencimento e a data de validade após o vencimento (opcional, default 30 dias) | object | Sim |
| devedor | Dados da pessoa física ou jurídica a quem a cobrança será endereçada. Não necessariamente é o pagador final | object | Não |
| loc | Identificação da localização do payload | integer | Não |
| valor | Valores da cobrança, são eles: valor original, juros, multa, abatimento e desconto | object | Sim |
| 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 | 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 |
| 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 |
| devedor | Dados da pessoa física ou jurídica a quem a cobrança será endereçada | object | Não |
| recebedor | Dados do recebedor da cobrança, que é o cliente do BS2 | object | Não |
| loc | Identificação da localização do payload | object | Não |
| status | Status da cobrança, conforme tabela [Status da Cobrança] | string | Não |
| valor | Valores da cobrança, são eles: valor original, juros, multa, abatimento e desconto | object | Não |
| chave | Chave PIX utilizada na 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 |
Cobrança com vencimento - Criar cobrança
Cobrança com vencimento - Revisar
Funcionalidade permite alterar uma cobrança para pagamento em data futura criada anteriormente.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| txId | Identificador único que permite ao recebedor identificar a cobrança | string | Sim |
| calendario | Data de vencimento e a data de validade após o vencimento (esta última é opcional) | object | Sim |
| devedor | Dados da pessoa física ou jurídica a quem a cobrança será endereçada. Não necessariamente é o pagador final | object | Não |
| loc | Identificação da localização do payload | object | Sim |
| status | Status da cobrança conforme tabela [Status da Cobrança] | string | Sim |
| valor | Valores da cobrança, são eles: valor original, juros, multa, abatimento e desconto | object | Sim |
| chave | Chave PIX para geração da cobrança | string | Não |
| 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 | Não |
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 |
| txId | Identificador único que permite ao recebedor identificar a 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 |
| devedor | Dados da pessoa física ou jurídica a quem a cobrança será endereçada | object | Não |
| recebedor | Dados do recebedor da cobrança, que é o cliente do BS2 | object | Não |
| loc | Identificação da localização do payload | object | Não |
| status | Apresenta o status da cobrança, conforme tabela [Status da Cobrança] | string | Não |
| valor | Apresenta os valores da cobrança, são eles: valor original, juros, multa, abatimento e desconto | object | Não |
| chave | Chave PIX utilizada na 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 |
Cobrança com vencimento - Revisar
Cobrança - Criar cobrança
Funcionalidade permite gerar uma cobrança de pagamento imediato.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| calendario | Data de expiração em segundos a partir do momento da emissão da cobrança. Depois de expirado a cobrança não poderá ser paga | object | Sim |
| devedor | Dados da pessoa física ou jurídica a quem a cobrança será endereçada. Não necessariamente é o pagador final | object | Sim |
| valor | Solicita os valores da cobrança e a modalidade de alteração (Se igual a 0 assume-se o valor original, e igual a 1 o usuário poderá alterar o valor) | object | Sim |
| 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 | Não |
Resposta:
| Campo | Descrição | Formato | Nullablle |
|---|---|---|---|
| calendario | Data de criação e expiração da cobrança | object | Não |
| status | Apresenta o status da cobrança conforme tabela [Status da Cobrança] | string | Não |
| txId | Identificador único que permite ao recebedor identificar a 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 | integer | Não |
| location | Localização do payload a ser informado na criação da cobrança | string | Sim |
| devedor | Dados da pessoa física ou jurídica a quem a cobrança será endereçada. Não necessariamente é o pagador final | object | Não |
| valor | Valor da cobrança | object | Não |
| chave | Chave PIX utilizada na 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 |
Cobrança - Revisar
Funcionalidade permite alterar uma cobrança de pagamento imediato.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| txId | Identificador único que permite ao recebedor identificar a cobrança | string | Sim |
| calendario | Solicita a data de vencimento e a data de validade após o vencimento (esta última é opcional) | object | Sim |
| devedor | Solicita dados da pessoa física ou jurídica a quem a cobrança será endereçada. Não necessariamente é o pagador final | object | Não |
| loc | Identificação da localização do payload | object | Sim |
| status | Status da cobrança, conforme tabela [Status da Cobrança] | string | Sim |
| valor | Solicita os valores da cobrança, são eles: valor original, juros, multa, abatimento e desconto | object | Sim |
| 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 | Não |
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 | Sim |
| status | Apresenta o status da cobrança, conforme tabela [Status da Cobrança] | string | Não |
| txId | Identificador único que permite ao recebedor identificar a cobrança | 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. 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 |
| location | Localização do payload a ser informado na criação da cobrança | string | Sim |
| devedor | Apresenta dados da pessoa física ou jurídica a quem a cobrança será endereçada | object | Não |
| valor | Apresenta os valores da cobrança, são eles: valor original, juros, multa, abatimento e desconto | object | Não |
| chave | Chave PIX utilizada na 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 |
Cobrança - Criar por Id da transação
Funcionalidade permite gerar uma cobrança para pagamento imediato.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| txId | Identificador único que permite ao recebedor identificar a cobrança | string | Sim |
| calendario | Solicita a data de vencimento e a data de validade após o vencimento (esta última é opcional) | object | Sim |
| devedor | Solicita dados da pessoa física ou jurídica a quem a cobrança será endereçada. Não necessariamente é o pagador final | object | Sim |
| valor | Solicita os valores da cobrança, são eles: valor original, juros, multa, abatimento e desconto | object | Sim |
| chave | Chave PIX para geração da cobrança | string | Sim |
| solicitacaoPagador | Solicita 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 | Não |
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 único que permite ao recebedor identificar a 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 |
| location | Localização do payload a ser informado na criação da cobrança | string | Sim |
| devedor | Apresenta dados da pessoa física ou jurídica a quem a cobrança será endereçada | object | Não |
| valor | Apresenta os valores da cobrança, são eles: valor original, juros, multa, abatimento e desconto | object | Não |
| chave | Chave PIX utilizada na geração da cobrança | string | Sim |
| solicitacaoPagador | 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 |
Cobrança - Criar por Id da transação
Cobrança - Consultar por TxId
Funcionalidade permite consultar a partir do identificador criado pelo cliente na geração da cobrança uma cobrança específica.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| txId | Identificador único que permite ao recebedor identificar a 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 |
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 único que permite ao recebedor identificar a cobrança | string | Sim |
| location | Localização do payload a ser informado na criaçã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 |
| devedor | Apresenta dados da pessoa física ou jurídica a quem a cobrança será endereçada | object | Não |
| valor | Apresenta os valores da cobrança, são eles: valor original, juros, multa, abatimento e desconto | object | Não |
| chave | Chave PIX utilizada na geração da cobrança | string | Sim |
| solicitacaoPagador | Apresenta o texto a ser apresentado ao pagador, caso tenha sido definido | string | Sim |
| infoAdicionais | Mensagem destinada ao pagador (limitado a 140 caracteres) | Array | Sim |
| pix | Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador | Array | Sim |
Cobrança - Consultar lista de cobranças
Funcionalidade permite recuperar uma ou mais cobranças geradas a partir de alguns parâmetros.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| Inicio | Início do período desejado de pesquisa | string | Sim |
| Fim | Fim do período desejado de pesquisa | string | Sim |
| CPF | CPF do pagador caso deseje filtrar pelo documento, não pode ser utilizado com o campo CNPJ | string | Não |
| CNPJ | CNPJ do pagador caso deseje filtrar pelo documento, não pode ser utilizado com o campo CPF | string | Não |
| Status | Status da cobrança, conforme tabela [Status da Cobrança] | string | Sim |
Resposta:
| Campo | Descrição | Formato | Nullablle |
|---|---|---|---|
| inicio | Data inicial informada | object | Não |
| fim | Data final informada | string | Não |
| cpf | CPF do pagador | string | Sim |
| cnpj | CPF do pagador | string | Sim |
| calendario | Data de criação da cobrança, data de vencimento e data de validade após o vencimento (caso informada) | object | Não |
| status | Status da cobrança, conforme tabela [Status da Cobrança] | string | Não |
| txId | Identificador único que permite ao recebedor identificar a 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 |
| location | Localização do payload a ser informado na criação da cobrança | string | Sim |
| 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 utilizada na geração da cobrança | string | Sim |
| solicitacaoPagador | Mensagem destinada ao pagador (limitado a 140 caracteres) | string | Sim |
| pix | Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador | Array | Sim |
Cobrança - Consultar lista de cobranças
Status da cobrança
A tabela abaixo apresenta o status da cobrança:
| Campo | Descrição |
|---|---|
| ATIVA | A cobrança está apto para pagamento |
| CONCLUIDA | A cobrança foi paga |
| REMOVIDA_PELO_USUARIO_RECEBEDOR | A cobrança foi cancelada pelo usuário |
| REMOVIDA_PELO_PSP | A cobrança foi cancelada pelo Banco BS2 |
Updated 6 months ago