Overview
The Transactions API lets you send, retrieve and update your company’s sales transactions on the Rapid platform. Transactions cannot be deleted: every transaction you send stays on record, because it is the basis of the solutions and of the history. These transactions are used by the solutions you subscribe to in order to protect your business against disputes and chargebacks.
How it works
Section titled “How it works”- Your application sends the sales transactions over HTTPS to the Rapid API
- Rapid stores the transaction data (items, customer, addresses, payments, refunds)
- The active solutions use this data automatically when needed
Who sends transactions
Section titled “Who sends transactions”Transactions are the input for Prevention, which answers the issuing bank with the order data, and for Dispute, which builds the defense with it. That is why creating transactions requires one of these two products to be active for your company:
POST /transactionsandPOST /transactions/batchwithout an active Prevention or Dispute respond403 PRODUCT_NOT_ACTIVE- If your company only uses Alert, you do not need to send transactions
- Retrieving and updating remain available for the transactions you already sent
To activate Prevention or Dispute, subscribe in the dashboard or contact support.
Available endpoints
Section titled “Available endpoints”| Method | Endpoint | Description |
|---|---|---|
| POST | /api/v1/transactions | Create a transaction |
| POST | /api/v1/transactions/batch | Create multiple transactions (up to 1000) |
| GET | /api/v1/transactions/:id | Retrieve a transaction |
| GET | /api/v1/transactions?external_id= | Find a transaction by your system’s ID |
| PATCH | /api/v1/transactions/:id | Update a transaction |
| DELETE | /api/v1/transactions/:id | Not available: responds 405 (details) |
Base URL
Section titled “Base URL”https://api.rapidchargeback.com/api/v1Authentication
Section titled “Authentication”Every request uses Basic Auth with the client_id and client_secret generated in the dashboard. How to generate and send them is in Authentication.
Authorization: Basic base64(client_id:client_secret)Limits
Section titled “Limits”| Limit | Value |
|---|---|
| Requests per minute | 100 per IP |
| Transactions per request (batch) | 1000 |
Immutability protection
Section titled “Immutability protection”Transactions that were already used by a solution (e.g. queried by Prevention) cannot be changed. In that case, PATCH returns 409 Conflict (TRANSACTION_IMMUTABLE).
Transactions that have not been used yet can be freely updated.
No transaction can be deleted, used or not: DELETE responds 405 TRANSACTION_DELETE_NOT_ALLOWED. See Delete transaction.