Comunidade de Desenvolvedores maxiPago!

Consultas

 

A API de consulta e relatórios permite que o estabelecimento extraia do banco de dados da maxiPago! as informações detalhadas de qualquer transação. É permitido resgatar os detalhes de apenas uma transação ou receber uma relação de transações, filtradas por período.

O XML de resposta trará no máximo 100 transações, a fim de não tornar a resposta muito pesada. Caso a lista de transações filtradas seja maior, será utilizado um mecanismo de paginação, detalhado mais abaixo.

A estrutura do XML é similar às requisições de Cadastro e possui <rapi-request/> como nó-raíz.
O XML contém a verificação das credenciais no elemento <verification/>; a ação a ser executada na tag <command/>; e os dados para filtragem dentro do nó <request/>. Não há versão de API.

 

Autorização – URLs Para Envio dos Dados

 

SANDBOX: https://testapi.maxipago.net/UniversalAPI/postXML

PRODUÇÃO: https://api.maxipago.net/UniversalAPI/postXML

 

Os comandos disponíveis são:

 

  • transactionDetailReport: resgata todos os detalhes das transações filtradas.

  • checkRequestStatusCommand: verifica o resultado de uma pesquisa em massa.

 

A estrutura básica do XML fica da seguinte forma:




<rapi-request>
	<verification>
		<merchantId>store-id</merchantId>
		<merchantKey>secret-key</merchantKey>
	</verification>
	<request>...</request>
</rapi-request>