Qodex.ai

Activate/Deactivate a sub-merchant.

PUT {{baseUrl}}/sub-merchants/{{guid}}/states

Returns 204 if merchant is activated/deactivated successfully. It takes a state attribute with two possible values:

  • INACTIVE

    • For LIVE and LOCKEDFOREDIT merchants, this endpoint changes the merchant to INACTIVE status.
    • For CONFIGURATION merchants, it physically deletes the merchant, rather than deactivating it.

  • ACTIVE

    • Reactivates an INACTIVE merchant by placing it in CONFIGURATION status. From there, the flow follows the onboarding process where the merchant is in CONFIGURATION status and its attributes are available for editing.

Request Body

{"state"=>"INACTIVE", "inactivationReason"=>"001 - My business is closing"}

HEADERS

KeyDatatypeRequiredDescription
User-Idstring(Required) The user id of the submitter/technical contact.
Submitter-First-Namestring(Required) The first name of the submitter/technical contact.
Submitter-Last-Namestring(Required) The last name of the submitter/technical contact.
Content-Typestring
Acceptstring