Recebimento

Nesta seção, disponibilizamos operações que permitem o acompanhamento dos recebimentos na conta do cliente.

Consulta de recebimento por parâmetros

Funcionalidade permite recuperar os recebimentos no período especificado, podendo informar o TxId da transação para uma consulta específica.

Solicitamos os campos:

CampoDescriçãoFormatoObrigatório
InicioInício do período desejado de pesquisadate-timeSim
FimFim do período desejado de pesquisadate-timeSim
TxIdIdentificador da transação de cobrançastringNão

Resposta:

CampoDescriçãoFormatoNullable
endToEndIdIdentificador da transação PixstringSim
recebimentoIdIdentificador do recebimento gerado pelo Banco BS2integerNão
txIdIdentificador da transação da cobrançastringSim
dataData do recebimentostringNão
valorValor da transação Pixnumber Nao
statusStatus do recebimento, conforme tabela Status recebimentostringNão
pagadorDados do pagador do Pix (banco, agência, conta, documento)objectSim
recebedorDados do recebedor do Pix (banco, agência, conta, documento)objectSim
chaveDictChave DICT do recebedorstringSim
campoLivreMensagem informada pelo pagador ao recebedor, se desejarstringSim
situacaoSituação da transação, conforme tabela Situação da transaçãostringNão
devolucoesInformações de devolução, se houve alguma associado ao recebimentoArraySim

Recebimento - Consultar por parâmetros

Consultar de recebimentos por EndToEndId

Funcionalidade permite recuperar um recebimento pelo EndToEndId que é o identificador único de uma transação Pix.

Solicitamos os campos:

CampoDescriçãoFormatoObrigatório
endToEndIdIdentificador da transação PixstringSim
InicioInício do período desejado de pesquisadate-timeNão
FimFim do período desejado de pesquisadate-timeNão
TxIdIdentificador da transação da cobrançastringNão

Resposta:

CampoDescriçãoFormatoNullable
endToEndIdIdentificador da transação PixstringSim
recebimentoIdIdentificador do recebimentointegerNão
txIdIdentificador da transação da cobrançastringSim
dataData do recebimentostringNão
valorValor da transação Pixnumber Nao
statusStatus do recebimento, conforme tabela Status recebimentostringNão
pagadorDados do pagador do Pix (banco, agência, conta, documento)objectSim
recebedorDados do recebedor do Pix (banco, agência, conta, documento)objectSim
chaveDictchave DICT do recebedorstringSim
campoLivreMensagem destinada ao recebedorstringSim
situacaoStatus do recebimento, conforme tabela Status recebimentostringNão
devolucoesInformações de devolução, se houve alguma associado ao recebimentoArraySim

Recebimento - Consultar por EndToEndId

Consulta de recebimentos por RecebimentoId

Funcionalidade permite recuperar um recebimento pelo identificador do recebimento.

Solicitamos o campo:

CampoDescriçãoFormatoObrigatório
recebimentoIdIdentificador do recebimentointegerSim

Resposta:

CampoDescriçãoFormatoNullable
endToEndIdIdentificador da transação PixstringSim
recebimentoIdIdentificador do recebimentointegerNão
txIdIdentificador da transação da cobrançastringSim
dataData do recebimentostringNão
valorValor da transação Pixnumber Nao
statusStatus do recebimento, conforme tabela Status recebimentostringNão
pagadorDados do pagador do Pix (banco, agência, conta, documento)objectSim
recebedorDados do recebedor do Pix (banco, agência, conta, documento)objectSim
chaveDictchave DICT do recebedorstringSim
campoLivreMensagem destinada ao recebedorstringSim
situacaoStatus do recebimento, conforme tabela Status recebimentostringNão
devolucoesInformações de devolução, se houve alguma associado ao recebimentoArraySim

Recebimento - Consultar por RecebimentoId

Consulta de recebimentos por QrCodeId

Funcionalidade permite recuperar um recebimento pelo identificador do QR CODE.

Solicitamos o campo:

CampoDescriçãoFormatoObrigatório
qrCodeIdIdentificador do QR CODEintegerSim

Resposta:

CampoDescriçãoFormatoNullable
idIdentificador do recebimentointegerNão
identificadorTransacaoIdentificador da transação da cobrançastringSim
dataData do recebimentodate-timeNão
valorValor da transação Pixnumber Nao
statusStatus do recebimento, conforme tabela Status recebimentostringNão
pagadorContaDados bancários do pagador do PixobjectSim
pagadorDocumentoDados do pagador do PIX (documento, nome, nome fantasia)objectSim
recebedorContaDados bancários do recebedor do PixobjectSim
recebedorDocumentoDados do recebedor do Pix (documento, nome, nome fantasia)objectSim
chaveDictChave DICT do recebedorstringSim
msgIdMensagem informada no QR CODE para o pagadorobjectSim
endToEndIdIdentificador da transação PixstringSim
campoLivreMensagem destinada ao recebedorobjectSim
msgId2Mensagem informada no QR CODE para o pagadorobjectSim
originalIdIdentificador da transação PixstringSim
endToEndId2Identificador da transação PixobjectSim
situacaoStatus do recebimento, conforme tabela Status recebimentostringNão
devolucoesInformações de devolução, se houve alguma associado ao recebimentoArraySim

Recebimento - Consultar por QrCodeId