Pular para o conteúdo

↑↓ navegar ↵ abrir Ctrl↵ nova aba esc fechar

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.

  1. Sua aplicação envia as transações de venda via HTTPS para a API da Rapid
  2. A Rapid armazena os dados da transação (itens, cliente, endereços, pagamentos, reembolsos)
  3. As soluções ativas utilizam esses dados automaticamente quando necessário

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 /transactions e POST /transactions/batch sem Prevenção nem Disputa ativa respondem 403 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.

MétodoEndpointDescrição
POST/api/v1/transactionsCriar uma transação
POST/api/v1/transactions/batchCriar múltiplas transações (até 1000)
GET/api/v1/transactions/:idConsultar uma transação
GET/api/v1/transactions?external_id=Achar uma transação pelo ID do seu sistema
PATCH/api/v1/transactions/:idAtualizar uma transação
DELETE/api/v1/transactions/:idNão disponível: responde 405 (detalhes)
https://api.rapidchargeback.com/api/v1

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)
LimiteValor
Requisições por minuto100 por IP
Transações por requisição (batch)1000

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.