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, veja aqui.

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:

CampoDescriçãoFormatoObrigatório
txIdIdentificador único que permite ao recebedor identificar a cobrançastringSim
calendarioData de vencimento e a data de validade após o vencimento (opcional, default 30 dias)objectSim
devedorDados da pessoa física ou jurídica a quem a cobrança será endereçada. Não necessariamente é o pagador finalobjectNão
locIdentificação da localização do payloadintegerNão
valorValores da cobrança, são eles: valor original, juros, multa, abatimento e descontoobjectSim
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 pagadorArrayNã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
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
devedorDados da pessoa física ou jurídica a quem a cobrança será endereçadaobjectNão
recebedorDados do recebedor da cobrança, que é o cliente do BS2objectNão
locIdentificação da localização do payloadobjectNão
statusStatus da cobrança, conforme tabela Status da CobrançastringNão
valorValores da cobrança, são eles: valor original, juros, multa, abatimento e descontoobjectNão
chaveChave PIX utilizada na 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

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:

CampoDescriçãoFormatoObrigatório
txIdIdentificador único que permite ao recebedor identificar a cobrançastringSim
calendarioData de vencimento e a data de validade após o vencimento (esta última é opcional)objectSim
devedorDados da pessoa física ou jurídica a quem a cobrança será endereçada. Não necessariamente é o pagador finalobjectNão
locIdentificação da localização do payloadobjectSim
statusStatus da cobrança conforme tabela Status da CobrançastringSim
valorValores da cobrança, são eles: valor original, juros, multa, abatimento e descontoobjectSim
chaveChave PIX para geração da cobrançastringNão
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 pagadorArrayNão

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
txIdIdentificador único que permite ao recebedor identificar a 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
devedorDados da pessoa física ou jurídica a quem a cobrança será endereçadaobjectNão
recebedorDados do recebedor da cobrança, que é o cliente do BS2objectNão
locIdentificação da localização do payloadobjectNão
statusApresenta o status da cobrança, conforme tabela Status da CobrançastringNão
valorApresenta os valores da cobrança, são eles: valor original, juros, multa, abatimento e descontoobjectNão
chaveChave PIX utilizada na 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

Cobrança com vencimento - Revisar

Cobrança - Criar cobrança

Funcionalidade permite gerar uma cobrança de pagamento imediato.

Solicitamos os campos:

CampoDescriçãoFormatoObrigatório
calendarioData 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 pagaobjectSim
devedorDados da pessoa física ou jurídica a quem a cobrança será endereçada. Não necessariamente é o pagador finalobjectSim
valorSolicita 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)objectSim
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 pagadorArrayNão

Resposta:

CampoDescriçãoFormatoNullable
calendarioData de criação e expiração da cobrançaobjectNão
statusApresenta o status da cobrança conforme tabela Status da CobrançastringNão
txIdIdentificador único que permite ao recebedor identificar a 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 alteradointegerNão
locationLocalização do payload a ser informado na criação da cobrançastringSim
devedorDados da pessoa física ou jurídica a quem a cobrança será endereçada. Não necessariamente é o pagador finalobjectNão
valorValor da cobrançaobjectNão
chaveChave PIX utilizada na 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

Cobrança - Criar cobrança

Cobrança - Revisar

Funcionalidade permite alterar uma cobrança de pagamento imediato.

Solicitamos os campos:

CampoDescriçãoFormatoObrigatório
txIdIdentificador único que permite ao recebedor identificar a cobrançastringSim
calendarioSolicita a data de vencimento e a data de validade após o vencimento (esta última é opcional)objectSim
devedorSolicita dados da pessoa física ou jurídica a quem a cobrança será endereçada. Não necessariamente é o pagador finalobjectNão
locIdentificação da localização do payloadobjectSim
statusStatus da cobrança, conforme tabela Status da CobrançastringSim
valorSolicita os valores da cobrança, são eles: valor original, juros, multa, abatimento e descontoobjectSim
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 pagadorArrayNão

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)objectSim
statusApresenta o status da cobrança, conforme tabela Status da CobrançastringNão
txIdIdentificador único que permite ao recebedor identificar a cobrançastringNão
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
locationLocalização do payload a ser informado na criação da cobrançastringSim
devedorApresenta dados da pessoa física ou jurídica a quem a cobrança será endereçadaobjectNão
valorApresenta os valores da cobrança, são eles: valor original, juros, multa, abatimento e descontoobjectNão
chaveChave PIX utilizada na 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

Cobrança - Revisar

Cobrança - Criar por Id da transação

Funcionalidade permite gerar uma cobrança para pagamento imediato.

Solicitamos os campos:

CampoDescriçãoFormatoObrigatório
txIdIdentificador único que permite ao recebedor identificar a cobrançastringSim
calendarioSolicita a data de vencimento e a data de validade após o vencimento (esta última é opcional)objectSim
devedorSolicita dados da pessoa física ou jurídica a quem a cobrança será endereçada. Não necessariamente é o pagador finalobjectSim
valorSolicita os valores da cobrança, são eles: valor original, juros, multa, abatimento e descontoobjectSim
chaveChave PIX para geração da cobrançastringSim
solicitacaoPagadorSolicita mensagem destinada ao pagador (limitado a 140 caracteres)stringNão
infoAdicionaisCada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagadorArrayNão

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 único que permite ao recebedor identificar a 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
locationLocalização do payload a ser informado na criação da cobrançastringSim
devedorApresenta dados da pessoa física ou jurídica a quem a cobrança será endereçadaobjectNão
valorApresenta os valores da cobrança, são eles: valor original, juros, multa, abatimento e descontoobjectNão
chaveChave PIX utilizada na geração da cobrançastringSim
solicitacaoPagadorMensagem destinada ao pagador (limitado a 140 caracteres)stringSim
infoAdicionaisCada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagadorArraySim

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:

CampoDescriçãoFormatoObrigatório
txIdIdentificador único que permite ao recebedor identificar a 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

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 único que permite ao recebedor identificar a cobrançastringSim
locationLocalização do payload a ser informado na criaçã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
devedorApresenta dados da pessoa física ou jurídica a quem a cobrança será endereçadaobjectNão
valorApresenta os valores da cobrança, são eles: valor original, juros, multa, abatimento e descontoobjectNão
chaveChave PIX utilizada na geração da cobrançastringSim
solicitacaoPagadorApresenta o texto a ser apresentado ao pagador, caso tenha sido definidostringSim
infoAdicionaisMensagem destinada ao pagador (limitado a 140 caracteres)ArraySim
pixCada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagadorArraySim

Cobrança - Consultar por TxId

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:

CampoDescriçãoFormatoObrigatório
InicioInício do período desejado de pesquisastringSim
FimFim do período desejado de pesquisastringSim
CPFCPF do pagador caso deseje filtrar pelo documento, não pode ser utilizado com o campo CNPJstringNão
CNPJCNPJ do pagador caso deseje filtrar pelo documento, não pode ser utilizado com o campo CPFstringNão
StatusStatus da cobrança, conforme tabela Status da Cobrança stringSim

Resposta:

CampoDescriçãoFormatoNullable
inicioData inicial informadaobjectNão
fimData final informadastringNão
cpfCPF do pagadorstringSim
cnpjCPF do pagadorstringSim
calendarioData de criação da cobrança, data de vencimento e data de validade após o vencimento (caso informada)objectNão
statusStatus da cobrança, conforme tabela Status da Cobrança stringNão
txIdIdentificador único que permite ao recebedor identificar a 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
locationLocalização do payload a ser informado na criação da cobrançastringSim
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 utilizada na geração da cobrançastringSim
solicitacaoPagadorMensagem destinada ao pagador (limitado a 140 caracteres)stringSim
pixCada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagadorArraySim

Cobrança - Consultar lista de cobranças