v1

latestOpenAPI 3.0.12026-07-26158956.2 KB

Enrollment

Unenroll Merchant

Unenroll one or more descriptors. Pass descriptor_ids (obtain ids from GET /api/v2/descriptors); a single legacy descriptor_id is also accepted. Descriptors that were still Pending (never live with the provider) are removed immediately and returned under removed. Descriptors that were live are marked PendingRemoval — a visible "removing" state on the API and dashboard — and returned under queued; Chargeblast completes the provider-side de-registration (Ethoca ~48 hours, RDR ~2 weeks, CDRN ~24 hours), after which the record is deleted and your settings reflect the removal. Any ids that do not belong to your account are returned under notFound.

post/api/unenroll

Headers

X-API-Keystring required

Your API key. Sent in the X-API-Key header.

Request body

descriptor_idsstring[]

Descriptor ids to unenroll, e.g. desc_xxxxxxxxxxxxx. Obtain them from GET /api/v2/descriptors.

descriptor_idstring nullable

Legacy single descriptor id. Prefer descriptor_ids.

Response

Unenrollment queued.

removedstring[] required

Descriptor ids that were still Pending (never live with the provider) and so were removed immediately.

queuedstring[] required

Descriptor ids that were live and are now marked PendingRemoval. They stay visible until Chargeblast confirms provider de-registration, then they are removed.

skippedstring[] required

Owned descriptor ids left untouched because their status was not actionable (Processing / InReview, or already-terminal Disabled / Rejected / Surpressed). Distinct from notFound.

notFoundstring[] required

Requested ids that did not match a descriptor on your account.

unenrolledstring[] required

Deprecated: use removed and queued. Retained as their union (all descriptor ids acted on) for backward compatibility.