Aurora API: Fraud Result Add

The Fraud Result Add API method allows you to add fraud results to an order.

This article provides an example request, along with a response to get you started.

Fraud Result

This API can be used to add fraud results to an existing order only.

Add

Deferred: No

Example Request:

<?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope>
  <Header>
    <AuthToken>...</AuthToken>
  </Header>
  <Requests>
    <Request>
      <Fraud>
        <Result>
          <Add>
            <OrderID>90027892879</OrderID>
            <Name>Fraud Check</Name>
            <Action>OK</Action>
            <Score>80</Score>
            <Rules>
              <Rule>
                <Name>Fraud Rule 1</Name>
                <Score>12</Score>
              </Rule>
              <Rule>
                <Name>Fraud Rule 2</Name>
                <Score>34</Score>
              </Rule>
            </Rules>
          </Add>
        </Result>
      </Fraud>
    </Request>
  </Requests>
</AuroraRequestEnvelope>

Example Response:

<AuroraResponseEnvelope>
  <Header>
    <Summary>
      <Ack>OK</Ack>
      <RequestsProcessed>1</RequestsProcessed>
      <RequestsSucceeded>1</RequestsSucceeded>
      <RequestErrors>0</RequestErrors>
    </Summary>
  </Header>
  <Responses>
    <Response>
      <RequestID>1</RequestID>
      <Ack>OK</Ack>
      <Data>
        <FraudResultID>12356</FraudResultID>
      </Data>
    </Response>
  </Responses>
</AuroraResponseEnvelope>

Example Response (unsuccessful):

<AuroraResponseEnvolope>
     <Header>
         <Summary>
             <Ack>OK</Ack>
             <RequestsProcessed>1</RequestsProcessed>
             <RequestsSucceeded>0</RequestsSucceeded>
             <RequestErrors>1</RequestErrors>
         </Summary>
     </Header>
     <Responses>
        <Response>
             <RequestID>1</RequestID>
             <Ack>FATAL</Ack>
             <Errors>
                 <Error>
                     <Code>-9</Code>
                     <Message>Record not found: Order ID: 90027892879</Message>
                     <Severity>FATAL</Severity>
                 </Error>
             </Errors>
         </Response>
     </Responses>
</AuroraResponseEnvolope>

Add Method - Request Fields

FieldValuesAPI VersionDescriptionRequired
OrderIDString1.5+The unique order ID.Yes
NameString1.5+The name of the fraud result, which must be between 1 and 20 characters in length.Yes
ActionInteger1.5+The action to be taken, this can be one of: OK, HOLD or REJECTYes
ScoreInteger1.5+The overall score for the fraud result, which must be between -32768 and 32767.No
RulesContainer1.5+No
RuleContainer1.5+No
NameInteger1.5+The rule name, which must be between 1 and 150 characters in length.No
ScoreInteger1.5+The rule score, which must be between -32768 and 32767.No