Take action on a scan in boarding, reported, or auto-reported status

Request
Security:
st_portal_auth
(write:scan)
path Parameters
scanId
required
integer <int64>

the unique Id of the Scan

Example: 567890
Request Body schema: application/json

Object containing actions to take upon a scan

action
string (ScanActionType)

An action to be taken against a scan

Enum: "CORRECTED" "APPEAL" "TERMINATE" "BOARD" "DISCARD"
reason
string (ScanActionReason)

A reason for the action taken against the scan

Responses
200

successful operation

400

Bad Request. The request parameters (or body) were malformed or invalid. Fix the issues with the request and try again.

401

Unauthorized request. Make sure token was included and is valid and try again.

403

Forbidden. You are not permitted to access the requested resource.

404

Not Found. The specified resource (or resource referred to by id) was not found

405

Method Not Allowed. The API was accessed with the wrong method

429

Too Many Requests. The API is rate-limited. Wait and try your request again.

500

Internal Server Error. An unexpected error has occurred. This may be due to a transient error. Retry the request and if the issue persists, please contact support.

503

Service Unavailable. The service is temporarily unavailable. Try your request later.

post/wrm/v1/scans/{scanId}/actions
Request samples
application/json
{
  • "action": "CORRECTED",
  • "reason": "This merchant has been identified as non-compliant to the terms of service"
}
Response samples
application/json
{
  • "scanId": 2,
  • "actionTaken": "CORRECTED"
}