> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chargeblast.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Enrollment Status

> Report your merchant's enrollment status for every program (Ethoca, CDRN, RDR, Amex, Discover). Each entry is `none`, `pending`, or `enrolled`. Enrollment via the API files a request, so a program stays `pending` until the provider-side enrollment confirms (which flips it to `enrolled`). The contributing descriptor records are included so you can correlate by descriptor name or BIN/CAID.



## OpenAPI

````yaml get /api/enrollment_status
openapi: 3.0.1
info:
  title: Chargeblast API
  version: 0.1.0
servers:
  - url: https://api.chargeblast.com
security: []
tags:
  - name: Credit Requests
  - name: Sync Data
  - name: Alerts
  - name: Enrollment
paths:
  /api/enrollment_status:
    get:
      tags:
        - Enrollment
      summary: Enrollment Status
      description: >-
        Report your merchant's enrollment status for every program (Ethoca,
        CDRN, RDR, Amex, Discover). Each entry is `none`, `pending`, or
        `enrolled`. Enrollment via the API files a request, so a program stays
        `pending` until the provider-side enrollment confirms (which flips it to
        `enrolled`). The contributing descriptor records are included so you can
        correlate by descriptor name or BIN/CAID.
      operationId: enrollment-status
      parameters:
        - name: X-API-Key
          required: true
          in: header
          schema:
            type: string
          description: Your API key. Sent in the `X-API-Key` header.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnrollmentStatusResponse'
        '401':
          description: Missing or invalid API key.
components:
  schemas:
    EnrollmentStatusResponse:
      type: object
      required:
        - programs
      properties:
        programs:
          type: array
          items:
            $ref: '#/components/schemas/ProgramEnrollmentStatus'
          description: Per-program enrollment status, one entry per program.
    ProgramEnrollmentStatus:
      type: object
      required:
        - program
        - status
        - descriptors
        - arns
      properties:
        program:
          type: string
          description: 'Program name: `ethoca`, `cdrn`, `rdr`, `amex`, or `discover`.'
        status:
          $ref: '#/components/schemas/ProgramAggregateStatus'
        descriptors:
          type: array
          items:
            $ref: '#/components/schemas/EnrollmentStatusDescriptor'
          description: The descriptor records contributing to this program's status.
        arns:
          type: array
          items:
            type: string
          description: >-
            RDR ARNs on file for the account. ARNs are stored on merchant
            settings rather than as descriptor records (RDR is confirmed at the
            BIN/CAID merchant level, not per ARN), so they are surfaced here for
            visibility. Always empty for non-RDR programs.
    ProgramAggregateStatus:
      type: string
      enum:
        - none
        - pending
        - enrolled
      description: >-
        Aggregate enrollment state for a program: `none` (nothing on file),
        `pending` (requested, awaiting provider confirmation), `enrolled` (live
        with the provider).
    EnrollmentStatusDescriptor:
      type: object
      required:
        - status
      properties:
        id:
          type: string
          nullable: true
          description: Descriptor record id.
        status:
          $ref: '#/components/schemas/PayshieldDescriptorDescriptorStatus'
        descriptorName:
          type: string
          nullable: true
          description: >-
            Billing descriptor name (Ethoca / CDRN / Amex / Discover). Null for
            RDR, which is keyed by BIN/CAID.
        bin:
          type: string
          nullable: true
          description: Card BIN (RDR only).
        caid:
          type: string
          nullable: true
          description: Card Acceptor ID (RDR only).
    PayshieldDescriptorDescriptorStatus:
      type: string
      enum:
        - Pending
        - Enrolled
        - Disabled
        - Surpressed
        - Processing
        - Rejected
        - InReview
        - PendingRemoval
      description: >-
        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.

````