Pular para o conteúdo principal
Às vezes é necessário interromper um payout após o início do processamento; este guia aborda os procedimentos de cancelamento. Se você precisar cancelar um payout devido a um erro ou a uma mudança nos requisitos, é possível fazê-lo desde que o payout esteja em um dos seguintes status: Pending Authorization, Received, On Hold ou Locked. Você pode cancelar pagamentos através do Business Portal ou programaticamente via API.

Pré-requisitos

Antes de cancelar um payout, certifique-se de ter:
  • Uma transação de payout ativa com status: PendingAuth, Received, OnHold ou Locked
  • Credenciais de API válidas com as permissões adequadas
  • O identificador da transação (externalId)
ImportanteQuando um payout passa para o status Processing ou Completed, ele não pode ser cancelado pela API. Entre em contato com o suporte para obter ajuda com transações já processadas.

Endpoint da API

Para cancelar um payout, envie uma solicitação PATCH para o endpoint Cancelar um Payout.

Solicitação de Cancelamento de Payout

Autenticação

Inclua seu token de acesso nos cabeçalhos da solicitação:

Parâmetros-chave da solicitação

Exemplo de solicitação

curl

Tratamento de Respostas

Resposta bem-sucedida

Quando o cancelamento é bem-sucedido, você receberá uma resposta com o status atualizado:

Campos de resposta principais

Respostas de erro


Melhores práticas de implementação

  • Sempre valide o status da transação antes de tentar o cancelamento
  • Use HTTPS em todas as solicitações da API
  • Armazene os tokens de acesso de forma segura e faça a rotação deles regularmente
  • Implemente um tratamento de erros adequado e uma lógica de nova tentativa
  • Registre em log todas as tentativas de cancelamento para fins de auditoria

Testando sua implementação

Antes de implantar em produção, teste sua lógica de cancelamento minuciosamente:
  1. Teste com transações válidas em status que permitem cancelamento
  2. Teste com transações inválidas para tratar erros de forma adequada
  3. Teste falhas de autenticação e expiração de token
  4. Verifique o tratamento de webhooks, se implementado
  5. Teste a limitação de taxa e a lógica de nova tentativa

Recursos e próximos passos

Maximize o sucesso da sua integração com estes recursos essenciais

Integração de Webhook

Configure notificações em tempo real para atualizações do status das transações.

Relatórios do Business Portal

Acesse análises detalhadas, ferramentas de geração de relatórios e recursos de conciliação.

Monitoramento de transações

Aprenda a consultar o status das transações e a implementar um rastreamento abrangente.

Referência da API

Documentação completa dos endpoints com exemplos interativos.

Dica profissionalSempre teste seu fluxo de trabalho em nosso ambiente de sandbox antes de implantá-lo em produção. Isso garante que o tratamento de erros, o processamento de webhooks e o rastreamento de status funcionem corretamente em todos os cenários.

Precisa de ajuda?Entre em contato com nossa equipe de suporte caso encontre algum problema ou precise de ajuda com a integração.

Última modificação em 10 de novembro de 2026