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 Autenticado
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> <payOrderFailureThreshold>3</payOrderFailureThreshold> <referenceNum>200232040</referenceNum> <fraudCheck>N</fraudCheck> <billing> <address>R. Volkswagem</address> <address2>1 Andar</address2> <district>Conceicao</district> <city>Sao Paulo</city> <state>SP</state> <postalcode>04344-902</postalcode> <country>BR</country> <email>teste.maxipay@mailinator.com</email> <customerIdExt>47468578060</customerIdExt> <firstName>Teste</firstName> <lastName>Maxipay</lastName> <dob>01/30/1984</dob> <sex>M</sex> <phone>11922334455</phone> </billing> <transactionDetail> <description>Pagamento maxipago</description> <comments>refernte ao uso do mês</comments> <emailSubject>Cobrança MaxiPago</emailSubject> <expirationDate>06/17/2030</expirationDate> <payType> <creditCard> <processorID>1</processorID> <operation>auth</operation> <numberOfInstallments>2</numberOfInstallments> <currencyCode>BRL</currencyCode> <amount>1000.10</amount> </creditCard> </payType> </transactionDetail> </request> </api-request>
Link de Pagamento Autenticado 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>N</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/2030</expirationDate> <payType> <creditCard> <processorID>1</processorID> <operation>sale</operation> <numberOfInstallments>2</numberOfInstallments> <currencyCode>BRL</currencyCode> <amount>950.00</amount> </creditCard> </payType> </transactionDetail> <recurring> <startDate>01/10/2024</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 Autenticado com Antifraude
A integração com o parceiro de antifraude tem uma pequena variação de parâmetros, que
vão depender da negociação envolvida e o tipo de análise. Por isso, é preciso checar
se o conjunto de parâmetros citados, são suficientes ou se será necessário utilizar mais
parâmetros para enviar para que a análise seja aceita.
Veja request completo aqui
O material abaixo inclusive já está aderente à integração Fast Track.
<api-request> <verification> <merchantId>store-Id</merchantId> <merchantKey>store-Key</merchantKey> </verification> <command>add-payment-order</command> <request> <referenceNum>testemp001</referenceNum> <fraudCheck>Y</fraudCheck> <billing> <address>Avenida Paulista 123</address> <address2>1 Andar</address2> <city>Sao Paulo</city> <district>Centro</district> <state>SP</state> <postalcode>01311000</postalcode> <country>BR</country> <email>consumidor@consumidor.com.br</email> <customerIdExt>56337115996</customerIdExt> <firstName>Consumidor</firstName> <middleName>da maxi</middleName> <lastName>Pago</lastName> <dob>01/30/2000</dob> <sex>F</sex> <phone>11922334455</phone> <alternatePhone>11972228440</alternatePhone> <language>pt_br</language> <phoneExtension>10</phoneExtension> <alternatePhoneExtension>20</alternatePhoneExtension> <documents> <document> <documentType>RG</documentType> <documentValue>465014471</documentValue> </document> </documents> </billing> <shipping> <customerIdExt>56337115996</customerIdExt>a <addressType>Residential</addressType> <name>Consumidor maxiPago</name> <dob>01/30/2000</dob> <address>Avenida Paulista 123</address> <address2>1 Andar</address2> <city>Sao Paulo</city> <district>Centro</district> <state>SP</state> <country>BR</country> <postalcode>01311000</postalcode> <phone>11922334455</phone> <alternatePhone>11972228440</alternatePhone> <email>consumidor@consumidor.com.br</email> <phoneExtension>10</phoneExtension> <alternatePhoneExtension>20</alternatePhoneExtension> <documents> <document> <documentType>RG</documentType> <documentValue>465014471</documentValue> </document> </documents> </shipping> <transactionDetail> <description>Teste Link de Pagamento</description> <comments>Pagar até a data do vencimento</comments> <emailSubject>Teste Link de Pagamento</emailSubject> <expirationDate>10/10/2030</expirationDate> <payType> <creditCard> <processorID>1</processorID> <operation>auth</operation> <numberOfInstallments>1</numberOfInstallments> <currencyCode>BRL</currencyCode> <amount>1.00</amount> </creditCard> </payType> </transactionDetail> </request> </api-request>
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>
Link de 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:
<?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> <consumerAuthentication>N</consumerAuthentication> <referenceNum>teste_mp</referenceNum> <transactionDetail> <description>Livro sobre maxiPago! com capa dura</description> <emailSubject>Pagamento livro maxiPago!</emailSubject> <expirationDate>06/17/2030</expirationDate> <payType> <creditCard> <processorID>1</processorID> <operation>sale</operation> <numberOfInstallments>1</numberOfInstallments> <amount>90.00</amount> </creditCard> </payType> </transactionDetail> </request> </api-request>
Obs.: Neste modelo de Link Rápido o envio do e-mail é facultativo. Caso o lojista queira que seu consumidor receba um e-mail com o link para pagamento, deverá inserir as tags abaixo após, o parâmetro <request>:
<billing> <firstName>Silvia Ramos</firstName> <email>xxxxxxx@xxxx.com.br</email> </billing>
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 Rápido com Recorrência
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>store-id</merchantId> <merchantKey>store-key</merchantKey> </verification> <command>add-payment-order</command> <request> <consumerAuthentication>N</consumerAuthentication> <referenceNum>mpteste00</referenceNum> <transactionDetail> <description>Livro sobre maxiPago! com capa dura</description> <emailSubject>Pagamento livro maxiPago!</emailSubject> <expirationDate>06/17/2030</expirationDate> <payType> <creditCard> <processorID>1</processorID> <operation>sale</operation> <numberOfInstallments>1</numberOfInstallments> <amount>500.00</amount> </creditCard> </payType> </transactionDetail> <recurring> <startDate>01/10/2024</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>store-id</merchantId> <merchantKey>store-key</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/2030</expirationDate> <payType> <creditCard> <processorID>1</processorID> <operation>sale</operation> <numberOfInstallments>1</numberOfInstallments> <amount>60.00</amount> </creditCard> </payType> </transactionDetail> <recurring> <startDate>01/10/2024</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