Split de Pagamentos - Extrato Eletrônico

Redirecionando para https://docs.cielo.com.br/split/docs/extrato-eletronico ...

As documentações do Split de Pagamentos estão em um novo portal

Acesse o novo portal de desenvolvedores E-commerce docs.cielo.com.br/split/docs/extrato-eletronico.

Atenção: O conteúdo desta página está sendo descontinuado e não receberá atualizações a partir de 14/08/2024. Visite a nova documentação em docs.cielo.br.

Introdução ao Extrato Eletrônico

O Extrato Eletrônico é um produto disponibilizado aos clientes que necessitam de automatização no processo de conciliação. Nele, as informações são transmitidas de forma padronizada sem intervenção, proporcionando agilidade e segurança no tráfego das informações.

Os principais benefícios deste produto são:

• Realização da conciliação contábil e financeira de forma automatizada;
• Maior agilidade e eficiência operacional;
• Integração com a automação comercial de vendas;
• Segurança no recebimento das informações;
• Atendimento especializado.

Ambientes

Sandbox

Produção

Autenticação

Durante o onboarding, você receberá as credenciais ClientId e ClientSecret. Caso não tenha recebido a credencial, solicite ao Suporte Braspag.

1. Concatene as credenciais no formato ClientId:ClientSecret;
2. Converta o resultado em base 64, gerando uma string;

Exemplo:

• client_id: braspagtestes
  
• client_secret: 1q2w3e4r5t6y7u8i9o0p0q9w8e7r6t5y4u3i2o1p
  
• String a ser codificada em Base64: braspagtestes:1q2w3e4r5t6y7u8i9o0p0q9w8e7r6t5y4u3i2o1p
  
• Resultado após a codificação: YnJhc3BhZ3Rlc3RlczoxcTJ3M2U0cg==
  

3. Envie a string em base 64 na requisição de Autenticação (POST);
4. A API de Autenticação irá validar a string e retornará o access_token (token de acesso).

O token retornado (access_token) deverá ser utilizado em toda requisição à API do Split como uma chave de autorização. O access_token possui uma validade de 20 minutos e é necessário gerar um novo toda vez que a validade expirar.

Requisição

Parâmetros no Cabeçalho (header)

Parâmetros no Corpo (body)

Resposta

{
  "access_token": "faSYkjfiod8ddJxFTU3vti_ ... _xD0i0jqcw",
  "token_type": "bearer",
  "expires_in": 599
}

Parâmetros no corpo (body)

Obtendo arquivos de Extrato Eletrônico

Para obter os arquivos de Extrato Eletrônico, faça a seguinte requisição:

Requisição

Parâmetros da requisição

*Se o campo Date não for preenchido, o endpoint retornará o último arquivo gerado para o número de documento informado.
**Extrato seller não está disponível para consumo.

Parâmetros no cabeçalho (header)

Tipos de arquivos

Arquivo de Previsão

Com o Arquivo de Previsão você consegue conferir se todas as vendas realizadas foram recebidas e as previsões de pagamento geradas, com as seguintes informações:

• As vendas concluídas (capturadas) no dia anterior, ajustes, cancelamentos, chargebacks com agenda de previsão de pagamento;
• Todo o plano parcelado da venda realizada no dia anterior;
• Como a transação foi dividida no Split das Transações.

Arquivo de Liquidação

Com o Arquivo de Liquidação você consegue conferir a origem do pagamento recebido, com as seguintes informações:

• Informações de liquidação de D-1;
• Efeitos de contrato liquidados.

Layout dos Arquivos

O layout dos Arquivos segue o seguinte padrão:

Layout do Arquivo de Previsão

Registro 0 - Cabeçalho

Identifica o cabeçalho do Arquivo de Previsão:

*Não obrigatórios, poderão vir vazios na ausência de movimento no dia.

Registro 1 - Estabelecimento

Identifica os dados do estabelecimento:

Registro 2 - Eventos Transacionais

Identifica os eventos transacionais:

*Não obrigatórios.

Registro 3 - Participantes do Evento Transacional

Identifica os participantes (Master e Sellers) do Evento Transacional:

*Não obrigatórios.

Registro 4 - Agenda Financeira

Registro 9 - Rodapé

Layout do Arquivo de Liquidação

Registro 0 - Cabeçalho

Identifica o cabeçalho do Arquivo de Liquidação:

*Não obrigatórios, poderão vir vazios na ausência de movimento no dia.

Registro 1 - Recebível

Identifica o recebível e sua liquidação:

Registro 2 - Grupos de Pagamento

Identifica detalhes da liquidação do recebível:

*Obrigatórios se o tipo de liquidação for diferente de troca de titularidade.
**Obrigatório se o tipo de liquidação for troca de titularidade.
***Obrigatório se o tipo de liquidação for diferente de Braspag.

Registro 3 - Agenda Financeira/Evento Transacional

Identifica os lançamentos na agenda financeira com base no eventro transacional:

Registro 4 - Balanceamento de Saldo

Registro 5 - Balanceamento de Saldo por Estabelecimento

Registro 9 - Rodapé

Tabelas Adicionais

Tabela I - Tipos de Estabelecimento

Tabela II - Eventos Transacionais

Tabela III - Produtos

Tabela IV - Bandeiras

Tabela V - Meios de Captura

Tabela VI - Eventos Financeiros

Tabela VII - Ajustes Financeiros

Tabela VIII - Tipos de Liquidação

Tabela IX - Tipos de Contas

Tabela X - Status da Liquidação