Cancelar Link de Pagamento

Link de Pagamento – Cancelando um link de pagamento

Para o cancelamento da ordem de pagamento será necessário informar o número da ordem retornada pela maxiPago! no response de sua criação. O número do Link de Pagamento no response é retornado na tag<pay_order_id> e na tag <command> passar o comando cancel-payment-order.

Link de Pagamento – URLs Para Envio dos Dados

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

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

Link de Pagamento – Cancelamento de um link de pagamento

Veja abaixo a estrutura do XML que precisa ser enviado para cancelar um Link de Pagamento.

<?xml version="1.0" encoding="UTF-8"?>
<api-request>
    <verification>
        <merchantId>store-id</merchantId>
        <merchantKey>store-key</merchantKey>
    </verification>
    <command>cancel-payment-order</command>
    <request>
        <payOrderId>FiaoEH3mOE8=</payOrderId>
    </request>
</api-request>







OBSERVAÇÃO:





O Link de Pagamento só poderá ser cancelado caso não esteja com o status de “PAID”.







Link de Pagamento  – Exemplo de Cancelamento com Sucesso





<?xml version="1.0" encoding="UTF-8"?>
<api-response>
        <errorCode>0</errorCode>
        <errorMessage></errorMessage>
        <command>cancel-payment-order</command>
        <time>1505919057637</time>
        <result>
            <pay_order_id>FiaoEH3mOE8=</pay_order_id>
            <message>Canceled Successfully</message>
        </result>
</api-response>





Link de Pagamento – Exemplo de Cancelamento com Erro





<?xml version="1.0" encoding="UTF-8"?>
<api-response>
        <errorCode>1</errorCode>
        <errorMessage>
            <![CDATA[Pay order id not located: FiaoEH3OE8= not located.]]>
        </errorMessage>
        <time>1505919057637</time>
</api-response>





Link de Pagamento – Tabela de Parâmetros







Nome



Obrigatório



Tamanho



Descrição




merchantId



Sim



20



ID da loja na maxiPago!




merchantKey



Sim



80



Chave da loja na maxiPago!




command



Sim



– – –



Ação a ser realizada no Link de Pagamento, valores aceitos:


– add-payment-order
– cancel-payment-order
– update-payment-order
– get-payment-order




referenceNum



Sim



128



Identificador do pedido no estabelecimento. Este campo aceita apenas valores alfanuméricos e deve ser único.




fraudCheck



Sim



1



Enviar o pedido para o antifraude, valores aceitos:


– Y = Sim
– N = Não




firstName



Sim



64



Nome do comprador




lastName



Sim



64



Sobrenome do comprador




address



Sim



128



Endereço e número do comprador




address2



Sim



128



Complemento do endereço




city



Sim



64



Cidade do comprador




state



Sim



32



Estado do comprador (UF – 2 Dígitos)




postalcode



Sim



16



CEP do endereço do comprador




country



Sim



64



País do comprador




email



Sim



128



E-mail do comprador




customerIdExt



Sim



16



Documento do comprador, informe o apenas o número do CPF ou CNPJ do comprador




dob



Sim



DATE



Data de nascimento do comprador
Formato MM/DD/YYYY




sex



Sim



1



Sexo do comprador (M – F)




phone



Sim



16



Telefone com o DDD do comprador.
Exemplo: 01122334455




description



Sim



50



Descrição da venda




comments



Sim



255



Comentário para a venda




emailSubject



Sim



150



Assunto do e-mail a ser enviado para o comprador




expirationDate



Sim



DATE



Data de vencimento do Link de Pagamento




creditCard/processorID



Sim



2

 
Informe o ID da adquirente que irá processar o Link de Pagamento, segue abaixo a lista:
1 – Simulador de Teste
3 – GetNet
4 – Cielo
5 – Rede
6 – Elavon
8 – ChasePaymentech
9 – Stone
 


creditCard/operation



Sim



– – –



Tipo de processamento, veja os valores aceitos:
– auth (Somente Autorizar)
– sale (Autoriza/Captura)




creditCard/numberOfInstallments



Não



4



Número de parcelas da venda.
Não enviar para as transações à vista




creditCard/currencyCode



Sim



3



Código da moeda da transação no formato ISO 4217




creditCard/amount



Sim



14.2



Ordem simples de pagamento: Valor total da compra.
Observação: ao enviar a tag <recurring>, esse parâmetro será considerado um Link de Pagamento diferente da recorrência definida na tag “recurring”.




recurring/startDate



Não



DATE



Data de início da cobrança. Formato MM/DD/YYYY




recurring/period



Não



– – –



Intervalo de tempo entre cobranças:
daily = dia(s)
weekly = semana(s)
monthly = mês(es)
bimonthly = bimestral
quarterly = trimestral
semiannual = semestral
annual = anual




recurring/numberOfInstallments



Sim



4



Quantidade de cobranças a serem realizadas na recorrência de acordo com a informação fornecida na tag <period>




recurring/failureThreshold



Não



11



Número de tentativas negadas necessárias para ativar notificação por e-mail. Mínimo = 1




recurring/amount



Sim



14.2



Valor de cada cobrança a ser realizada de acordo com o período fornecido na tag <period>







Checkout 2.0 – Tabela de Parâmetros de Retorno







Nome



Descrição




errorCode



Código de erro.
0 = requisição processada com sucesso
1 = requisição com erro, verifique o erro descrito na tag errorMessage




errorMsg



Mensagem descritiva do erro (em inglês)




comman



Confirmação do comando enviado na requisição




time



Data e hora de geração do relatório no fuso BRT. Formato mm/dd/aaaa hh:mm:ss




pay_order_id



Código do Link de Pagamento




message



Mensagem da ação realizada




referenceNum



Código interno do pedido na loja




fraudCheck



Análise de fraude




status

 
Status do Link de Pagamento (CREATED, PAID, CANCELED, EXPIRED ou REJECTED*) –
*Rejected: Aplicável apenas para clientes que tenham Link Rede (gerados via portal Use Rede) ativados em um mesmo MID Maxipago. Para demais casos o status não retornará nenhuma transação


address



Endereço do comprador




address2



Complemento do endereço do comprador




city



Cidade do comprador




state



Estado (UF) do comprador




postalcode



CEP do endereço do comprador




country



País do comprador




email



E-mail do comprador




customerIdExt



Número do documento do comprador




firstName



Nome do comprador




lastName



Sobrenome do comprador




dob



Data de nascimento do comprador




sex



Sexo do comprador




phone



Telefone de contato com o comprador




description



Descrição inserida no Link de Pagamento




comments



Comentário inserido no Link de Pagamento




emailSubject



Assunto do e-mail enviado ao comprador




expirationDate



Data de vencimento do Link de Pagamento




processorID



ID da adquirente que deverá processar a ordem de pagamento




operation



Tipo de operação de venda a ser realizada Autorização ou Venda Direta




expirationDate



Data de vencimento do Link de Pagamento




processorID



ID da adquirente que deverá processar o Link do Pagamento




operation



Tipo de operação de venda a ser realizada Autorização ou Venda Direta




numberOfInstallments



Número de parcela ou quantidade de cobranças da recorrência




currencyCode



Moeda do Link de Pagamento




amount



Valor a ser pago no Link de Pagamento




startDate



Data de início da cobrança recorrente




period



Intervalo de tempo entre cobranças




failureThreshold



Número de tentativas negadas necessárias para ativar notificação por e-mail.