Consultar Transação

A sondagem de uma única transação permite verificar o seu status e resgatar os detalhes de uma transação. Esta sonda é necessária para confirmar os pagamentos de pedidos feitos com boletos, além de verificar a situação de um estorno solicitado anteriormente.

Para filtrar uma única transação deve-se usar o elemento <filterOptions/>, dentro da tag <request/>:

Consultar Transação – URLs Para Envio dos Dados

SANDBOX: https://testapi.maxipago.net/ReportsAPI/servlet/ReportsAPI

PRODUÇÃO: https://api.maxipago.net/ReportsAPI/servlet/ReportsAPI

Consultar Transação – Exemplo de Requisição (utilizando transactionID)

<?xml version="1.0" encoding="UTF-8"?>
<rapi-request>
    <verification>
        <merchantId>store-id</merchantId>
        <merchantKey>store-key</merchantKey>
    </verification>
    <command>transactionDetailReport</command>
    <request>
        <filterOptions>
            <transactionId>176890900</transactionId>
        </filterOptions>
    </request>
</rapi-request>

Consultar Transação – Exemplo de Retorno em Caso de Sucesso (utilizando transactionID)

<?xml version="1.0" encoding="UTF-8"?>
<rapi-response>
    <header>
        <errorCode>0</errorCode>
        <errorMsg/>
        <command>transactionDetailReport</command>
        <time>05-26-2017 10:40:03</time>
    </header>
    <result>
        <resultSetInfo>
            <totalNumberOfRecords>1</totalNumberOfRecords>
            <pageNumber>1</pageNumber>
        </resultSetInfo>
        <records>
            <record>
                <transactionId>176890900</transactionId>
                <referenceNumber>
                    <![CDATA[123456789]]>
                </referenceNumber>
                <transactionType>Sale</transactionType>
                <transactionAmount>1.00</transactionAmount>
                <taxAmount>0.00</taxAmount>
                <shippingAmount>0.00</shippingAmount>
                <transactionDate>05/26/2017 09:50:37 AM</transactionDate>
                <orderId>
                    <![CDATA[0A011599:015C44CF07A1:C036:70C0D3C1]]>
                </orderId>
                <splitPaymentOrderId/>
                <userId/>
                <customerId/>
                <companyName>
                    <![CDATA[maxiPago]]>
                </companyName>
                <responseCode>0</responseCode>
                <approvalCode>123456</approvalCode>
                <paymentType>(Hipercard) ...6688</paymentType>
                <bankRoutingNumber/>
                <achAccountNumber/>
                <avsResponseCode>YYY</avsResponseCode>
                <billingName>
                    <![CDATA[Fulano de Tal]]>
                </billingName>
                <billingAddress1>
                    <![CDATA[Av. Republica Brasil, 230]]>
                </billingAddress1>
                <billingAddress2>
                    <![CDATA[14 Andar]]>
                </billingAddress2>
                <billingCity>Sao Paulo</billingCity>
                <billingState>SP</billingState>
                <billingCountry>BR</billingCountry>
                <billingZip>01031170</billingZip>
                <billingPhone>1140099400</billingPhone>
                <billingEmail>
                    <![CDATA[fulanodetal@email.com]]>
                </billingEmail>
                <comments/>
                <transactionStatus>Approved</transactionStatus>
                <transactionState>3</transactionState>
                <recurringPaymentFlag/>
                <processorReturnedData/>
                <gatewayDebitNetworkID/>
                <creditCardType>HIPERCARD</creditCardType>
                <boletoUrl/>
                <boletoNumber/>
                <expirationDate/>
                <processorID>SIMULATOR</processorID>
                <dateOfPayment/>
                <dateOfFunding/>
                <bankOfPayment/>
                <branchOfPayment/>
                <paidAmount/>
                <bankFee/>
                <netAmount/>
                <returnCode>A</returnCode>
                <clearingCode/>
                <customField1/>
                <customField2/>
                <customField3/>
                <customField4/>
                <customField5/>
                <numberOfInstallments/>
                <chargeInterest/>
            </record>
        </records>
    </result>
</rapi-response>

Consultar Transação – Exemplo de Retorno Caso não Localize o Pedido (utilizando transactionID)

<?xml version="1.0" encoding="UTF-8"?>
<rapi-response>
    <header>
        <errorCode>0</errorCode>
        <errorMsg/>
        <command>transactionDetailReport</command>
        <time>05-26-2017 10:40:03</time>
    </header>
    <result>
        <resultSetInfo>
            <totalNumberOfRecords>0</totalNumberOfRecords>
            <pageNumber>1</pageNumber>
        </resultSetInfo>
        <records/>
    </result>
</rapi-response>

Consultar Transação por Código de Referência (ReferenceNum) – Exemplo de Requisição

<?xml version="1.0" encoding="UTF-8"?>
<rapi-request>
	<verification>
		<merchantId>store-id</merchantId>
		<merchantKey>store-key</merchantKey>
	</verification>
	<command>transactionDetailReport</command>
	<request>
		<filterOptions>
			<period>today</period>
			<referenceNum>112346</referenceNum>
		</filterOptions>
	</request>
</rapi-request>

Consultar Transação por Código de Referência (ReferenceNum) – Exemplo de Retorno em caso de Transação Aprovada com Sucesso

<?xml version="1.0" encoding="UTF-8"?>
<rapi-response>
	<header>
		<errorCode>0</errorCode>
		<errorMsg/>
		<command>transactionDetailReport</command>
		<time>12-06-2022 09:58:11</time>
	</header>
	<result>
		<resultSetInfo>
			<totalNumberOfRecords>2</totalNumberOfRecords>
			<pageToken>temp215-50-1670331491298.1</pageToken>
			<pageNumber>1</pageNumber>
			<numberOfPages>1</numberOfPages>
		</resultSetInfo>
		<records>
			<record>
				<transactionId>463763025</transactionId>
				<referenceNumber>
					<![CDATA[112346]]>
				</referenceNumber>
				<transactionType>Capture</transactionType>
				<transactionAmount>50.00</transactionAmount>
				<shippingAmount>0.00</shippingAmount>
				<transactionDate>08/16/2022 06:33:53 PM</transactionDate>
				<orderId>
					<![CDATA[0A0115E9:0182A893360F:1444:69354304]]>
				</orderId>
				<splitPaymentOrderId/>
				<userId/>
				<customerId/>
				<companyName/>
				<responseCode>0</responseCode>
				<approvalCode>401313</approvalCode>
				<paymentType>(Visa) ...1111</paymentType>
				<bankRoutingNumber/>
				<achAccountNumber/>
				<avsResponseCode/>
				<billingName>
					<![CDATA[MaxiPago da Silva]]>
				</billingName>
				<billingAddress1/>
				<billingAddress2/>
				<billingCity/>
				<billingState/>
				<billingCountry/>
				<billingZip/>
				<billingPhone/>
				<billingEmail/>
				<comments/>
				<transactionStatus>Captured</transactionStatus>
				<transactionState>3</transactionState>
				<recurringPaymentFlag/>
				<processorReturnedData/>
				<gatewayDebitNetworkID/>
				<creditCardType>VISA</creditCardType>
				<boletoUrl/>
				<boletoNumber/>
				<expirationDate/>
				<processorID>REDE</processorID>
				<dateOfPayment/>
				<dateOfFunding/>
				<bankOfPayment/>
				<branchOfPayment/>
				<paidAmount/>
				<bankFee/>
				<netAmount/>
				<returnCode>00</returnCode>
				<clearingCode/>
				<customField1/>
				<customField2/>
				<customField3/>
				<customField4/>
				<customField5/>
				<numberOfInstallments>2</numberOfInstallments>
				<chargeInterest/>
				<processorTransactionID>11162208161830264814</processorTransactionID>
				<processorReferenceNumber>134535147</processorReferenceNumber>
				<brandCode>00</brandCode>
				<brandMessage>Success.</brandMessage>
				<brandTransactionID/>
			</record>
			<record>
				<transactionId>463762925</transactionId>
				<referenceNumber>
					<![CDATA[112346]]>
				</referenceNumber>
				<transactionType>Authorize</transactionType>
				<transactionAmount>50.00</transactionAmount>
				<shippingAmount>0.00</shippingAmount>
				<transactionDate>08/16/2022 06:33:16 PM</transactionDate>
				<orderId>
					<![CDATA[0A0115E9:0182A893360F:1444:69354304]]>
				</orderId>
				<splitPaymentOrderId/>
				<userId/>
				<customerId/>
				<companyName/>
				<responseCode>0</responseCode>
				<approvalCode>401313</approvalCode>
				<paymentType>(Visa) ...1111</paymentType>
				<bankRoutingNumber/>
				<achAccountNumber/>
				<avsResponseCode/>
				<billingName>
					<![CDATA[MaxiPago da Silva]]>
				</billingName>
				<billingAddress1/>
				<billingAddress2/>
				<billingCity/>
				<billingState/>
				<billingCountry/>
				<billingZip/>
				<billingPhone/>
				<billingEmail/>
				<comments/>
				<transactionStatus>Authorized</transactionStatus>
				<transactionState>6</transactionState>
				<recurringPaymentFlag/>
				<processorReturnedData/>
				<gatewayDebitNetworkID/>
				<creditCardType>VISA</creditCardType>
				<boletoUrl/>
				<boletoNumber/>
				<expirationDate/>
				<processorID>REDE</processorID>
				<dateOfPayment/>
				<dateOfFunding/>
				<bankOfPayment/>
				<branchOfPayment/>
				<paidAmount/>
				<bankFee/>
				<netAmount/>
				<returnCode>00</returnCode>
				<clearingCode/>
				<customField1/>
				<customField2/>
				<customField3/>
				<customField4/>
				<customField5/>
				<numberOfInstallments>2</numberOfInstallments>
				<chargeInterest>N</chargeInterest>
				<processorTransactionID>11162208161830444814</processorTransactionID>
				<processorReferenceNumber>384072611</processorReferenceNumber>
				<brandCode>00</brandCode>
				<brandMessage>Success.</brandMessage>
				<brandTransactionID>401313</brandTransactionID>
			</record>
		</records>
	</result>
</rapi-response>

Consultar Transação por Código de Referência (ReferenceNum) – Exemplo de Retorno em caso de Transação Não Aprovada

<?xml version="1.0" encoding="UTF-8"?>
<rapi-response>
	<header>
		<errorCode>0</errorCode>
		<errorMsg/>
		<command>transactionDetailReport</command>
		<time>08-31-2023 11:34:25</time>
	</header>
	<result>
		<resultSetInfo>
			<totalNumberOfRecords>1</totalNumberOfRecords>
			<pageToken>temp153-10585-1693492465125.1</pageToken>
			<pageNumber>1</pageNumber>
			<numberOfPages>1</numberOfPages>
		</resultSetInfo>
		<records>
			<record>
				<transactionId>568943812</transactionId>
				<referenceNumber>
					<![CDATA[testconsultaref8]]>
				</referenceNumber>
				<transactionType>Sale</transactionType>
				<transactionAmount>1.07</transactionAmount>
				<shippingAmount>0.00</shippingAmount>
				<transactionDate>08/31/2023 11:34:10 AM</transactionDate>
				<orderId>
					<![CDATA[0A0115EB:018A4C041403:519F:7BEF9971]]>
				</orderId>
				<splitPaymentOrderId/>
				<userId/>
				<customerId/>
				<companyName/>
				<responseCode>1</responseCode>
				<approvalCode/>
				<paymentType>(Mastercard) ...1322</paymentType>
				<bankRoutingNumber/>
				<achAccountNumber/>
				<avsResponseCode>NNN</avsResponseCode>
				<billingName>
					<![CDATA[MaxiPago Gateway]]>
				</billingName>
				<billingAddress1/>
				<billingAddress2/>
				<billingCity/>
				<billingState/>
				<billingCountry/>
				<billingZip/>
				<billingPhone/>
				<billingEmail/>
				<comments/>
				<transactionStatus>Declined</transactionStatus>
				<transactionState>7</transactionState>
				<recurringPaymentFlag/>
				<processorReturnedData/>
				<gatewayDebitNetworkID/>
				<creditCardType>MASTERCARD</creditCardType>
				<boletoUrl/>
				<boletoNumber/>
				<expirationDate/>
				<processorID>SIMULATOR</processorID>
				<dateOfPayment/>
				<dateOfFunding/>
				<bankOfPayment/>
				<branchOfPayment/>
				<paidAmount/>
				<bankFee/>
				<netAmount/>
				<returnCode>D</returnCode>
				<clearingCode/>
				<customField1/>
				<customField2/>
				<customField3/>
				<customField4/>
				<customField5/>
				<numberOfInstallments>2</numberOfInstallments>
				<chargeInterest>N</chargeInterest>
				<processorTransactionID>753799</processorTransactionID>
				<processorReferenceNumber>954527</processorReferenceNumber>
				<brandCode>56</brandCode>
				<brandMessage>BRAND MESSAGE</brandMessage>
				<brandTransactionID/>
				<brandMac/>
			</record>
		</records>
	</result>
</rapi-response>

Consultar Transação por Código de Referência – Exemplo de Retorno em caso do ReferenceNum não encontrado

<?xml version="1.0" encoding="UTF-8"?>
<rapi-response>
	<header>
		<errorCode>0</errorCode>
		<errorMsg/>
		<command>transactionDetailReport</command>
		<time>08-06-2022 10:03:06</time>
	</header>
	<result>
		<resultSetInfo>
			<totalNumberOfRecords>0</totalNumberOfRecords>
			<pageNumber>1</pageNumber>
		</resultSetInfo>
		<records/>
	</result>
</rapi-response>

O elemento contém as informações da requisição de consulta, com os seguintes campos:

Já o elemento <resultSetInfo/> traz o total de registros encontrados e os dados do sistema de paginação:

O elemento contém os detalhes das transações individuais. Nem todos os campos são sempre retornados: