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.
Passo 1: Cancelar uma assinatura
Para cancelar uma assinatura existente, envie uma solicitaçãoPATCH para o endpoint Cancelar uma assinatura.
Parâmetros-chave da solicitação
A solicitação requer vários objetos-chave:Exemplo de solicitação
Abaixo está um exemplo usandocurl:
curl
Etapa 2: Lidar com a resposta
Resposta bem-sucedida
Um cancelamento bem-sucedido retorna a confirmação de cancelamento da assinatura:Campos de resposta principais
Resposta de erro
Quando o cancelamento de uma assinatura falhar, você receberá as seguintes informações de erro:Etapa 3: Rastrear o status da transação
Após cancelar uma assinatura, monitore o status 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 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 uma assinatura ativa com credenciais válidas.
- Assinatura já cancelada: Tentativa de cancelar uma assinatura já cancelada.
- Assinatura inexistente: Cancelar uma assinatura que não existe.
- Erros de autenticação: Cancelar com autenticação inválida ou ausente.
- Notificações de Webhook: Os webhooks de confirmação de cancelamento são acionados.
Próximos passos
Após cancelar uma assinatura, você poderá precisar realizar ações adicionais:Criar nova assinatura
Crie uma nova assinatura se o cliente quiser retomar o serviço com um
plano ou método de pagamento diferente.
Configurar webhooks
Configure webhooks para receber notificações em tempo real sobre eventos da
assinatura.

