🔒
The Create Order Risk API allows the creation of risk assessments for orders, enabling users to flag orders with custom risk levels and details.
This API is especially useful for:
- Adding fraud detection and risk assessment details to orders.
- Automating risk management based on custom rules.
- Enabling enhanced reporting and tracking for high-risk orders.
📘
| Parameter | Type | Required | Description | Example |
|---|
order_id | string | Yes | Unique identifier for the order | ord_123456 |
| Parameter | Type | Required | Description | Example |
|---|
risk.level | string | Yes | Risk level for the order. Possible values: low, medium, high | high |
risk.details | array of strings | No | List of risk details explaining the reason for the risk | ["Suspicious payment method", "Unusual shipping address"] |
risk.properties | object | No | Custom key-value pairs for additional risk information | "properties": { "risk_source": "manual_review", "reviewer_id": "user_123", "is_high_priority": true, "verification_steps": ["phone_call", "id_check"] }, |
📘
| Parameter | Type | Example | Description |
|---|
code | string | "success" | Status code of the API response |
message | string | "Order retrieved successfully" | Descriptive message about the response |
| Field | Type | Description | Example |
|---|
id | string | The unique ID of the created risk. | 372997190468224746 |
order_id | string | The unique ID of the order associated with the risk. | 633130-00000015 |
level | string | Risk level for the order. Possible values: low, medium, high. | low |
details | array of strings | List of reasons or details for the risk. | ["wrong order price"] |
properties | | Custom key-value pairs for additional risk information | "properties": { "risk_source": "manual_review", "reviewer_id": "user_123", "is_high_priority": true, "verification_steps": ["phone_call", "id_check"] }, |
created_at | string | Timestamp when the risk was created (ISO 8601 format). | 2024-04-25T06:37:40Z |
updated_at | string | Timestamp when the risk was last updated (ISO 8601 format). | 2024-04-25T06:37:40Z |
| Field | Type | Example | Description |
|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |
