PIX - Solicitação de Arquivo

Endpoint

POST https://conciliation.stone.com.br/v2/merchant/{document}/conciliation-file/pix/{referenceDate}

Path params

NomeObrigatórioTipoDescrição
documentsimstring
referenceDatesimstringAAAA-MM-DD

Headers

NomeObrigatórioTipoDescrição
x-user-typenãostringDeve ser usado somente se você for cliente Stone, utilizando sua chave própria criada diretamente no portal (padrão: client)
Content-Typesimstring(padrão: application/json)
acceptnãostring

Por meio deste endpoint, é possível solicitar o arquivo de conciliação PIX para um determinado documento e data de referência.

O processamento ocorre de forma assíncrona: ao realizar a requisição, o endpoint retornará imediatamente uma resposta HTTP 202, indicando que a solicitação foi recebida e está sendo processada. O arquivo em si não estará disponível neste momento.

Authorization: Conciliadoras
Authorization: Cliente Stone

Para se autenticar conosco você deve enviar a Chave de API no cabeçalho Authorization, seguindo o padrão da HTTP Basic Authentication.

Para montar a requisição Basic Auth, você deve utilizar sua Chave Secreta da seguinte maneira: User: chave Password: vazio

Disponibilização do arquivo

O pedido deve ser feito somente depois das 3:00 da manhã do dia seguinte ao qual dia você deseja conciliar. O arquivo pode ser enviado em até 30 minutos.

Mesmo que não existam movimentações no dia solicitado, é enviado o link de um arquivo vazio, apenas com cabeçalho preenchido.

Temos um exemplo de estrutura do arquivo aqui.

Download do arquivo

Ao realizar o download, o arquivo vem nomeado como {documento}-{dataReferencia}.csv

Em caso de dúvidas, sobre o formato da notificação por webhook, confira esta página.


Jornada: Baixar o arquivo de conciliação
Etapa 5 de 10