Skip to content

↑↓ navigate ↵ open Ctrl↵ new tab esc close

Changes to the integration API, newest first. Dashboard-only changes are not listed here.

  • Merchant registration through the API. Get, create or update by merchant_ref (the seller ID in your system), in batches of up to 500, edit and delete. Repeating does not duplicate: what did not change comes back unchanged. List merchants gains updated_at and the updated_since filter.

  • Enrollments through the API. Request a descriptor or BIN + CAID for a merchant, in batches of up to 500 and from several merchants, list, get and request deactivation. Every request goes through approval by the Rapid team. See Enrollments: overview.

  • Usage by merchant: how many billable alerts each merchant had in the current cycle or in a closed one.

  • Alerts with your seller. The alerts query brings merchant_ref and filters by merchant_id, merchant_ref, merchant_enrollment_id and updated_since. The webhook in v2 format brings merchant_enrollment_id and merchant.merchant_ref; the legacy format does not change.

  • Sync guide: the recommended flow to keep sellers, enrollments and alerts up to date, in Sync guide.

  • Errors with params and details, when they exist: the field, the limit or the conflicting id. If you read only code and message, nothing changes. See Response codes.

  • An alert whose delivery never went out is sent later. If the first webhook delivery attempt never goes out because of a failure on Rapid’s side, an alert received in the last 2 days is sent automatically later, usually within 20 minutes, with the same alert_id, while the webhook is active. Handle the repeated delivery by alert_id (see Idempotency). See Retries and logs.

  • Webhook test event (webhook.test): the Send test event button, under Settings › Webhook, sends your URL an event with the same headers and the same signature as real deliveries, without creating an alert. See Payload.

  • The merchant_id filter in the alerts query now applies. Before, it was ignored and the list came with every alert; now only that merchant’s alerts come. See List alerts.

  • Stable order in the alerts query: alerts received at the same moment are tie-broken by id, so pagination neither repeats nor skips an alert.

  • Unknown parameters in /merchants and /chargeback-alert/alerts will start being rejected with 422, as they already are on the new routes. For now they are still ignored; check that your integration sends only the documented parameters.

  • Two responses to the same alert at the same time do not both go through. In Update status, the first one is recorded and the other gets 422 Alert already has a definitive status, the same as responding to an alert that was already answered (before, both got 200). See Retrying the request.

  • Rotating the client_secret without downtime. Generating a new secret no longer cuts off the previous one right away: it keeps working for 24 hours, alongside the new one, and can be revoked earlier in the dashboard. The client_id stays the same. See Rotating the client_secret.

The current version of the API, replacing the one from the previous system. If you already integrated with Rapid, this is the list of what changes.

  • Transactions API at /api/v1/transactions: create, send in batch (up to 1000 per call), retrieve by Rapid’s ID or by your system’s ID, and update. Transactions cannot be deleted: DELETE responds 405 (see Delete transaction).
  • List merchants, to find the merchant_id through the API.
  • List alerts with filters (status, dates, card, provider ID) and pagination.
  • Update status of the alert at PATCH /api/v1/chargeback-alert/alerts/:id/status.
  • v2 webhook format: delivery signed with HMAC-SHA256 and a timestamp, event identified in the body and in a header, and a single channel for every product.
  • Evidence and Capture, which feed the Dispute defense.
  • A single error format across the whole API, including routes that do not exist (404 NOT_FOUND). The message is in English; decide by the code (see Response codes).
  • Developer tools: the documentation in your AI assistant (MCP), in Markdown and in llms.txt, and the Postman collection.
  • Webhook only over HTTPS and to a public internet address. A redirect that turns the POST into a GET (301, 302, 303) is not followed. See Retries and logs.
  • Request limit per IP, also counting 401 responses, with Retry-After on the 429. See Response codes.
  • Webhook retries at defined intervals. See Retries and logs.

Kept for those who already integrated, with no change on your side. For a new integration, use the endpoints in the right column.

From the previous systemUse in a new integration
POST /chargeback-alert/update/statusPATCH /api/v1/chargeback-alert/alerts/:id/status
POST /chargeback-alert/getGET /api/v1/chargeback-alert/alerts
Webhook in the legacy format, with clientid/clientkeyWebhook in the v2 format, with a signature

These old endpoints will be removed once there are no more calls to them.

The previous system’s Transactions API (/transactions/create, /transactions/update and /transactions/delete, without /api/v1) does not exist in the new API. The path and the fields changed: the integration needs to move to the new Transactions API.