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

# Get boarding summary status

> Retrieves the summary status of a boarding batch with filtering and pagination



## OpenAPI

````yaml /openapi/boarding.json get /v1/boarding/{boardingId}/summary
openapi: 3.0.1
info:
  title: Boarding API
  description: API for managing boarding operations including locations and card acceptors
  contact:
    name: Boarding API Support
    email: boarding-support@fexco.com
  license:
    name: Commercial License
  version: 1.0.0
servers:
  - url: https://{your-base-url}
    description: Base URL provided by Fexco during onboarding
security: []
tags:
  - name: Boarding
    description: Endpoints for location boarding operations
externalDocs:
  description: Boarding Service Documentation
  url: https://developers.fexco.com
paths:
  /v1/boarding/{boardingId}/summary:
    get:
      tags:
        - Boarding
      summary: Get boarding summary status
      description: >-
        Retrieves the summary status of a boarding batch with filtering and
        pagination
      operationId: getBoardingSummary
      parameters:
        - name: boardingId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: severity
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
        - name: page
          in: query
          required: false
          schema:
            minimum: 1
            type: integer
            format: int32
            default: 1
        - name: pageSize
          in: query
          required: false
          schema:
            maximum: 100
            minimum: 1
            type: integer
            format: int32
            default: 50
        - name: x-acquirer-id
          in: header
          description: Acquirer Identifier
          required: true
          schema:
            type: string
            pattern: ^[A-Za-z]{3}$
            example: ABC
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BoardingSummaryResponse'
        '202':
          description: Boarding requests accepted for processing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoardingResponse'
        '400':
          description: Invalid request parameters
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - security_auth: []
components:
  schemas:
    BoardingSummaryResponse:
      required:
        - boardingId
        - pagination
      type: object
      properties:
        boardingId:
          type: string
          description: Unique identifier for the boarding process
          format: uuid
          example: f47ac10b-58cc-4372-a567-0e02b2c3d479
        locations:
          type: array
          description: List of locations involved in the boarding process
          nullable: true
          items:
            $ref: '#/components/schemas/LocationSummary'
        pagination:
          $ref: '#/components/schemas/PaginationData'
      description: Response containing boarding process summary information
    BoardingResponse:
      required:
        - boardingId
        - status
        - submittedAt
      type: object
      properties:
        boardingId:
          type: string
          description: Unique identifier for the boarding process
          example: f47ac10b-58cc-4372-a567-0e02b2c3d479
        status:
          type: string
          description: Current status of the boarding process
          example: PENDING
        submittedAt:
          type: string
          description: Timestamp when the boarding was submitted
          example: '2023-10-15T14:30:45.123Z'
      description: Response containing boarding submission details
    ErrorResponse:
      required:
        - errors
        - status
        - submittedAt
      type: object
      properties:
        status:
          type: string
          description: Response status
          example: ERROR
        submittedAt:
          type: string
          description: Timestamp when the request was submitted
          example: '2023-10-15T14:30:45.123Z'
        errors:
          type: array
          description: List of errors
          items:
            $ref: '#/components/schemas/Error'
      description: Standard error response structure
    LocationSummary:
      required:
        - locationId
        - status
      type: object
      properties:
        locationId:
          type: string
          description: Unique identifier for the location
          example: LOC_001
        status:
          type: string
          description: Current processing status of the location
          example: COMPLETED
          enum:
            - PENDING
            - PROCESSING
            - COMPLETED
            - COMPLETED_WITH_WARNINGS
            - FAILED
        errors:
          type: array
          description: List of errors encountered during processing
          nullable: true
          items:
            $ref: '#/components/schemas/Error'
        warnings:
          type: array
          description: List of warnings encountered during processing
          nullable: true
          items:
            $ref: '#/components/schemas/Error'
      description: Summary information for a location in a boarding process
      nullable: true
    PaginationData:
      required:
        - page
        - size
        - totalElements
      type: object
      properties:
        page:
          minimum: 1
          type: integer
          description: Current page number (1-based)
          format: int32
          example: 1
        size:
          minimum: 1
          type: integer
          description: Number of items per page
          format: int32
          example: 20
        totalElements:
          minimum: 0
          type: integer
          description: Total number of items available across all pages
          format: int64
          example: 157
      description: Pagination information for paginated responses
    Error:
      required:
        - code
        - message
      type: object
      properties:
        code:
          pattern: ^[A-Z][A-Z0-9_]{2,49}$
          type: string
          description: Error code identifier
          example: VALIDATION_ERROR
        title:
          maxLength: 100
          minLength: 0
          type: string
          description: Short error title
          example: Invalid Input
        message:
          maxLength: 500
          minLength: 0
          type: string
          description: Detailed error message
          example: The provided location ID format is invalid
      description: Error information
  securitySchemes:
    security_auth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /v1/oauth/accesstoken
          scopes: {}

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.