Attempt Return

post

https://api.signifyd.com/v3/orders/events/returns/attempts

Use this endpoint to solicit an evaluation from Signifyd when the customer is requesting a refund, exchange, and/or a return. The response contains the checkpointAction, which will drive any merchant workflow you have configured

Note: using this API does NOT cancel any Guarantee associated with the corresponding order investigation.

To send Signifyd information about return/refund/exchanges that will not be evaluated, use the Record Return API.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

orderId

string

required

The unique identifier for the order. This must be the same order ID originally provided in the Checkout/Sale event.

returnPolicy

string

enum

Defaults to EVALUATE

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

EVALUATE - Specifies that the return request requires an evaluation, generating a response with a score/decision.
INFO_ONLY - Designates an informational return request that does not require evaluation.

Allowed:

returnId

string

required

Unique identifier for the Return.

returnDate

date-time

The time the return occurred. If this field is empty the present time is used instead.

device

object

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

returnedItems

array of objects

A list of products that are going to be returned by the buyer.

returnedItems

replacementItems

object

refund

object

Details about the reimbursement that will be issued to the buyer if the return is approved.

initiator

object

Unique identifier for who initiated the return. This will be used if an internal employee initiated the return.

201

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.

403Response if the authenticated user does not have permission to perform the requested action.

404Response if the requested entity can't be found.

500Response if an unexplained error occurs on the server.