Create PostSale Requested Action

Use this to log the initiation of a return, refund, exchange, or appeasement request.

This call captures the buyer's intent, allows for Signifyd evaluation (when desired), and anchors all downstream updates and feedback.

Call this endpoint when:

  • A buyer initiates a return from a self-service portal
  • A support agent logs a refund request via phone/chat/email
  • A return is triggered internally (e.g., loyalty appeasement, waiver)

If needed, use the infoOnly flag to specify that no Signifyd evaluation should take place.

This is required as the first step in most real-time return and refund flows.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

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

string
required

Unique identifier for this return, refund, or appeasement request.

boolean
Defaults to false

Set to true to skip evaluation and record for analytics only. Use false to request a decision. If no value sent, set to false by default.

date-time

Timestamp of when the request was initiated. Defaults to current time if not provided.

Formatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601."

device
object

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

items
array of objects

Array of items included in the post-sale action. Each item represents a return, exchange, or appeasement initiated by the buyer or agent.

items
requestedRefund
object

Object detailing the expected refund amount and currency.

initiator
object

Unique identifier for who initiated the post-sale action. This will be used if an internal employee initiated the post-sale action.

tags
array of strings

Optional labels or categories to provide context for analytics or reporting.

tags
Headers
int64

The team id requested for authentication. This should normally be omitted, as it's only relevant when auth credentials allow requests for multiple teams.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json