Integration
Documentation for Connect's order (transactional) integration.
POST Integration/{integrationId}
{integrationId}The /Integration/integrationId route allows integrating specific transaction information identified by the integrationId.
It receives detailed transaction data, such as values, devices, billing and shipping information, as well as items and payments. After processing, the route returns an analysis with results, including decisions, biometric verifications, and insights. Authentication with a security token is required to use it.
Integration Identification by Module
Each system module has a specific integrationId that uniquely identifies it, these are:
Note: It is possible to compose multiple modules, which provides greater flexibility and granularity in the integration between functionalities, allowing to efficiently address more complex scenarios.
Synchronous and Asynchronous Modules
Synchronous Module Operation
Synchronous modules perform data analysis immediately upon receiving a request. This process involves cross-referencing multiple relevant pieces of information to calculate the score and determine the request status.
The analysis response is returned within seconds, allowing for quick decisions integrated into the application flow, without the need for asynchronous processing or prolonged waiting.
Asynchronous Module Operation
Asynchronous modules process requests non-immediately, allowing data analysis to occur in the background after the request is received. During this process, various relevant pieces of information are cross-referenced for score calculation and request status definition.
Upon completion of processing, the system performs an automatic notification via webhook, sending the results to the endpoint previously provided by the client.
Our services address:
Homologation:
POST https://homologapix.clearsale.com.br/connect/v1/integration/integrationId
Production:
POST https://apix.clearsale.com.br/connect/v1/integration/integrationId
Configuration for Staging Environment
The staging environment is used for integration testing between systems. By default, responses are generated with fixed values, but it is possible to request custom configurations in the modules that offer this option.
The definition of the score and status is based on the last digit of the numeric field present in the billing document, allowing different scenarios to be simulated in a controlled manner.
Available Modules
- Decision (standard and customized)
- Score (standard and customized)
- MFA (standard)
- Biolink (standard and customized)
- Insights (standard)
Default Score Configuration
| Document (last digit) | Score Range (randomly generated) |
|---|---|
| 0 | 0.0000 – 0.1000 |
| 1 | 0.1001 – 0.2000 |
| 2 | 0.2001 – 0.3000 |
| 3 | 0.3001 – 0.4000 |
| 4 | 0.4001 – 0.5000 |
| 5 | 0.5001 – 0.6000 |
| 6 | 0.6001 – 0.7000 |
| 7 | 0.7001 – 0.8000 |
| 8 | 0.8001 – 0.9000 |
| 9 | 0.9001 – 0.9999 |
Default Status Configuration
| Document (last digit) | Status |
|---|---|
| 0 | APA – Automatic Approval |
| 1 | RPA – Automatic Rejection |
| 2 | AMA – Queued |
| 3 | FRD – Confirmed Fraud |
| 4 | APM – Approved |
| 5 | APP – Approved by Policy |
| 6 | AME – External Manual Review |
| 7 | APB – Approved by Biometrics |
| 8 | APS - Approved by SMS |
| 9 | ACT - Approved by Contingency |
Webhook Configuration
For the MFA and Biolink modules, it is possible to configure a webhook to receive notifications or results directly at an endpoint defined by the client.
This feature allows:
- Real-time integration with internal systems.
- Automation of processes based on returned events.
- Greater control over tests and responses in the staging environment.
To enable the webhook, provide:
- The endpoint URL that will receive the requests.
- Expected format: JSON.
- Authentication, if required (Basic, ApiKey, JWT).
Updated 2 days ago