Create Order Risk

POST 
/openapi/2022-01/orders/:order_id/risks

Attaches a custom risk record to the specified order with a risk level (low/medium/high), supporting detail reasons, and optional custom properties. Typically called after a manual fraud review.

Request

Path Parameters

order_id stringrequired

Order's ID

application/json

Body

Body

risk object

Order risk

levelstring

Risk level, such as: low, medium, high

valuesstring[]

Risk details list

properties object

Custom properties

keystring

value

Example

{
  "risk": {
    "level": "string",
    "values": [
      "string"
    ],
    "properties": {
      "key": "string"
    }
  }
}

Responses

200

200

application/json

Schema

Schema

risk object
idstring
Example: 372997190408224746
order_idstring
Example: 633130-00000015
levelstring
Example: low
valuestring[]
properties object
keystring
Example: value
created_atstring
Example: 2024-04-25T06:37:40Z
updated_atstring
Example: 2024-04-25T06:37:40Z

Example

{
  "risk": {
    "id": "372997190408224746",
    "order_id": "633130-00000015",
    "level": "low",
    "value": [
      "wrong order price"
    ],
    "properties": {
      "key": "value"
    },
    "created_at": "2024-04-25T06:37:40Z",
    "updated_at": "2024-04-25T06:37:40Z"
  }
}

Result

{
    "risk": {
        "id": "372997190408224746",
        "order_id": "633130-00000015",
        "level": "low",
        "value": [
            "wrong order price"
        ],
        "properties": {
            "key": "value"
        },
        "created_at": "2024-04-25T06:37:40Z",
        "updated_at": "2024-04-25T06:37:40Z"
    }
}