Onerway
POST

Query Ethoca enrollments

View as Markdown
Use this endpoint to retrieve Ethoca enrollment applications, check whether the alert service is enabled, and review comments for failed or rejected applications.

Request

merchantNostringrequired
Merchant number assigned by Onerway. It limits the query to one merchant account.
Example:replace_with_merchant_no
idstringoptional
Enrollment application ID. Submit it to query one application record precisely.
Example:replace_with_enrollment_id
preDisputeServicestringoptional
Service associated with the enrollment application.
Example:ETHOCA_ALERT
Allowed values
ETHOCA_ALERT
Ethoca alert service.
Constraints
Values
Submit ETHOCA_ALERT when querying Ethoca enrollments.
billDescstringoptional
Merchant billing descriptor used to filter enrollment records.
resellerSubMerchantIdstringoptional
Condition: Provide this field when an agency operator queries sub-merchant application records.
Sub-merchant identifier assigned by the agency operator.
enrollmentStatusListstringoptional
Filter enrollment applications by status.
Example:ENROLLED,DISENROLLED
Allowed values
PENDING_SUBMISSION
Pending submission. The application has been created but has not been submitted for review.
SUBMITTED_AND_PENDING_ENROLLMENT
Submitted and pending enrollment. The application has been submitted and is waiting for review and enrollment processing.
ENROLLING
Enrolling. The application passed review and alert-service enrollment configuration is in progress.
Constraints
Rule
Specify one or more enrollment statuses. Separate multiple values with commas.
createTimeStartstringoptional
Condition: Provide this field when filtering by application creation time range.
Start of the application creation time range, in yyyy-MM-dd HH:mm:ss format.
Example:2025-03-20 16:08:28
createTimeEndstringoptional
Condition: Provide this field when filtering by application creation time range.
End of the application creation time range, in yyyy-MM-dd HH:mm:ss format.
Example:2025-03-27 16:08:28
updateTimeStartstringoptional
Condition: Provide this field when filtering by update time range.
Start of the application update time range, in yyyy-MM-dd HH:mm:ss format.
updateTimeEndstringoptional
Condition: Provide this field when filtering by update time range.
End of the application update time range, in yyyy-MM-dd HH:mm:ss format.
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/enrollment/page' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "current": "1",
  "enrollmentStatusList": "ENROLLED,DISENROLLED",
  "merchantNo": "replace_with_merchant_no",
  "preDisputeService": "ETHOCA_ALERT",
  "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 enrollment records and pagination information.

Response example

Example code is unavailable.

No error responses are documented for this endpoint.

Submit Ethoca enrollment

Submit an application to enable the Ethoca alert service for a merchant or agency sub-merchant.

Update Ethoca enrollment status

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