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 do webhook
Configure um URL de webhook para receber notificações de pagamento.
Etapa 1: Atualizar uma assinatura
Para modificar uma assinatura existente, envie uma solicitaçãoPATCH para o endpoint Atualizar uma assinatura.
Parâmetros-chave da solicitação
A solicitação requer vários parâmetros-chave:Exemplo de solicitação
Abaixo segue um exemplo de uso.curl:
curl
Etapa 2: Lidar com a resposta
Resposta bem-sucedida
Uma atualização bem-sucedida retorna os detalhes da assinatura modificada:Campos de resposta principais
Resposta de erro
Quando uma solicitação falhar, você receberá informações detalhadas sobre o erro:Etapa 3: Rastrear o status da transação
Após atualizar uma assinatura, monitore o status dela por meio 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
A API Localpayment fornece vários códigos de status para indicar o progresso e o resultado do pagamento na resposta.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:- Upgrade de plano bem-sucedido: aumento do nível ou do valor da assinatura.
- Downgrade de plano bem-sucedido: redução do nível ou do valor da assinatura.
- Atualização do método de pagamento: alteração dos dados do cartão.
- Atualização das informações do cliente: modificação dos dados do cliente.
- Erros de validação: valores inválidos, campos obrigatórios ausentes.
- Atualizações de status: gerenciamento de webhooks e consulta de status
Próximos passos
Após atualizar uma assinatura, talvez seja necessário realizar ações adicionais:Cancelar assinatura
Encerre assinaturas ativas quando as atualizações não forem suficientes.
Gerenciar webhooks de assinatura
Configure webhooks para receber notificações de eventos de atualização de assinatura.
Criar planos de assinatura
Crie novos planos que possam ser usados ao atualizar assinaturas.

