Skip to main content
POST
Unenroll Merchant

Headers

X-API-Key
string
required

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

Body

application/json

Descriptors to unenroll. Supply descriptor_ids; a single legacy descriptor_id is also accepted and folded into the list.

descriptor_ids
string[]

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

descriptor_id
string | null

Legacy single descriptor id. Prefer descriptor_ids.

Response

Unenrollment queued.

removed
string[]
required

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

queued
string[]
required

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

skipped
string[]
required

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

notFound
string[]
required

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

unenrolled
string[]
required

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