Pular para o conteúdo

↑↓ navegar ↵ abrir Ctrl↵ nova aba esc fechar

Mudanças na API de integração, da mais recente para a mais antiga. Mudança só no painel não entra aqui.

  • Cadastro de merchants pela API. Consultar, criar ou atualizar pelo merchant_ref (o ID do vendedor no seu sistema), em lote de até 500, editar e remover. Repetir não duplica: o que não mudou volta unchanged. Listar merchants ganha updated_at e o filtro updated_since.

  • Enrollments pela API. Pedir um descriptor ou BIN + CAID para um merchant, em lote de até 500 e de vários merchants, listar, consultar e pedir a desativação. Todo pedido passa pela aprovação da equipe da Rapid. Ver Enrollments: visão geral.

  • Uso por merchant: quantos alertas cobráveis cada merchant teve no ciclo atual ou num ciclo fechado.

  • Alertas com o seu vendedor. A consulta de alertas traz merchant_ref e filtra por merchant_id, merchant_ref, merchant_enrollment_id e updated_since. O webhook no formato v2 traz merchant_enrollment_id e merchant.merchant_ref; o formato legacy não muda.

  • Guia de sincronização: o fluxo recomendado para manter vendedores, enrollments e alertas em dia, em Guia de sincronização.

  • Erros com params e details, quando existem: o campo, o limite ou o id em conflito. Quem lê só code e message não muda. Ver Códigos de resposta.

  • Alerta cuja entrega nem saiu é enviado depois. Se a primeira tentativa de entrega do webhook não chegar a sair por uma falha do lado da Rapid, o alerta recebido nos últimos 2 dias é enviado automaticamente mais tarde, em geral em até 20 minutos, com o mesmo alert_id, enquanto o webhook estiver ativo. Trate a entrega repetida pelo alert_id (ver Idempotência). Ver Retries e logs.

  • Evento de teste do webhook (webhook.test): o botão Enviar evento de teste, em Configurações › Webhook, manda à sua URL um evento com os mesmos headers e a mesma assinatura das entregas reais, sem criar alerta. Ver Payload.

  • O filtro merchant_id da consulta de alertas passa a valer. Antes ele era ignorado e a lista vinha com todos os alertas; agora vêm só os do merchant. Ver Consultar alertas.

  • Ordem estável na consulta de alertas: alertas recebidos no mesmo instante saem desempatados pelo id, então a paginação não repete nem pula alerta.

  • Parâmetro desconhecido em /merchants e /chargeback-alert/alerts vai passar a ser recusado com 422, como já é nas rotas novas. Por ora ele segue ignorado; confira se a sua integração manda só os parâmetros documentados.

  • Duas respostas ao mesmo alerta ao mesmo tempo não passam juntas. Em Atualizar status, a primeira é registrada e a outra recebe 422 Alert already has a definitive status, como quem responde alerta já respondido (antes as duas recebiam 200). Ver Repetir o pedido.

  • Troca do client_secret sem interrupção. Gerar um segredo novo não derruba mais o anterior na hora: ele continua valendo por 24 horas, junto com o novo, e pode ser encerrado antes no painel. O client_id não muda. Ver Troca do client_secret.

A versão atual da API, que substitui a do sistema anterior. Se você já integrava com a Rapid, esta é a lista do que muda.

  • API de Transações em /api/v1/transactions: criar, enviar em lote (até 1000 por chamada), consultar pelo ID da Rapid ou pelo ID do seu sistema e atualizar. Transações não podem ser apagadas: o DELETE responde 405 (ver Deletar transação).
  • Listar merchants, para achar o merchant_id pela API.
  • Consultar alertas com filtros (status, datas, cartão, ID do provedor) e paginação.
  • Atualizar status do alerta em PATCH /api/v1/chargeback-alert/alerts/:id/status.
  • Webhook no formato v2: entrega assinada com HMAC-SHA256 e timestamp, evento identificado no corpo e no header, e um canal só para todos os produtos.
  • Evidência e Captura, que alimentam a defesa da Disputa.
  • Erros num formato único em toda a API, inclusive em rota que não existe (404 NOT_FOUND). O message vem em inglês; decida pelo code (ver Códigos de resposta).
  • Ferramentas para devs: a documentação no seu assistente de IA (MCP), em Markdown e em llms.txt, e a coleção do Postman.
  • Webhook só em HTTPS e em endereço público de internet. Redirecionamento que troca o POST por GET (301, 302, 303) não é seguido. Ver Retries e logs.
  • Limite de requisições por IP, contado também nas respostas 401, com Retry-After no 429. Ver Códigos de resposta.
  • Retentativas do webhook com intervalos definidos. Ver Retries e logs.

Mantidos para quem já integrava, sem mudança do seu lado. Para integração nova, use os endpoints da coluna da direita.

Do sistema anteriorUse em integração nova
POST /chargeback-alert/update/statusPATCH /api/v1/chargeback-alert/alerts/:id/status
POST /chargeback-alert/getGET /api/v1/chargeback-alert/alerts
Webhook no formato legacy, com clientid/clientkeyWebhook no formato v2, com assinatura

Esses endpoints antigos serão removidos quando não houver mais chamadas a eles.

A API de Transações do sistema anterior (/transactions/create, /transactions/update e /transactions/delete, sem /api/v1) não existe na nova API. Mudaram o caminho e os campos: a integração precisa passar para a API de Transações nova.