Fluxo de recebimento de Pix

O fluxo de recebimento tem início com a chegada (IN1) ao Banco BS2 de uma mensagem PACS.008 (pagamento), encaminhada pelo SPI.

Validação do crédito pelo participante indireto

Sendo uma mensagem destinada ao participante indireto, o Banco BS2 solicitará, de modo síncrono, ao participante que valide o crédito (IN2) através da chamada de uma API desenvolvida pelo próprio participante indireto.

Caso o participante não responda a requisição dentro do limite de tempo definido, tentaremos reenviar a notificação. (Saiba mais em Webhooks para participantes indiretos).

⚠️

Importante:

O tempo hábil para responder à requisição de validação do recebimento é de até 300ms.

Persistindo o problema, o Banco BS2 retornará ao SPI o código de erro AB09 (Transação interrompida devido a erro no participante do usuário recebedor) e o recebimento não será efetivado.

Caso a transação seja validada e possa prosseguir, o participante deverá retornar o return code 200. Em caso de rejeição, retornar o 200, mas detalhando o motivo conforme a tabela de domínios SPI para rejeições de recebimentos.

Após o retorno da etapa IN2, o Banco BS2 criará a mensagem PACS.002 (validação) com a resposta recebida do participante indireto e a encaminhará para o SPI (IN4).

O SPI registrará a operação na conta PI dos participantes diretos e, em seguida, notificará a esses mesmos participantes diretos que a transação foi finalizada (OUT10 e IN5).

Crédito na conta Lastro do participante

No momento em que o Banco BS2 recebe a PACS.002 (confirmação), realizamos o crédito do valor na conta Lastro do participante indireto (IN6).

Notificação de Crédito

Nesta etapa o participante indireto é notificado do recebimento, através do WebHook cadastrado (IN7).

Acesse a página Webhooks para participantes indiretos para orientações de como cadastrar as notificações.

Créditos, integrações e avisos aos clientes finais

A partir deste ponto, caberá ao participante indireto realizar o crédito (IN8), notificação para o cliente final (IN9) e, se for o caso, realizar integrações com seus processos (IN10).

Consulta de recebimento

Nesta funcionalidade permitimos a consulta a recebimentos.

Solicitamos os campos:

CampoDescriçãoFormatoObrigatório
EndToEndIdIdentificador da transaçãostringSim, se TransactionId não for informado
TransactionIdCódigo usado para identificar o pagamento.stringSim, se EndToEndIdnão for informado

Resposta:

CampoDescriçãoFormatoNullable
EndToEndIdIdentificador da transaçãostringSim
TransactionIdCódigo usado para identificar o pagamentostringSim
valorValor do recebimentodoubleNão
solicitadoEmUtcData e hora em que o pagamento foi solicitado pelo pagadordate-timeNão
dataContabilData da contabilização da transação em UTC -3date-timeSim
recebedorDados do recebedor do Pix (banco, agência, conta, documento)objectNão
pagadorDados do pagador do Pix (banco, agência, conta, documento)objectNão
statusStatus do recebimento, conforme tabela Status recebimentostringNão
tipoIniciacaoTipo de iniciação utilizado no recebimento, conforme tabela Tipo de iniciaçãostringNão
motivoRejeicaoEm caso de rejeição da transação, este campo apresenta o código e motivo conforme retornado na PACS.002stringNão
erroDescricaoApresenta a descrição do erro, se tiver ocorrido erro no recebimentostringSim
chaveDictChave Pix utilizada no pagamento da transação PixstringSim
finalidadeFinalidade da transação, conforme tabela Finalidade TransaçãostringSim
prioridadeTransacaoPrioridade da transação, conforme tabela Prioridade TransaçãostringNão
tipoPrioridadeTransacaoTipo de prioridade da transação, conforme tabela Tipo Prioridade stringNão
valorSaqueOuTrocoValor do Saque ou troco, utilizado para finalidades de Pix Saque/TrocodoubleSim
ispbFacilitadorServicoSaqueOuTrocoISPB do facilitador do serviço de Saque ou TrocoSim
modalidadeAgenteTipo de modalidade do agente, conforme tabela Modalidade do AgentestringNão
campoLivreMensagem destinada ao recebedorstringSim
cnpjIniciadorPagamentoCNPJ da instituição iniciadora do pagamentostringSim

Obter recebimento