Antes de começar
Certifique-se de ter:Credenciais da API
Credenciais de API e token de acesso válidos para autenticação.
Configuração da conta
Configuração adequada da conta para o país de destino e verificação da empresa.
Lista branca de IPs
Adicione os endereços IP do seu servidor à lista de permissões para acesso à API.
Endpoint de webhook
Configure um URL de webhook para receber notificações de pagamento.
Requisitos adicionais de cancelamento:
- Função de usuário com permissões de cancelamento (consulte a documentação de Funções de Usuário).
- A transação original deve estar em um estado que permita cancelamento.
- O
externalIdda transação de pagamento APM que você deseja cancelar. - Preencha as informações do beneficiário para reembolsos que exigem dados.
Cancelamento direto para pagamentos APM
Os cancelamentos de pagamentos APM são processados como Cancelamentos Diretos, ou seja, você só precisa doexternalId da transação original e do parâmetro status definido como CANCELLED. O sistema interrompe imediatamente qualquer processamento adicional do pagamento.
Etapa 1: Cancelar pagamento APM via API
Para cancelar um pagamento APM, envie uma solicitaçãoPATCH para o endpoint Cancel.
Parâmetros-chave da solicitação
A solicitação requer vários parâmetros-chave:Exemplo de solicitação
Abaixo está um exemplo usandocurl:
curl
Etapa 2: Lidar com a resposta
Resposta bem-sucedida
Detalhes da confirmação de um pagamento APM cancelado com sucesso:Campos de resposta principais
Resposta de erro
Quando uma solicitação de cancelamento falha, você receberá as seguintes informações de erro:Cenários de erro comuns
Etapa 3: Rastrear o status do cancelamento
Após iniciar um cancelamento, monitore seu progresso através destes métodos:Webhooks (Recomendado)
Receba notificações em tempo real quando o status da transação mudar. Ideal para ambientes de produção.
Endpoint da API de Status
Consultar o status da transação programaticamente. Útil para consultar ou recuperar notificações de webhook perdidas.
Visualização do Business Portal
Interface visual para monitoramento de transações. Ideal para supervisão manual e análise detalhada de transações.
Códigos de status de cancelamento comuns
Referência completaConsulte todos os códigos de status em nossa Documentação de Status da Transação.
Testando sua integração
Cenários de teste
Verifique se sua integração lida com esses cenários:- Cancelamento bem-sucedido: Cancele um pagamento APM pendente com um externalId válido.
- Transação inválida: Tente cancelar um externalId inexistente.
- Já concluída: Tente cancelar uma transação concluída.
- Validação de permissões: Teste com usuários que possuem diferentes níveis de permissão.
- Parâmetro de status ausente: Tente o cancelamento sem o campo de status obrigatório.
Próximos passos
Ver o status da transação
Verifique o status atual das transações e dos cancelamentos usando a
API de Status da Transação.
Processar reembolsos
Aprenda como processar reembolsos de pagamentos APM concluídos que não podem
ser cancelados.

