Preparing Data

Data Mapping

Before sending your orders to Signifyd you will need to properly map various data fields from your online store to the Signifyd case schema.

Case API Schema

The Signifyd order schema is broken into a series of objects that correspond to different objects from your online store (products, transactions, shipments, etc). The following diagram depicts the Case API schema:

👍

Tip

If you process payments through Authorize.net, you can use the Signifyd Authorize.net integration to sync payment data automatically.

Mapping Order Data to the Signifyd Case

👍

Tip

We recommend downloading our field mapping document to keep track of which fields map to the Signifyd Create Case API request. This document can also be shared with other stakeholders or decision makers in your company.

1. For each field in the Case API schema identify the applicable field in your online store. Some data fields like payment information (AVS response code, bin, last4, etc.) may require additional development effort to collect and save.
2. Map each field you plan to send to Signifyd to the appropriate field in the Create Case.

EXAMPLE FOR FIELD MAPPING

let order = Object.create()
order.checkoutId = transaction.id
order.orderId = transaction.id
order.device = Object.create( {
  clientIPAddress: self.ipAddress,
  sessionID: self.sessionId,
  …
})

🚧

Important

The Create Case API only requires one field to be present, however, we strongly recommend you provide all of the fields listed as required in the API document to ensure the best guarantee decision.

Please consult your Implementation Manager if you are unable to provide a required field.

Data Transformation

The Create Case API will require some field values to be provided in a specific format for the request to be accepted successfully.

• Dates: must be in ISO 8601 format.
• Countries: must be ISO 3166 format.
• Currencies: must be ISO 4217 format.
• Enums: order channel, shipper, shipping method, payment method, AVS response code, and CVV response code should use the predefined value.
• Valid syntax: browser IP address, confirmation email, and userAccountEmail should have a valid syntax and format.

For expected field values, field types, and formats please refer to the API documentation.

👍

Tip

You can use the AVS and CVV response code reference sheet to determine how to map AVS and CVV response codes for specific payment gateways.