Consulta por Período do EDI
Neste endpoint será possível que nossos parceiros realizem consultas dos Extratos Eletrônicos dos estabelecimentos que possuem acesso a partir de um período que será passado como parâmetro na requisição.
É retornado todos os dados de transações, liquidações, chargebacks, cancelamentos e ajustes referente ao período solicitado.
Como parâmetros obrigatórios temos a data de início, data final e o CPF/CNPJ do estabelecimento comercial que o parceiro deseja o extrato, além disso no Header da requisição é obrigatório que seja passado o “access_token” obtido no endpoint de Login. E como parâmetro opcional, pode ser passado o número da página(page) que deseja que seja retornado, e a quantidade de registros por página(size).
GET
/reconciliation/c6pay/edi/{version}/merchants/{merchant}/period?startDate={startDate}&endDate={endDate}&page={page}&size={size}
HEADERS
Authorization* string
Bearer {{Access-Token}}
PATH PARAMS
merchant* string
CPF/CNPJ do estabelecimento comercial que deseja buscar o extrato
(99999999999 / 99999999999999)
REQUEST PARAMS
startDate* string
Data início do extrato
(YYYY-MM-DD)
endDate* string
Data final do extrato
(YYYY-MM-DD)
page numérico
Página referência para ser retornada
size numérico
Quantidade de registros retornados por página
EXEMPLO
https://api.paygo.com.br/reconciliation/c6pay/edi/v2/merchants/99999999999999/period?startDate=YYYY-MM-DD&endDate=YYYY-MM-DD&page=1&size=5
RETORNOS
Abaixo estão os possíveis códigos de retorno e o descritivo de cada um:
200 - OK
Significa que sua requisição foi bem-sucedida e os dados do Extrato Eletrônico serão retornados no corpo da resposta.
400 - Erro ao consultar o EDI
Data inválida: O formato da data informada na URL está no formato inválido.
CPF/CNPJ inválido: O formato do CPF/CNPJ informado na URL está no formato inválido.
Intervalo de dias superior a 7: Período informado na URL superior ao máximo permitido
401 - Autorização não é válida
Significa que não está autenticado em nossa API e/ou não foi passado o Access Token
404 - Não existem transações na data informada
Dados não encontrados para os parâmetros informados ou o cliente não possui extrato eletrônico para este dia.
EXEMPLOS DE SUCESSO
Temos dois retornos possíveis a partir do parâmetro que foi passado na URL da requisição:
Updated over 1 year ago