> ## 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 status

> Retrieves the status of a boarding batch



## OpenAPI

````yaml /openapi/boarding.json get /v1/boarding/{boardingId}
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}:
    get:
      tags:
        - Boarding
      summary: Get boarding status
      description: Retrieves the status of a boarding batch
      operationId: getBoardingStatus
      parameters:
        - name: boardingId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - 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/StatusResponse'
        '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:
    StatusResponse:
      required:
        - batchSummary
        - boardingId
        - status
        - submittedAt
      type: object
      properties:
        boardingId:
          type: string
          description: Unique identifier for the boarding process
          format: uuid
          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 batch was submitted
          example: '2023-10-15T14:30:45.123Z'
        completedAt:
          type: string
          description: Timestamp when the batch was completed
          example: '2023-10-15T14:30:45.123Z'
        batchSummary:
          $ref: '#/components/schemas/BatchSummary'
    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
    BatchSummary:
      required:
        - completed
        - errors
        - total
        - warnings
      type: object
      properties:
        total:
          minimum: 1
          type: integer
          description: Total number of items in the batch
          format: int32
          example: 5
        completed:
          minimum: 0
          type: integer
          description: Number of completed items in the batch
          format: int32
          example: 5
        errors:
          minimum: 0
          type: integer
          description: Number of items with errors in the batch
          format: int32
          example: 5
        warnings:
          minimum: 0
          type: integer
          description: Number of items with warnings in the batch
          format: int32
          example: 5
    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.