Risk Order Response Resend 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, you can call the Risk Order Response Resend API to retrigger an order's Fraud Assessment response in the original message system. The Risk Order Response Resend request accepts multiple order IDs, and its response indicatesm, for each order, whether the Risk Assessment response was retriggered to the original message system or not.

URI Summary

Action	URI Template	URI Example	Non-URI Request	Response
POST	{baseURI}/v[M.m]/stores/[StoreId]/ risk/ fraud/orderResponseResend.[format]	http://lvsprdapi01.gsipartners.com:1801/public-api-service/v1.0/stores/ABCXYZ/risk/fraud/orderResponseResend.xml	XML	200 + XML response

Schema

Risk-OrderResponseResend-1.0.xsd

Request Examples

The request is a RiskOrderResponseResendRequest message.

RiskOrderResponseResendRequest example with multiple order ids

Copy this code sample.

<?xml version="1.0" encoding="UTF-8"?>
<RiskOrderResponseResendRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <OrderIdList>
    <OrderId>4730733066</OrderId>
    <OrderId>4730733067</OrderId>
    <OrderId>4730733068</OrderId>
  </OrderIdList>
</RiskOrderResponseResendRequest>

RiskOrderResponseResendRequest example with only order id

Copy this code sample.

<?xml version="1.0" encoding="UTF-8"?>
<RiskOrderResponseResendRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <OrderIdList>
    <OrderId>4730733066</OrderId>
  </OrderIdList>
</RiskOrderResponseResendRequest>

Request Elements

Element	Required	Description	Type	Restriction
/RiskOrderResponseResendRequest	Yes	The risk order status request with a list of order IDs.	ComplexType
/RiskOrderResponseResendRequest/OrderIdList	Yes	A list of OrderId elements. Contains the list of order IDs for which risk order response should be retriggered.	ComplexType	Minimum of One Order ID and maximum of 1000 order IDs accepted in the request.
/RiskOrderResponseResendRequest/OrderIdList/OrderId	Yes	Order ID. This should be the order ID used in the original RiskAssessmentRequest message.	String	Max 40 characters for each Order ID.

Response Example

Copy this code sample.

<?xml version="1.0" encoding="UTF-8" ?>
<RiskOrderResponseResendReply xsi:schemaLocation="http://api.gsicommerce.com/schema/checkout/1.0 
         Risk-OrderResponseResend-1.0.xsd">
  <OrderResponseDetailsList>
    <OrderResponseDetails>
      <OrderId>4730733066</OrderId>
      <ResendResponseAcknowledgement>false</ResendResponseAcknowledgement>
    </OrderResponseDetails>
    <OrderResponseDetails>
      <OrderId>4730733067</OrderId>           
      <ResendResponseAcknowledgement>false</ResendResponseAcknowledgement>
    </OrderResponseDetails>
    <OrderResponseDetails>
      <OrderId>4730733067</OrderId>
      <ResendResponseAcknowledgement>true</ResendResponseAcknowledgement>
    </OrderResponseDetails>
  </OrderResponseDetailsList>
</RiskOrderResponseResendReply>

Response Elements

Element	Required	Description	Type	Restriction
/RiskOrderResponseResendReply	Yes	The risk order response resend reply includes the order ID and acknowledgement status for each order ID provided in the request. This reply includes only a simple acknowledgement that the responses are re-sent. The responses will be re-sent using the original route by which the responses were sent previously.	ComplexType
/RiskOrderResponseResendReply/OrderResponseDetailsList	Yes	The list of order response details with status.	ComplexType
/RiskOrderResponseResendReply/OrderResponseDetailsList/ OrderResponseDetails	Yes	Sequence of Order Id and ResendResponseAcknowledgement. Each Order Response Details object includes an Order ID and a risk response acknowledgement, which indicates whether or not the response is re-sent using the original route.	ComplexType	Minimum of 1 OrderDetails element and maximum of 1000 OrderDetails elements based on the request order ids.
/RiskOrderResponseResendReply/OrderResponseDetailsList/ OrderResponseDetails/OrderId	Yes	Order Id. This will be the same order id provided in RiskOrderResponseResendRequest.	String	Max 40 characters for each Order Id.
/RiskOrderResponseResendReply/OrderResponseDetailsList/ OrderResponseDetails/ResendResponseAcknowledgement	Yes	A true or false indicating whether the response was retriggered or not.	Boolean	Possible values: 1. true – Indicates that the RiskAssessmentReply was retriggered by Radial to client OMS through the original route they received the response previously or they are supposed to receive the response. 2. false - Indicates that the RiskAssessmentReply was not found in Radial system and thus response is not retriggered.

Integration Details

You can call the RiskOrderResponseResendRequest API if an order doesn’t have a RiskAssessmentReply response or final response to either cancel or approve the order initially.

If your order management system shows a different order status than the one returned by RiskOrderStatusRequest API, you can call RiskOrderResponseResendRequest to receive the Risk Assessment response again.

If the RiskOrderResponseResend response status is true for any particular order, your OMS should look for the Risk Assessment response at the regular channel where you receive RiskAssessmentReply messages.

If the response status is false for any particular order, the RiskAssessmentReply was not found in Radial system and the Risk Assessment response was not retriggered. In that case, you can either retry again or call RiskOrderStatusRequest API to learn the current status of the order. For details, see Risk Order Status API.