---
title: "Fetch Descriptors"
method: GET
path: "/api/descriptors"
tags: ["Enrollment"]
---

# Fetch Descriptors

`GET /api/descriptors`

Fetch all the descriptors for your merchants.

## Headers

- `X-API-Key` string, required

## Response `200`

OK

- EmbedDescriptorsResponseDTO
  - `descriptors` PayshieldDescriptorDTO[], required
    - `id` string, nullable
    - `hasEmailSent` boolean, required
    - `type` 'Ethoca' | 'CDRN' | 'RDR' | 'Discover' | 'AMEX' | 'JCB' | 'Unknown' | '', required
    - `bankMid` string, nullable
    - `status` 'Pending' | 'Enrolled' | 'Disabled' | 'Surpressed' | 'Processing' | 'Rejected' | 'InReview' | 'PendingRemoval', required — 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.
    - `site` PayshieldSiteDTO, required
      - `retailer` PayshieldRetailerDTO, required
        - `sites` PayshieldSiteDTO[], required
        - `name` string, nullable
        - `rcode` string, nullable
        - `user` UserDTO, required
          - `hubspotId` string, nullable
          - `pfStripeId` string, nullable
          - `tokens` RutterTokenDTO[], required
            - `externalId` string, nullable
            - `connectionId` string, required
            - `accessToken` string, required
            - `platformToken` string, nullable
            - `id` string, nullable
            - `storeUniqueName` string, required
            - `isReady` boolean, required
            - `status` 'active' | 'inactive', required
            - `publicToken` string, required
            - `platform` string, required
          - `svixId` string, nullable
          - `id` string, nullable
          - `fromInvite` boolean, nullable
          - `referralCode` string, nullable
          - `merchantId` string, nullable
          - `phonenumber` string, nullable
          - `stripeId` string, nullable
          - `utmSource` string, nullable
          - `agentDeal` AgentDealDTO[], required
            - `agentPayload` object, required
            - `id` string, nullable
            - `createdAt` string, date-time, nullable
          - `internalCompany` string, nullable
          - `invitations` InvitationDTO[], required
            - `email` string, required
            - `status` 'Pending' | 'Accepted'
            - `id` string, nullable
            - `createdAt` string, date-time, nullable
            - `permission` 'manager' | 'analyst' | 'admin' | 'refundAnalyst' | 'any' | 'unknown', required
          - `announcements` AnnouncementDTO[], required
            - `message` string, required
            - `id` string, nullable
            - `type` 'Error' | 'Warning' | 'Success', required
          - `accounts` CBAccountDTO[], required
            - `id` string, nullable
            - `email` string, nullable
          - `isBilledForResolved` boolean, nullable
          - `risk` 'High' | 'Medium' | 'Low'
          - `internalId` string, nullable
          - `email` string, nullable
          - `settings` UserSettingsDTO
            - `id` string, nullable
            - `settings` Settings
              - …
          - `createdAt` string, date-time, nullable
          - `name` string, nullable
          - `company` string, nullable
          - `admin` boolean, nullable
          - `isSalesAgent` boolean, nullable
        - `verifiRiskLevel` 'High' | 'Medium' | 'Low'
        - `verifi_name` string, nullable
        - `source` 'Banks' | 'Ethoca' | 'Verifi'
        - `merchant_id` string, nullable
        - `id` string, nullable
      - `descriptors` PayshieldDescriptorDTO[], required
      - `id` string, nullable
      - `name` string, required
    - `details` DescriptorDetails, required
      - `type` string, required

---

[API](https://skmtc.net/chargeblast/apis/chargeblast-api.md) · [All operations](https://skmtc.net/chargeblast/apis/chargeblast-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/chargeblast/chargeblast-api/versions/9cc519753b33/schema)