Sale

post

https://api.signifyd.com/v3/orders/events/sales

The Sale endpoint in Signifyd's API is used to record a Sale Event, which represents the completion of a purchase flow and the associated payment authorization in a PostAuth workflow.

Use this endpoint to register an order in the Signifyd system. If an order was previously created using a Checkout or Sale event, calling this endpoint again with the same orderID will update and/or overwrite the order details and generate a new decision. The date and time when the order was placed (purchase.createdAt) is settable only once per order; if the order already exists, any purchase.createdAt sent in this request will not update the stored value.

The orderId value acts as a primary key and should be consistent across all purchase attempts related to the same order. A consistent orderId enables Signifyd to accurately deduplicate purchases and provide reliable performance metrics. If your system cannot provide a consistent orderId across multiple purchase attempts, please contact your Signifyd implementations manager to discuss alternative deduplication strategies.

If Decision Center is enabled, policies for Sale events can be configured at the Sale checkpoint, and they will be applied to orders created via requests to this endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

orderId

string

required

Unique identifier for the order.

purchase

object

required

Details about the products that were purchased and how the purchase was made.

userAccount

object

needed An object containing key details used to evaluate the legitimacy of a user account and its associated activity during a transaction. This includes user account data such as email address, account creation date, and other relevant attributes. These details are crucial for identifying patterns that may indicate suspicious or potentially fraudulent behavior.

memberships

array of objects

The membership object should be used to indicate the use of a buyer’s rewards, discounts, or admission programs during the purchase. Common uses include but are not limited to, memberships like Costco, Amazon Prime, Walmart+, and Airline Frequent Flyer programs. This object is conceptually distinct from userAccount whose attributes relate to the online account that was used by the buyer to complete the purchase; it's what the buyer "logs in to". You would never login to a "membership".

memberships

coverageRequests

array of strings

needed The types of coverages requested. If no coverage object is provided or is empty, coverage will be set to the team's default policy.
For further information please contact your Signifyd Implementation manager.

FRAUD - use when you need a financial guarantee for Payment Fraud.
INR - use when you need a financial guarantee for Item Not Received.
SNAD - use when you need a financial guarantee for fraud alleging items are Significantly Not As Described.
ALL - use when you need a financial guarantee on all chargebacks.
NONE - use when you do not need a financial guarantee. Suggested actions in decision.checkpointAction are recommendations.

coverageRequests

Allowed:

merchantCategoryCode

string

A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. An MCC is used to classify every business that accepts card payments by the goods or services it provides. The MCC is provided by payment processors on authorizations.

decisionDelivery

string

enum

Defaults to ASYNC_ONLY

Specify SYNC if you require the Response to contain a decision field. If you have registered a webhook endpoint associated with this checkpoint, then a response will be sent to the webhook endpoint even if SYNC is specified.
If ASYNC_ONLY is specified, then the decision field in the response will be null, and you will need to register a webhook endpoint to receive Signifyd's final decision via webhook.

Allowed:

device

object

Data about the device that was used by the user to complete the actions.

merchantPlatform

object

Details about the merchant's commerce platform.

signifydClient

object

For internal use only. Provides Signifyd details about the Signifyd plugin that a merchant is using.

transactions

array of objects

A list of payment authorizations that were attempted to pay for the order.

transactions

decisionMechanism

string

enum

Defaults to SIGNIFYD_RECOMMENDATION

This field specifies how the decision returned in the decision field will be made.

SIGNIFYD_RECOMMENDATION - Use when you would like Signifyd's model recommendation to be the default decision.checkpointAction. Your Decision Center policies will still run and potentially override the Signifyd recommendation.
POLICY_ONLY_ACCEPT - Use when you only want your Decision Center policies to determine the decision with no recommendation provided by Signifyd. If no policy conditions match the evaluated order, then a decision.checkpointAction of ACCEPT will be returned. This value can only be used when the request's coverageRequests value is set to NONE.
INFO_ONLY - Use when you want to send transactions to Signifyd but not have a decision returned. This value can only be used when the request's coverageRequests value is set to NONE.

Allowed:

sellers

array of objects

Use only if you operate a marketplace (e.g. eBay) and allow other merchants to list and sell products on the online store. A seller is an online account for the merchant or business that listed and sold the product(s) on the order.

sellers

201A 201 response is returned when the request resulted in the creation of a new Order in the Signifyd system or for a successful update of an existing Order. You will also receive a webhook response if you have webhooks configured.

400Response if there was a problem with the request, such as when a required field is missing or otherwise fails validation.

401Response if the provided authentication credentials are not known or do not match what is on file for the specified user.

500Response if an unexplained error occurs on the server.