Risk Order Status API
Overview
The Risk Assessment API request message includes the information Radial needs to assess an order's fraud risk and provide a fraud decision. After orders are submitted for Risk Assessment, the Risk Order Status API accepts multiple order IDs and returns the current fraud status of those orders.
URI Summary
|
Action |
URI Template |
URI Example |
Non-URI Request |
Response |
|---|---|---|---|---|
|
POST |
{baseURI}/v[M.m]/stores/[StoreId]/ risk/ fraud/orderStatus.[format] |
http://lvsprdapi01.gsipartners.com:1801/public-api-service/v1.0/stores/ABCXYZ/risk/fraud/orderStatus.xml |
XML |
200 + XML response |
Schema
Request Examples
The request is a RiskOrderStatusRequest message.
RiskOrderStatusRequest example with multiple order ids
<?xml version="1.0" encoding="UTF-8"?>
<RiskOrderStatusRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
<OrderIdsList>
<OrderId>3666179198</OrderId>
<OrderId>3666100188</OrderId>
<OrderId>4730733066</OrderId>
</OrderIdsList>
</RiskOrderStatusRequest>
RiskOrderStatusRequest Example with only order id
<?xml version="1.0" encoding="UTF-8"?>
<RiskOrderStatusRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
<OrderIdsList>
<OrderId>3666179198</OrderId>
</OrderIdsList>
</RiskOrderStatusRequest>
Request Elements
|
Element |
Required |
Description |
Type |
Restriction |
|---|---|---|---|---|
|
/RiskOrderStatusRequest/ |
Yes |
|
ComplexType |
|
|
/RiskOrderStatusRequest/OrderIdsList |
Yes |
A list of OrderId elements. Contains the list of order IDs for which risk order status responses are needed. |
ComplexType |
Minimum of One Order Id and maximum of 1000 order ids accepted in the request. |
|
/RiskOrderStatusRequest/OrderIdsList/OrderId |
Yes |
Order Id. This should be the order id used originally with RiskAssessmentRequest message. |
String |
Max 40 characters for each Order Id. |
Response Example
<?xml version="1.0" encoding="UTF-8" ?>
<RiskOrderStatusReply xsi:schemaLocation="http://api.gsicommerce.com/schema/checkout/1.0
Risk-OrderStatus-1.0.xsd">
<OrderDetailsList>
<OrderDetails>
<OrderId>3666179198</OrderId>
<RiskOrderStatus>APPROVED</RiskOrderStatus>
</OrderDetails>
<OrderDetails>
<OrderId>3666100188</OrderId>
<RiskOrderStatus>CAN</RiskOrderStatus>
</OrderDetails>
<OrderDetails>
<OrderId>4730733066</OrderId>
<RiskOrderStatus>REQUEST_NOT_FOUND</RiskOrderStatus>
</OrderDetails>
</OrderDetailsList>
</RiskOrderStatusReply>
Response Elements
|
Element |
Required |
Description |
Type |
Restriction |
|---|---|---|---|---|
|
/RiskOrderStatusReply |
Yes |
The risk order status reply with an order status for each order ID listed in the request. |
ComplexType |
|
|
/RiskOrderStatusReply/OrderDetailsList |
Yes |
The list of order details with status. |
ComplexType |
|
|
/RiskOrderStatusReply/OrderDetailsList/OrderDetails |
Yes |
Sequence of Order ID and Risk Order Status. Includes an Order ID and its risk order status. |
ComplexType |
Minimum of 1 OrderDetails element and maximum of 1000 OrderDetails elements based on the request order ids. |
|
/RiskOrderStatusReply/OrderDetailsList/OrderDetails/OrderId |
Yes |
Order Id. This will be the same order id provided in RiskOrderStatusRequest. |
String |
Max 40 characters for each Order Id. |
|
/RiskOrderStatusReply/OrderDetailsList/OrderDetails/RiskOrderStatus |
Yes |
One of the following status values is provided for each Order ID in the RiskOrderStatus Reply. |
Enumeration. |
Possible values: APPROVED, CANCELLED, SUSPENDED, REQUEST_NOT_FOUND, IN_PROCESS. See table below for meaning of each value. |
RiskOrderStatus Values
| Value | Description |
|---|---|
| APPROVED | The order is already approved from risk. |
| CANCELLED | The order is cancelled from risk. |
| SUSPENDED | The order is suspended until a manual review of risk can be completed. For suspended orders, there will be one more response, the final response to the order, after the manual review. |
| REQUEST_NOT_FOUND | The original request was not found in the system. This can occur either because the original request is invalid, or because the original request is not yet updated in the risk system. |
| IN_PROCESS | The request is received but the response is not yet generated. It is in process. |
Integration Details
When integrating with Risk Order Status:
- Make a RiskOrderStatusRequest API call when you would like to know the current status of orders in Radial platform.
- The Risk Order Status API is expected to be sparsely used for only these two scenarios:
- Orders that are in Suspended status for longer than 2 days.
- Orders waiting for any response (no response at all has been received to OMS from Risk) greater than 10 minutes.
- The Risk Order Status API call is expected to be called with a frequency of at least an hour for each order ID.
- If the response status is REQUEST_NOT_FOUND for any particular order, please resend the original Risk Assessment request for fraud review of that order.
- If the response status from this API is any other response, and if it doesn’t match with the response in your OMS system, you can call the RiskOrderResponseResendRequest API. This API call retriggers the response from Radial's fraud system. For details, see Risk Order Response Resend API.