Extrato da Agenda Stone

Endpoint

GET https://conciliation.stone.com.br/v2/merchant/{affiliationCode}/conciliation-file/{referenceDate}

Path params

Nome	Obrigatório	Tipo	Descrição
`affiliationCode`	sim	string
`referenceDate`	sim	string	AAAAMMDD

Query params

Nome	Obrigatório	Tipo	Descrição
`layout`	não	string	(padrão: `XML2_2`)

Headers

Nome	Obrigatório	Tipo	Descrição
`Accept-Encoding`	não	string	Arquivo é sempre retornado zipado (padrão: `gzip`)
`x-user-type`	não	string	Deve ser usado somente se você for cliente Stone, utilizando sua chave própria criada diretamente no portal
`Authorization`	sim	string	Deve ser passado o token JWT para caso de conciliadoras ou a chave própria se for cliente Stone no padrão Basic Auth.
`X-Accept-Redirect`	não	string	(padrão: `true`)

Disponibilização do arquivo

O pedido deve ser feito somente depois das 5:00 da manhã do dia seguinte ao qual dia você deseja conciliar

Abaixo estão os possíveis códigos de retorno e o descritivo de cada um.

StatusCode	Mensagem	Descrição
200	OK	Sua requisição foi bem sucedida e o arquivo que foi buscado está transmitido no corpo da mensagem.
307	Redirect	Sua requisição foi bem sucedida e redirecionada para o arquivo já cacheado. Use o header Location na resposta para o acesso.
400	Bad Request	Você deve confirmar os parâmetros utilizados. Como exemplo: * Data de referência * AffiliationCode(StoneCode)
401	Unauthorized	Valores de autenticação incorretos.
403	Forbidden	Authorization Token não pertence ao documento associado ao Stonecode para o qual o arquivo está sendo solicitado.
404	Page Not Found	Significa erro na montagem da requisição. Normalmente causado pelo StoneCode com letras e datas maiores do que 8 posições ou contendo letras.
500	Internal Server Error	Significa erro na montagem da requisição. Normalmente causado pelo StoneCode com letras e datas maiores do que 8 posições ou contendo letras.
503	Service Unavailable	Quando o sistema da conciliação está com algum problema de funcionamento.
504	TimeOut	Significa que algum dos componentes chamados pela conciliação demorou para entregar o resultado.

Authorization: Conciliadoras

Como gerar seu token de acesso

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

Os layouts disponíveis no momento são o XML2_2 e XML2_4

Timeout

Cada requisição possui um tempo limite de 2 minutos.

Comprimindo o arquivo

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 gzip no cabeçalho da requisição.

Download do arquivo

Ao realizar o download, o arquivo vem nomeado como {stoneCode}-{dataReferencia}-XML2_2-without_reversals.xml (Se a versão for a 2.4, muda apenas a parte "XML2_4")

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

Próxima etapaExtrato da Agenda Stone (novo)