Tabela de conteúdos
Transferências PIX
Serão consideradas nas requisições de transferências PIX os documentos com modalidade de pagamento parametrizada como “PIX Transferência”:
Requisição
Na requisição (Request) de pagamentos de Transferências serão enviados:
- O número da Requisição
- Os dados bancários da empresa para débito
- O tipo de pagamento (126 - Pagamentos a Fornecedor)
- A lista dos documentos para realização das transferências, contendo:
- A data da transferência PIX
- O valor da Transferência PIX
- A descrição do pagamento, contendo o número, tipo e parcela do documento e o estabelecimento ao qual pertence
- A forma de identificação, que corresponde ao tipo de chave Pix utilizada: 1 - Telefone; 2 - Email; 3 - CPF/CNPJ; 4 - Chave Aleatória; 5 - Dados Bancários
- A chave pix (conteúdo)
- O código do banco no Banco Central (Número COMPE).
Resposta
Instantaneamente a API envia uma resposta (Response) contendo, além dos alguns dados enviados na requisição, informações como:
- o Estado da requisição: Código que identifica o estado da solicitação, que pode conter os seguintes status:
- Requisição com todos os lançamentos consistentes;
- Ao menos um lançamento inconsistente;
- Todos os lançamentos inconsistentes;
- Pendente de ação pelo Conveniado (falta autorizar);
- Em processamento pelo Banco;
- Processada;
- Rejeitada;
- Preparando remessa não liberada;
- Liberada via API;
- Preparando remessa liberada.
- Quantidade de Transferências
- Quantidade de Transferências Válidas
- Valor das Transferências
- Valor das Transferências Válidas
- Lista Response de Transferências Pix contendo, além das informações enviadas de cada documento:
- o Identificador do Pagamento (Número único gerado pelo Banco, utilizado para consultas posteriores)
- o Indicador de Aceite da transferência: “S” (Sim) ou “N” (Não). No caso de não aceito, carrega uma lista com as respectivas ocorrências.
//Informações técnicas:
- O identificador do pagamento é guardado na tabela de pagamento (PPAGAR) para realização das consultas posteriores.
- O envio da requisição também é guardado na tabela de movimentações do pagamento escritural (MOVPGESC)
- A URL, Request e Response da API também são guardados na tabela de integração (INTWSLOG).
//
Mensagens
Possíveis mensagens de Status das requisições retornadas pela API (Responses):
- 201 - CRIADO - A solicitação foi atendida e resultou em um novo recurso sendo criado.
- 400 - REQUISIÇÃO INVÁLIDA - O servidor não pôde processar a requisição devido a uma sintaxe de requisição malformada, estrutura da mensagem da requisição inválida, ou valores inválidos.
- 401 - NÃO AUTORIZADO. A requisição requer autenticação do usuário.
- 403 - PROIBIDO - A solicitação foi válida, mas o servidor está recusando a ação. O usuário pode não ter as permissões necessárias para um recurso ou pode precisar de uma conta de algum tipo.
- 404 - NÃO ENCONTRADO - O servidor não pode encontrar o recurso solicitado.
- 409 - CONFLITO - A solicitação não pôde ser concluída devido a um conflito com o estado atual do recurso.
- 500 - ERRO INTERNO - O servidor encontrou uma condição inesperada que o impediu de atender a requisição.



