Anti-fraud Provider API
Check the Payments onboarding guide for a journey-based overview of the Payments documentation available in the Developer Portal.
The Anti-fraud Provider Protocol is a set of definitions to help you integrate your anti-fraud service API into VTEX platform.
To achieve this, you need to implement a web API (REST) following the specifications described in this documentation.
You can also access our template on GitHub to help you quickly develop your anti-fraud connector using the Anti-fraud Provider Protocol and VTEX IO.
To learn more about the Anti-fraud Provider Protocol, check our developer guide.
Endpoints
Anti-fraud Flow
| Summary | Method | Path |
|---|---|---|
| Send anti-fraud pre-analysis data (optional) | POST | /pre-analysis |
| Send anti-fraud data | POST | /transactions |
| Update anti-fraud transactions (optional) | PUT | /transactions/{transactionId} |
| List anti-fraud provider manifest | GET | /manifest |
| Get anti-fraud status | GET | /transactions/{transactions.id} |
| Stop anti-fraud analysis (optional) | DELETE | /transactions/{transactions.Id} |
OAuth Flow
| Summary | Method | Path |
|---|---|---|
| 1. Retrieve token | POST | /authorization/token |
| 2. Redirect | GET | /redirect |
| 3. Return to VTEX | GET | /authorizationCode |
| 4. Get credentials | GET | /authorization/credentials |