Comunidade de Desenvolvedores maxiPago!

Cancelar Recorrência

Para cancelar uma recorrência via API é preciso enviar o comando cancel-recurring e o orderID retornado pela maxiPago! no momento da criação do pedido.

Cancelando a Recorrência – URLs Para Envio dos Dados

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

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

Cancelando 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>cancel-recurring</command>
    <request>
        <orderID>C0A86327:0151B6814FA1:50F7:50212C05</orderID>
    </request>
</api-request>

Cancelando 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>cancel-recurring</command>
    <time>1509460190738</time>
    <result></result>
</api-response>

Cancelando 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[Invalid order id.]]>
    </errorMsg>
    <time>1509460190738</time>
</api-error>

Cancelando a Recorrência – Tabela de Parâmetros

Nome

Obrigatório

Tamanho

Descrição

version

Sim

11

Versão da API

merchantId

Sim

20

Id de Loja que identifica o estabelecimento

merchantKey

Sim

80

Chave associada ao ID da Loja

orderID

Sim

128

ID do pedido, gerado pela maxiPago!
Deve-se salvar este campo para futuras referências ao pedido.