Sign in

v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB
Actions

Update fraud order status

Update the fraud provider with the fraud order status.

post/merchant/workflows/{workflowCode}/executions/{executionId}/orderUpdate

Path parameters

workflowCodestring required

Machine-friendly code of Workflow.

Path parameter to specify the workflow code.

executionIdstring uuid required

Identifier of the resource in Payrails.

Headers

x-idempotency-keystring uuid required

Idempotency key to be used. Sending again the same key would return the same result without re-executing the update.

Request body

status'customerCancelled' | 'failed' | 'fullyDelivered' | 'fullyReplaced' | 'fullyReturned' | 'fullyShipped' | 'merchantCancelled' | 'noShow' | 'partiallyDelivered' | 'partiallyReplaced' | 'partiallyReturned' | 'partiallyShipped' | 'pending' | 'processing' required

Value of Fraud Order status enumeration.

Response

Fraud order status update was requested.

name'fraudUpdate' required

Triggers fraud updates for payment(s) related to the execution.

actionIdstring uuid required

Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same actionId.

workspaceIdstring uuid

Unique identifier of a workspace in Payrails.

executedAtstring date-time required

Date and time when execution of the Action was started.

requestIdstring uuid

Unique identifier for this request's execution.