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:

Campo	Descrição	Formato	Obrigatório
Inicio	Início do período desejado de pesquisa	date-time	Sim
Fim	Fim do período desejado de pesquisa	date-time	Sim
TxId	Identificador da transação de cobrança	string	Não

Resposta:

Campo	Descrição	Formato	Nullablle
endToEndId	Identificador da transação Pix	string	Sim
recebimentoId	Identificador do recebimento gerado pelo Banco BS2	integer	Não
txId	Identificador da transação da cobrança	string	Sim
data	Data do recebimento	string	Não
valor	Valor da transação Pix	number	Nao
status	Status do recebimento, que podem ser: Efetivado, Rejeitado, Validado e Confirmado	string	Não
pagador	Dados do pagador do Pix (banco, agência, conta, documento)	object	Sim
recebedor	Dados do recebedor do Pix (banco, agência, conta, documento)	object	Sim
chaveDict	Chave DICT do recebedor	string	Sim
campoLivre	Mensagem informada pelo pagador ao recebedor, se desejar	string	Sim
situacao	Situação da transação Pix, que podem ser: ACCC (transação efetivada), ACSP (status transitório de recebimento) e RJCT (transação rejeitada)	string	Não
devolucoes	Informações de devolução, se houve alguma associado ao recebimento	Array	Sim

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

Solicitamos os campos:

Campo	Descrição	Formato	Obrigatório
endToEndId	Identificador da transação Pix	string	Sim
Inicio	Início do período desejado de pesquisa	date-time	Não
Fim	Fim do período desejado de pesquisa	date-time	Não
TxId	Identificador da transação da cobrança	string	Não

Resposta:

Campo	Descrição	Formato	Nullablle
endToEndId	Identificador da transação Pix	string	Sim
recebimentoId	Identificador do recebimento	integer	Não
txId	Identificador da transação da cobrança	string	Sim
data	Data do recebimento	string	Não
valor	Valor da transação Pix	number	Nao
status	Status do recebimento, que podem ser: Efetivado, Rejeitado, Validado e Confirmado	string	Não
pagador	Dados do pagador do Pix (banco, agência, conta, documento)	object	Sim
recebedor	Dados do recebedor do Pix (banco, agência, conta, documento)	object	Sim
chaveDict	chave DICT do recebedor	string	Sim
campoLivre	Mensagem destinada ao recebedor	string	Sim
situacao	Situação da transação PIX, que podem ser: ACCC (transação efetivada), ACSP (status transitório de recebimento) e RJCT (transação rejeitada)	string	Não
devolucoes	Informações de devolução, se houve alguma associado ao recebimento	Array	Sim

Funcionalidade permite recuperar um recebimento pelo identificador do recebimento.

Solicitamos o campo:

Campo	Descrição	Formato	Obrigatório
recebimentoId	Identificador do recebimento	integer	Sim

Resposta:

Campo	Descrição	Formato	Nullablle
endToEndId	Identificador da transação Pix	string	Sim
recebimentoId	Identificador do recebimento	integer	Não
txId	Identificador da transação da cobrança	string	Sim
data	Data do recebimento	string	Não
valor	Valor da transação Pix	number	Nao
status	Status do recebimento, que podem ser: Efetivado, Rejeitado, Validado e Confirmado	string	Não
pagador	Dados do pagador do Pix (banco, agência, conta, documento)	object	Sim
recebedor	Dados do recebedor do Pix (banco, agência, conta, documento)	object	Sim
chaveDict	chave DICT do recebedor	string	Sim
campoLivre	Mensagem destinada ao recebedor	string	Sim
situacao	Situação da transação PIX, que podem ser: ACCC (transação efetivada), ACSP (status transitório de recebimento) e RJCT (transação rejeitada)	string	Não
devolucoes	Informações de devolução, se houve alguma associado ao recebimento	Array	Sim

Funcionalidade permite recuperar um recebimento pelo identificador do QR CODE.

Solicitamos o campo:

Campo	Descrição	Formato	Obrigatório
qrCodeId	Identificador do QR CODE	integer	Sim

Resposta:

Campo	Descrição	Formato	Nullablle
id	Identificador do recebimento	integer	Não
identificadorTransacao	Identificador da transação da cobrança	string	Sim
data	Data do recebimento	date-time	Não
valor	Valor da transação Pix	number	Nao
status	Status do recebimento, que podem ser: Efetivado, Rejeitado, Validado e Confirmado	string	Não
pagadorConta	Dados bancários do pagador do Pix	object	Sim
pagadorDocumento	Dados do pagador do PIX (documento, nome, nome fantasia)	object	Sim
recebedorConta	Dados bancários do recebedor do Pix	object	Sim
recebedorDocumento	Dados do recebedor do Pix (documento, nome, nome fantasia)	object	Sim
chaveDict	Chave DICT do recebedor	string	Sim
msgId	Mensagem informada no QR CODE para o pagador	object	Sim
endToEndId	Identificador da transação Pix	string	Sim
campoLivre	Mensagem destinada ao recebedor	object	Sim
msgId2	Mensagem informada no QR CODE para o pagador	object	Sim
originalId	Identificador da transação Pix	string	Sim
endToEndId2	Identificador da transação Pix	object	Sim
situacao	Situação da transação Pix, que podem ser: ACCC (transação efetivada), ACSP (status transitório de recebimento) e RJCT (transação rejeitada)	string	Não
devolucoes	Informações de devolução, se houve alguma associado ao recebimento	Array	Sim