Onerway
POST

Query Ethoca alerts

View as Markdown
Use this endpoint to retrieve Ethoca alerts, match each alert to the original transaction, and check the latest handling outcome and refund status.

Request

merchantNostringrequired
Merchant number assigned by Onerway. It limits the query to one merchant account.
Example:replace_with_merchant_no
ethocaIdstringoptional
Unique Ethoca alert identifier. Submit it to query one alert precisely.
Example:replace_with_ethoca_id
alertTypesstringoptional
Alert type filter. Different alert types represent customer dispute, fraud, or chargeback risk sources.
Example:ChargebackAlert
Allowed values
CustomerDispute
Customer dispute alert.
FraudAlert
Fraud alert.
ChargebackAlert
Chargeback alert.
alertTimeStartstringoptional
Condition: Provide this field when filtering by alert creation time range.
Start of the alert creation time range, in yyyy-MM-dd HH:mm:ss format.
Example:2025-02-02 13:22:26
alertTimeEndstringoptional
Condition: Provide this field when filtering by alert creation time range.
End of the alert creation time range, in yyyy-MM-dd HH:mm:ss format.
Example:2025-04-03 13:22:26
txnTimeStartstringoptional
Condition: Provide this field when filtering by original transaction time range.
Start of the original transaction time range, in yyyy-MM-dd HH:mm:ss format.
txnTimeEndstringoptional
Condition: Provide this field when filtering by original transaction time range.
End of the original transaction time range, in yyyy-MM-dd HH:mm:ss format.
outcomeUpdatedTimeStartstringoptional
Condition: Provide this field when filtering by alert outcome update time range.
Start of the alert outcome update time range, in yyyy-MM-dd HH:mm:ss format.
outcomeUpdatedTimeEndstringoptional
Condition: Provide this field when filtering by alert outcome update time range.
End of the alert outcome update time range, in yyyy-MM-dd HH:mm:ss format.
billDescstringoptional
Merchant billing descriptor used to filter alert records.
resellerSubMerchantIdstringConditional
Condition: Required when an agency operator queries alert records for its sub-merchants.
Sub-merchant identifier assigned by the agency operator.
outcomeListstringoptional
Alert outcome filter, used to distinguish handled and pending alerts.
Example:in_progress,previously_refunded
Allowed values
stopped
Order stopped.
partially_stopped
Order partially stopped.
previously_cancelled
Transaction previously cancelled.
Constraints
Rule
Submit one or more outcomes. Separate multiple values with commas.
currentstringrequired
Query page number, starting from 1.
Example:1
signstringrequired
Request signature string. See Request signing for how to generate it.

Request example

curl -X POST 'https://sandbox-acq.onerway.com/ethoca/agency-cw/detail-page' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "alertTypes": "ChargebackAlert",
  "current": "1",
  "merchantNo": "replace_with_merchant_no",
  "outcomeList": "in_progress,previously_refunded",
  "sign": "{{SIGN}}"
}'

Response

respCodestring
20000 means the query request was processed successfully. Other values are error codes. See Response codes.
respMsgstring
Human-readable message for the response code.
Business data object containing Ethoca alerts and pagination information.

Response example

Example code is unavailable.

No error responses are documented for this endpoint.

Update Ethoca enrollment status

Withdraw an Ethoca application, request service disablement, or resubmit a failed enrollment.

Submit Ethoca alert outcome

Submit the handling outcome and refund status for an Ethoca alert.