Editar Recorrência

A maxiPago! oferece 2 possibilidades de uma recorrência ser editada:

• Quando o cliente quer alterar um dado a qualquer momento;
• Quando uma cobrança é declinada o cliente pode optar por:
  • Pular a parcela declinada e dar continuidade as próximas cobranças;
  • Cancelar a Recorrência;
  • Pausar a Recorrência;

Para realizar uma alteração a qualquer momento, siga as instruções abaixo:

• Para a utilização desse método o comando “modify-recurring” deve ser informado em uma requisição.
• Para que a alteração seja feita, a recorrência deve inicialmente ser pausada com o comando: “disable“;
• Para que a alteração realizada tenha efeito, a recorrência deve ser ativada novamente com o comando: “enable“

Editando a Recorrência – URLs Para Envio dos Dados

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

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

Editando a Recorrência – Exemplo de Requisição

<?xml version="1.0" encoding="UTF-8"?>
<api-request>
    <verification>
        <merchantId>store-id</merchantId>
        <merchantKey>store-key</merchantKey>
    </verification>
    <command>modify-recurring</command>
    <request>
        <orderID>C0A86327:0151B6814FA1:50F7:50212C05</orderID>
        <paymentInfo>
            <cardInfo>
                <creditCardNumber>4716870704643843</creditCardNumber>
                <expirationMonth>07</expirationMonth>
                <expirationYear>2018</expirationYear>
            </cardInfo>
            <chargeTotal>50.00</chargeTotal>
        </paymentInfo>
        <recurring>
            <processorID>1</processorID>
            <action>enable</action>
            <installments>10</installments>
            <nextFireDate>2017-11-05</nextFireDate>
            <fireDay>20</fireDay>
            <period>quarterly</period>
            <lastDate>2018-11-05</lastDate>
            <lastAmount>105.00</lastAmount>
        </recurring>
        <billingInfo>
            <name>BILLING REC UPD</name>
            <address1>R BILLING STREET, 123</address1>
            <address2>7 ANDAR</address2>
            <city>SAMPA</city>
            <zip>01312000</zip>
            <country>BR</country>
            <email>billing@maxipago.com</email>
            <phone>1132890900</phone>
        </billingInfo>
        <shippingInfo>
            <name>BILLING REC UPD</name>
            <address1>R BILLING STREET, 123</address1>
            <address2>7 ANDAR</address2>
            <city>SAMPA</city>
            <zip>01312000</zip>
            <country>BR</country>
            <email>billing@maxipago.com</email>
            <phone>1132890900</phone>
        </shippingInfo>
    </request>
</api-request>

Editando a Recorrência – Exemplo de Retorno em Caso de Sucesso

<?xml version="1.0" encoding="UTF-8"?>
<api-response>
        <errorCode>0</errorCode>
        <errorMessage></errorMessage>
        <command>modify-recurring</command>
        <time>1509460190738</time>
        <result></result>
</api-response>

Editando a Recorrência – Exemplo de Retorno em de Erro

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<api-error>
    <errorCode>1</errorCode>
    <errorMsg>
        <![CDATA[java.lang.Exception: empty element detected in setPsInParams for field=merchant_id]]>
    </errorMsg>
</api-error>

Editando as Parcelas da Recorrência

Sempre considerar o número de parcelas da criação da recorrência como base; lembrando que não é possível colocar um número de parcelas inferior aos pagamentos já realizados.

No exemplo a seguir, a cobrança inicial era de 10 parcelas e houve a necessidade de cobrar apenas mais 1. Então considerando que já foram pagas 8 parcelas, o novo número de installments será 9.

<api-request>
    <version>3.1.1.15</version>
    <verification>
        <merchantId>store-id</merchantId>
        <merchantKey>store-key</merchantKey>
    </verification>
    <command>modify-recurring</command>
    <request>
        <orderID>C0A86327:0151B6814FA1:50F7:50212C05</orderID>
        <paymentInfo>
            <cardInfo>
                <creditCardNumber>4716870704643843</creditCardNumber>
                <expirationMonth>07</expirationMonth>
                <expirationYear>2022</expirationYear>
            </cardInfo>
        </paymentInfo>
        <recurring>
            <action>enable</action>
            <installments>9</installments>
        </recurring>
</request>
</api-request>

Editando a Recorrência – Tabela de Parâmetros