Atenção
A partir do dia 16/01/2023, não será mais possível realizar a extração de arquivos de conciliação anteriores a 18 meses.
Antes de integrar a nossa solução, é necessário que você entenda o fluxo operacional para que sua integração possa ocorrer sem problemas.
Para conseguir acesso ao arquivo de Conciliação, é preciso seguir 3 passos:
- Solicitar as credenciais da API
- Solicitar concessão de acesso ao arquivo, para o estabelecimento
- Buscar o arquivo em nossa API
1. Solicitar as credenciais da API
As chaves para acesso aos arquivos de conciliação dos clientes são: ClientApplicationKey e a SecretKey.
Para solicitar as suas credenciais, preencha o formulário de Parcerias clicando aqui
Caso você seja um lojista informe a sua conciliadora para entrar em contato com nosso canal de Parcerias, por meio do link acima.
2. Solicitar concessão de acesso ao arquivo
Para que uma empresa terceira tenha acesso aos dados de conciliação de um lojista, é necessário que haja o consentimento deste. O consentimento pode ser obtido por meio de dois fluxos: Opt-in e Opt-out.
No fluxo Opt-in, a Conciliadora solicita o acesso ao arquivo do lojista por meio da nossa API. O lojista receberá um e-mail e poderá conceder ou recusar o pedido clicando nos links informados no texto do e-mail. Caso o lojista aceite o pedido, nossos sistemas irão registrar a concessão e enviar um e-mail informando que o acesso foi dado. A Conciliadora poderá consultar o status da concessão por meio da API, fazendo um GET em nossa API para verificar o status da solicitação.
O fluxo de concessão Opt-in com sucesso está ilustrado na imagem abaixo.
No fluxo Opt-out, a conciliadora assina um contrato de parceria que estabelece as responsabilidades de segurança da informação necessárias para realizar consultas sem a necessidade de pedir autorização por meio do sistema. Diferentemente do fluxo Opt-in, ao realizar o PUT, não será enviado um e-mail para o lojista aprovar.
O fluxo de concessão Opt-out está ilustrado na imagem abaixo.
Para mais informações, clique aqui.
3. Buscar o arquivo em nossa API
Disponibilidade do arquivo
Quando o arquivo está disponível
O pedido deve ser feito somente depois das 5:00 da manhã do dia seguinte ao qual dia você deseja conciliar
AffiliationCode ≠ AffiliationKey
O AffiliationCode nada mais é que o StoneCode do cliente.
Como comprimir o arquivo de conciliação?
Para acelerar a transferência de arquivos, você pode solicita-los em formato compactado. Para fazer isso, é necessário incluir a chave Accept-Encoding com o valor qzip no cabeçalho da requisição.
Comprimindo o arquivo
"Accept-Encoding: gzip"
Pontos Adicionais - Carteiras de Pagamento
Nossos pagamentos são feitos através da CIP e seguindo essas regras utilizamos o conceito de carteiras nos pagamentos dos nossos clientes, ou seja, os pagamentos são agrupados por bandeiras e produtos, reunindo todos os valores e efetuados de uma única vez dentro do grupo bandeira/produto.
As carterias são divididas da seguinte forma:
- Stone - Mastercard Débito - Saldo das transações Mastercard Débito
- Stone - Mastercard Crédito- Saldo das transações Mastercard Crédito
- Stone - Mastercard Antecipação- Saldo das transações Mastercard Antecipação
- Stone - Visa Débito - Saldo das transações Visa Débito
- Stone - Visa Crédito- Saldo das transações Visa Crédito
- Stone - Visa Antecipação- Saldo das transações Visa Antecipação
- Stone - Elo Débito- Saldo das transações Elo Débito
- Stone - Elo Crédito- Saldo das transações Elo Crédito
- Stone - Elo Antecipação- Saldo das transações Elo Antecipação
- Stone - Hiper Crédito- Saldo das transações Hiper Crédito
- Stone - Hiper Antecipação- Saldo das transações Hiper Antecipação
- Stone - Amex Crédito- Saldo das transações Amex Crédito
- Stone - Amex Antecipação- Saldo das transações Amex Antecipação
- Stone - Cabal Débito - Saldo das transações Cabal Débito
- Stone - Cabal Crédito- Saldo das transações Cabal Crédito
- Stone - Cabal Antecipação- Saldo das transações Cabal Antecipação
- Stone - UnionPay Débito - Saldo das transações UnionPay Débito
- Stone - UnionPay Crédito- Saldo das transações UnionPay Crédito
- Stone - UnionPay Antecipação- Saldo das transações UnionPay Antecipação
- Stone - Boleto - Saldo das transações via boleto
- Stone - Movimentos Não Transacionais- Saldo dos Movimentos Não Transacionais
Carteira com Saldo Negativo
Caso uma carteira fique com saldo negativo, o valor será descontado da carteira com maior saldo positivo.
Abaixo um exemplo dos recebíveis divididos em suas respectivas carteiras:
| Stone - Mastercard Débito | R$ 100,00 |
| Stone - Mastercard Crédito | R$ 50,00 |
| Stone - Visa Débito | R$ 150,00 |
| Stone - Visa Crédito | R$ 30,00 |
| TOTAL | R$ 330,00 |
Caso, em algum momento esse cliente receba um chargeback, há a possibilidade de uma carteira ficar negativa e automaticamente o valor será retirado da carteira com maior valor. Por exemplo, caso o cliente receba um chargeback de R$ 50,00 da bandeira Visa no produto Crédito o cenário seria o seguinte:
| Stone - Mastercard Débito | R$ 100,00 |
| Stone - Mastercard Crédito | R$ 50,00 |
| Stone - Visa Débito | R$ 130,00 |
| Stone - Visa Crédito | R$ 0,00 |
| TOTAL | R$ 280,00 |
Ou seja, o valor foi descontado sobre a carteira que sofreu o chargeback (Stone - Visa Crédito) e como ela ficou negativa em R$ 20,00, o valor foi descontado da carteira com maior saldo positivo (Stone - Visa Débito).
Também descontamos dos pagamentos do cliente o valor do aluguel do terminal que ele utiliza, isso e todos os ajustes financeiros sempre estarão descritos nos FinancialEvents e seguem a regra de descontar sempre da carteira com maior saldo positivo.