Comunidade de Desenvolvedores maxiPago!

Criar Link de Pagamento

Com a API Checkout 2.0 integrada em seu sistema, será possível: criar, editar, cancelar e consultar um Link de Pagamento.

A maxipago disponibiliza 2 tipos de Link de Pagamento:

Link de Pagamento Rápido: URL para pagamento sem necessidade de autenticação do consumidor

Link de Pagamento com Autenticação: URL para pagamento que exige autenticação do consumidor por meio de login e senha enviados por e-mail. Atualmente o modelo com autenticação é o único que suporta antifraude

Link de Pagamento – URLs Para Envio dos Dados

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

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

Link de Pagamento – Criação de Ordem de Pagamento com Autenticação

Abaixo segue um exemplo de XML para a geração de um Link de Pagamento com Autenticação; nessa modalidade, o consumidor receberá um login e senha para se logar em ambiente exclusivo da maxiPago! para concluir o pagamento do Link. Segue exemplo abaixo:

<?xml version="1.0" encoding="UTF-8"?>
<api-request>
    <verification>
        <merchantId>store-id</merchantId>
        <merchantKey>store-key</merchantKey>
    </verification>
    <command>add-payment-order</command>
    <request>
        <referenceNum>2009171040</referenceNum>
        <fraudCheck>Y</fraudCheck>
        <billing>
            <address>Avenida Paulista 123</address>
            <address2>1 Andar</address2>
            <district>Centro</district>
            <city>Sao Paulo</city>
            <state>SP</state>
            <postalcode>01311000</postalcode>
            <country>BR</country>
            <email>teste.maxipay@mailinator.com</email>
            <customerIdExt>37568256634</customerIdExt>
            <firstName>Teste</firstName>
            <lastName>Maxipay</lastName>
            <dob>01/30/1984</dob>
            <sex>M</sex>
            <phone>11922334455</phone>
        </billing>
        <transactionDetail>
            <description>Pagamento Parcela Do Carro</description>
            <comments>Pagar ate dia 30</comments>
            <emailSubject>Favor efetuar o pagamento</emailSubject>
            <expirationDate>06/17/2022</expirationDate>
            <payType>
                <creditCard>
                    <processorID>1</processorID>
                    <operation>sale</operation>
                    <numberOfInstallments>2</numberOfInstallments>
                    <currencyCode>BRL</currencyCode>
                    <amount>950.00</amount>
                </creditCard>
            </payType>
        </transactionDetail>
    </request>
</api-request>

Link de Pagamento – Criação de Link de Pagamento com Recorrência

<?xml version="1.0" encoding="UTF-8"?>
<api-request>
    <verification>
        <merchantId>store-id</merchantId>
        <merchantKey>store-key</merchantKey>
    </verification>
    <command>add-payment-order</command>
    <request>
        <referenceNum>2009171040</referenceNum>
        <fraudCheck>Y</fraudCheck>
        <billing>
            <address>Avenida Paulista 123</address>
            <address2>1 Andar</address2>
            <district>Centro</district>
            <city>Sao Paulo</city>
            <state>SP</state>
            <postalcode>01311000</postalcode>
            <country>BR</country>
            <email>teste.maxipay@mailinator.com</email>
            <customerIdExt>37568256634</customerIdExt>
            <firstName>Teste</firstName>
            <lastName>Maxipay</lastName>
            <dob>01/30/1984</dob>
            <sex>M</sex>
            <phone>11922334455</phone>
        </billing>
        <transactionDetail>
            <description>Pagamento Parcela Do Carro</description>
            <comments>Pagar ate dia 30</comments>
            <emailSubject>Favor efetuar o pagamento</emailSubject>
            <expirationDate>06/17/2022</expirationDate>
            <payType>
                <creditCard>
                    <processorID>1</processorID>
                    <operation>sale</operation>
                    <numberOfInstallments>2</numberOfInstallments>
                    <currencyCode>BRL</currencyCode>
                    <amount>950.00</amount>
                </creditCard>
            </payType>
        </transactionDetail>
        <recurring>
            <startDate>06/17/2022</startDate>
            <period>monthly</period>
            <numberOfInstallments>12</numberOfInstallments>
            <failureThreshold>3</failureThreshold>
            <amount>950.00</amount>
        </recurring>
    </request>
</api-request>

OBSERVAÇÃO:
O retorno de uma requisição de transação convencional e recorrência será o mesmo.

Link de Pagamento – Exemplo de Criação com Sucesso

<?xml version="1.0" encoding="UTF-8"?>
<api-response>
        <errorCode>0</errorCode>
        <errorMessage></errorMessage>
        <command>add-payment-order</command>
        <time>1505919057637</time>
        <result>
            <pay_order_id>FiaoEH3mOE8=</pay_order_id>
            <message>Inserted Successfully</message>
            <url>https://secure.maxipago.net/maxipay/</url>
        </result>
</api-response>
Importante: A URL gerada em um Link com Autenticação terá sempre sua estrutura inicial fixa; conforme exemplo: 

Estrutura fixa: https://secure.maxipago.com.net/maxipay

Link de Pagamento – Exemplo de Criação com Sucesso (Loja com skin cadastrada)

<?xml version="1.0" encoding="UTF-8" ?>
<api-response>
	<errorCode>0</errorCode>
	<errorMessage></errorMessage>
	<command>add-payment-order</command>
	<time>1610952514894</time>
	<result>
		<pay_order_id>ck3abl3</pay_order_id>
		<message>Inserted Successfully</message>
		<url>https://secure.maxipago.net/maxipay/lojateste</url>
	</result>
</api-response>




Importante: A URL gerada em um Link com Autenticação terá sempre sua  estrutura inicial fixa e o final sempre com o nome da loja. 

Conforme exemplo: Estrutura fixa: https://secure.maxipago.com.net/maxipay/

Identificação da URL: lojateste

O nome da loja é previamente configurado através do nosso Portal: https://portal.maxipago.net – Seguir os menus:

Admin > Link de Pagamento > Identidade Visual

Link de Pagamento – Exemplo de Criação com Erro

<?xml version="1.0" encoding="UTF-8"?>
<api-response>
        <errorCode>1</errorCode>
        <errorMessage>
            <![CDATA[Unable to authenticate merchant]]>
        </errorMessage>
        <time>1505919057637</time>
</api-response>
Importante: o erro reportado ficará descrito no parâmetro: <errorMessage>  

Criação de Link de Pagamento – Pagamento Rápido

Abaixo segue um exemplo de XML para a geração de um Link de Pagamento que será paga sem a necessidade de autenticação do seu cliente.

O request abaixo é o mais básico e com o mínimo de dados exigidos:

<api-request>
	<verification>
		<merchantId>xxxxxxx</merchantId>
		<merchantKey>xxxxxxxxxx</merchantKey>
	</verification>
	<command>add-payment-order</command>
	<request>
		<referenceNum>teste_mp</referenceNum>
		<transactionDetail>
			<description>Livro sobre maxiPago! com capa dura</description>
			<emailSubject>Pagamento livro maxiPago!</emailSubject>
			<expirationDate>06/17/2022</expirationDate>
			<payType>
				<creditCard>
					<processorID>1</processorID>
					<operation>auth</operation>
					<numberOfInstallments>1</numberOfInstallments>
					<amount>90.00</amount>
				</creditCard>
			</payType>
		</transactionDetail>
	</request>
</api-request>

Link de Pagamento – Exemplo de Criação com Sucesso

<?xml version="1.0" encoding="UTF-8" ?>
<api-response>
	<errorCode>0</errorCode>
	<errorMessage></errorMessage>
	<command>add-payment-order</command>
	<time>1610933314672</time>
	<result>
		<pay_order_id>ek2amm5</pay_order_id>
		<message>Inserted Successfully</message>
		<url>https://secure.maxipago.net/maxipay/#!/fp?p=ek2amm5</url>
	</result>
</api-response>
Importante: A URL gerada em um Link Rápido terá sempre sua estrutura inicial  fixa e o final sempre dinâmico. Conforme exemplo: 

Estrutura fixa: https://secure.maxipago.com.net/maxipay/#!/fp?p=

Identificação da URL: ek2amm5

Retorno da Requisição com Erro

<?xml version="1.0" encoding="UTF-8" ?>
<api-response>
	<errorCode>1</errorCode>
	<errorMessage>
		<![CDATA[Parser Error: URI=null Line=1: cvc-complex-type.2.4.b: The content of
element 'request' is not complete. referenceNum]]>
	</errorMessage>
	<time>1610934760420</time>
</api-response>
Importante: O erro reportado ficará descrito no parâmetro: <errorMessage>

Link de Pagamento com Recorrência – Link Rápido

Abaixo segue um exemplo de XML para a geração de um Link de Pagamento com cobranças Recorrentes, que será paga sem a necessidade de autenticação do seu cliente.

O request abaixo é o mais básico e com o mínimo de dados exigidos:

<?xml version="1.0" encoding="UTF-8"?>
<api-request>
	<verification>
		<merchantId>xxxxxxx</merchantId>
		<merchantKey>xxxxxxxxxxx</merchantKey>
	</verification>
	<command>add-payment-order</command>
	<request>
		<referenceNum>mpteste00</referenceNum>
		<transactionDetail>
			<description>Livro sobre maxiPago! com capa dura</description>
			<emailSubject>Pagamento livro maxiPago!</emailSubject>
			<expirationDate>06/17/2022</expirationDate>
			<payType>
				<creditCard>
					<processorID>1</processorID>
					<operation>auth</operation>
					<numberOfInstallments>1</numberOfInstallments>
					<amount>500.00</amount>
				</creditCard>
			</payType>
		</transactionDetail>
		<recurring>
			<startDate>01/20/2021</startDate>
			<period>monthly</period>
			<numberOfInstallments>10</numberOfInstallments>
			<failureThreshold>5</failureThreshold>
			<amount>200.00</amount>
		</recurring>
	</request>
</api-request>

Retorno da Requisição com Sucesso para criação de Pagamento Recorrente – Link Rápido

<?xml version="1.0" encoding="UTF-8" ?>
<api-response>
	<errorCode>0</errorCode>
	<errorMessage></errorMessage>
	<command>add-payment-order</command>
	<time>1610959022997</time>
	<result>
		<pay_order_id>mkoru6</pay_order_id>
		<message>Inserted Successfully</message>
		<url>https://secure.maxipago.net/maxipay/#!/fp?p=mkoru6</url>
	</result>
</api-response>

Retorno da Requisição com Erro para criação de Pagamento Recorrente – Link Rápido

<?xml version="1.0" encoding="UTF-8" ?>
<api-response>
	<errorCode>1</errorCode>
	<errorMessage>
		<![CDATA[Unable to authenticate merchant]]>
	</errorMessage>
	<time>1610959454850</time>
</api-response>

Link de Pagamento com Recorrência – Link com Autenticação

Abaixo segue um exemplo de XML para a geração de um Link de Pagamento com cobranças Recorrentes, que será paga sem a necessidade de autenticação do seu cliente.

O request abaixo é o mais básico e com o mínimo de dados exigidos:

<api-request>
	<verification>
		<merchantId>xxxxxx</merchantId>
		<merchantKey>xxxxxxxxxxxxx</merchantKey>
	</verification>
	<command>add-payment-order</command>
	<request>
		<referenceNum>teste_mp</referenceNum>
		<billing>
			<firstName>maxi</firstName>
			<lastName>Pago</lastName>
			<customerIdExt>15776896070</customerIdExt>
			<email>maxipago@maxipago.com.br</email>
		</billing>
		<transactionDetail>
			<description>Livro sobre maxiPago! com capa dura</description>
			<emailSubject>Pagamento livro maxiPago!</emailSubject>
			<expirationDate>06/17/2022</expirationDate>
			<payType>
				<creditCard>
					<processorID>1</processorID>
					<operation>auth</operation>
					<numberOfInstallments>1</numberOfInstallments>
					<amount>60.00</amount>
				</creditCard>
			</payType>
		</transactionDetail>
		<recurring>
			<startDate>01/20/2021</startDate>
			<period>monthly</period>
			<numberOfInstallments>12</numberOfInstallments>
			<failureThreshold>5</failureThreshold>
			<amount>50.00</amount>
		</recurring>
	</request>
</api-request>

Retorno da Requisição com Sucesso para criação de Pagamento Recorrente – Link com Autenticação

<?xml version="1.0" encoding="UTF-8" ?>
<api-response>
	<errorCode>0</errorCode>
	<errorMessage></errorMessage>
	<command>add-payment-order</command>
	<time>1610959610256</time>
	<result>
		<pay_order_id>mvoru7</pay_order_id>
		<message>Inserted Successfully</message>
		<url>https://secure.maxipago.net/maxipay/lojateste</url>
	</result>
</api-response>

Retorno da Requisição com Erro para criação de Pagamento Recorrente –
Link com Autenticação

<?xml version="1.0" encoding="UTF-8" ?>
<api-response>
	<errorCode>1</errorCode>
	<errorMessage>
		<![CDATA[ A data de vencimento deve ser maior que a data atual.]]>
	</errorMessage>
	<time>1610960154764</time>
</api-response>

Link de Pagamento – Tabela de Parâmetros

Link de Pagamento – Tabela de Parâmetros de Retorno