Visão geral
A API de Transações permite que você envie, consulte e atualize transações de venda da sua empresa na plataforma Rapid. Transações não podem ser apagadas: toda transação enviada fica registrada, porque é a base das soluções e do histórico. Essas transações são utilizadas pelas soluções contratadas para proteger seu negócio contra disputas e chargebacks.
Como funciona
Seção intitulada “Como funciona”- Sua aplicação envia as transações de venda via HTTPS para a API da Rapid
- A Rapid armazena os dados da transação (itens, cliente, endereços, pagamentos, reembolsos)
- As soluções ativas utilizam esses dados automaticamente quando necessário
Quem envia transações
Seção intitulada “Quem envia transações”Transação é o insumo da Prevenção, que responde ao banco emissor com os dados do pedido, e da Disputa, que monta a defesa com eles. Por isso, criar transação exige um desses dois produtos ativo na sua empresa:
POST /transactionsePOST /transactions/batchsem Prevenção nem Disputa ativa respondem403 PRODUCT_NOT_ACTIVE- Se a sua empresa usa só o Alerta, você não precisa enviar transações
- Consultar e atualizar continuam disponíveis para as transações que você já enviou
Para ativar a Prevenção ou a Disputa, contrate pelo painel ou fale com o suporte.
Endpoints disponíveis
Seção intitulada “Endpoints disponíveis”| Método | Endpoint | Descrição |
|---|---|---|
| POST | /api/v1/transactions | Criar uma transação |
| POST | /api/v1/transactions/batch | Criar múltiplas transações (até 1000) |
| GET | /api/v1/transactions/:id | Consultar uma transação |
| GET | /api/v1/transactions?external_id= | Achar uma transação pelo ID do seu sistema |
| PATCH | /api/v1/transactions/:id | Atualizar uma transação |
| DELETE | /api/v1/transactions/:id | Não disponível: responde 405 (detalhes) |
Base URL
Seção intitulada “Base URL”https://api.rapidchargeback.com/api/v1Autenticação
Seção intitulada “Autenticação”Todas as requisições usam Basic Auth com o client_id e o client_secret gerados no painel. Como gerar e enviar está em Autenticação.
Authorization: Basic base64(client_id:client_secret)Limites
Seção intitulada “Limites”| Limite | Valor |
|---|---|
| Requisições por minuto | 100 por IP |
| Transações por requisição (batch) | 1000 |
Proteção de imutabilidade
Seção intitulada “Proteção de imutabilidade”Transações que já foram utilizadas por alguma solução (ex: consultadas pela Prevenção) não podem ser alteradas. Nesse caso, o PATCH retorna 409 Conflict (TRANSACTION_IMMUTABLE).
Transações que ainda não foram utilizadas podem ser livremente atualizadas.
Nenhuma transação pode ser apagada, usada ou não: o DELETE responde 405 TRANSACTION_DELETE_NOT_ALLOWED. Ver Deletar transação.