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.
Passo 1: Obtenha detalhes do plano de assinatura
Para recuperar informações do plano de assinatura, envie uma solicitaçãoGET para o endpoint Obtenha um plano de assinatura.
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
Uma solicitação bem-sucedida retorna os detalhes completos do plano de assinatura:Campos de resposta principais
Resposta de erro
Quando um plano de assinatura não puder ser encontrado ou acessado, você receberá as seguintes informações de erro:Etapa 3: Rastrear o status da transação
Após obter um plano de assinatura, você pode verificar sua disponibilidade e status atual: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:- Recuperação bem-sucedida do plano: Obtenha detalhes de um plano ativo existente.
- Plano Inexistente: Tentativa de recuperar um plano que não existe.
- ID do plano inválido: teste com formatos internalId malformados ou incorretos.
- Falhas de autenticação: Recuperar planos com tokens de acesso inválidos ou expirados.
Próximos passos
Crie um plano de assinatura
Configure novos planos de assinatura para diferentes níveis de serviço ou modelos de preços.
Atualizar plano de assinatura
Modifique os detalhes do plano existente com base nas informações obtidas.
Criar assinatura com plano
Utilize o ID do plano para criar novas assinaturas de clientes.

