Consulta de transações D+0
Neste endpoint será possível que nossos parceiros realizem consultas das Transações Eletrônicas dos estabelecimentos que possuem acesso, a partir de um período que será passado como parâmetro na requisição. O intervalo máximo que pode ser solicitado é de 7 dias e caso a data final solicitada seja o dia corrente, só é possível solicitar horário 10 minutos anterior a hora atual.
É retornado todas as transações autorizadas e canceladas de transações no período solicitado.
Como parâmetros obrigatórios temos a data de início(startDate), data final(endDate) e o CPF/CNPJ(merchant) 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.
Como parâmetros opcionais, podem ser passados o número da página(page) desejada e o número de registros por página(size).
GET
/reconciliation/v2/transactions?merchant={merchant}&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 e hora início do extrato
(YYYY-MM-DDTHH:mm)
endDate* string
Data e hora final do extrato
(YYYY-MM-DDTHH:mm)
page numérico
Página referência para ser retornada
size numérico
Quantidade de registros por página
EXEMPLO
https://api.paygo.com.br/reconciliation/v2/transactions?merchant=99999999999999&startDate=YYYY-MM-DDTHH:mm&endDate=YYYY-MM-DDTHH:mm&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 e hora inválidos: 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
Só é possível realizar a consulta com EndDate inferior a hora atual menos 10 minutos: Hora atual menos 10 minutos
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.
EXEMPLO DE SUCESSO
{
"search-date-time": {
"start-date": "2022-06-15T11:12",
"end-date": "2022-06-15T11:12"
},
"transactions": [
{
"id": "4a42456b-e8bc-2adf-96d0-61877d164e82",
"affiliation-merchant-id": "06.167.186/0001-54",
"merchant-affiliation-code": "000000000000001",
"amount": 11200,
"authorization-code": "100004",
"acquirer-reference": "200000004",
"acquirer-name": "rede",
"card-bin": "545731",
"card-holder-name": "ENRIQUE MOREIRA",
"brand-name": "ELO",
"card-number": "000000******4000",
"payment-type": "debit",
"installment-number": 1,
"financing-type": "single",
"local-reference": "753136",
"merchant-brand": "ESTABELECIMENTO DE TESTE",
"merchant-id": "46.993.945/0001-52",
"pos-data-identifier": "2255761",
"status": "authorized",
"transaction-type": "sale",
"updated-time": "2022-06-15T11:12:07",
"transaction-date": "2022-06-15T10:51:07",
"card-entry-mode": "Trilha Magnética",
"brand-label": "ELO DEBITO"
}
],
"page": 1,
"last-page": 2
}
Datalhamento
Updated over 1 year ago