POST
Update Ethoca enrollment status
Use this endpoint to request an Ethoca enrollment status transition, such as withdrawing a pending application, disabling an enrolled service, or resubmitting after a failed review.
Request
merchantNoMerchant number assigned by Onerway. It limits the transition to applications under one merchant account.
Example:
replace_with_merchant_noidEnrollment application ID identifying the Ethoca service application to transition.
Example:
replace_with_enrollment_idbillDescMerchant billing descriptor. Provide it when resubmitting or supplementing application information.
Example:
EXAMPLE STORE USresellerSubMerchantIdCondition: Provide this field when an agency operator transitions a sub-merchant application.
Sub-merchant identifier assigned by the agency operator.enrollmentStatusTarget enrollment status to transition to. If omitted, Onerway processes the transition according to
enrollmentEvent.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
- Available transitions depend on the current enrollment status and are controlled by the system.
enrollmentEventEnrollment status transition event, expressing the action requested by this call.
Example:
MERCHANT_RESUBMITAllowed values
MERCHANT_WITHDRAW- Merchant withdraws or disables the service. Use it to withdraw an application that is pending review, or to request disabling an enrolled Ethoca service.
MERCHANT_RESUBMIT- Merchant resubmits the application after enrollment failed or was rejected, usually after correcting issues described in
comments.
notesStatus transition note for the requested action, including withdrawal reasons, resubmission explanations, or supplementary material descriptions.
Example:
Updated billing descriptorsignRequest signature string. See Request signing for how to generate it.
curl -X POST 'https://sandbox-acq.onerway.com/ethoca/agency-cw/enrollment/transition' \
-H 'Content-Type: application/json' \
--data-raw '{
"billDesc": "EXAMPLE STORE US",
"enrollmentEvent": "MERCHANT_RESUBMIT",
"id": "replace_with_enrollment_id",
"merchantNo": "replace_with_merchant_no",
"notes": "Updated billing descriptor",
"sign": "{{SIGN}}"
}'Response
respCode20000 means the transition request was processed successfully. Other values are error codes. See Response codes.respMsgHuman-readable message for the response code.
data{ success, sign }Business data object indicating whether this status transition request was accepted and executed by the system.
Response example
Example code is unavailable.
No error responses are documented for this endpoint.