Sign in

v1

latestOpenAPI 3.0.12026-07-26158956.2 KB
Enrollment

Fetch Descriptors (v2)

List every descriptor on your account as a flat, filterable record set: one row per descriptor with its program (ethoca, cdrn, rdr, amex, discover; null for legacy types not tied to a program), status, descriptor name or BIN/CAID, owning merchant id, and timestamps. Filter with program and/or status (case-insensitive; an unknown value returns a 400 listing the valid ones) and paginate with page/per. Use GET /api/enrollment_status for the per-program roll-up instead; record ids feed POST /api/unenroll.

get/api/v2/descriptors

Query parameters

program'ethoca' | 'cdrn' | 'rdr' | 'amex' | 'discover'

Filter by program (case-insensitive).

status'Pending' | 'Enrolled' | 'Disabled' | 'Surpressed' | 'Processing' | 'Rejected' | 'InReview' | 'PendingRemoval'

Descriptor lifecycle state. PendingRemoval means an unenroll was requested for a previously Enrolled descriptor; it stays live until provider de-registration is confirmed, then the record is deleted.

Filter by descriptor status (case-insensitive).

pageinteger

The page to request. Default 1.

perinteger

How many records per page. Default 10, max 1000.

Headers

X-API-Keystring required

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

Response

OK

pageinteger required
perinteger required
totalinteger required