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

# Create a batch of boarding requests

> Creates multiple boarding requests for locations and card acceptors in a single batch operation



## OpenAPI

````yaml /openapi/boarding.json post /v1/boarding
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:
    post:
      tags:
        - Boarding
      summary: Create a batch of boarding requests
      description: >-
        Creates multiple boarding requests for locations and card acceptors in a
        single batch operation
      operationId: createBoardingBatch
      parameters:
        - name: x-acquirer-id
          in: header
          description: Acquirer Identifier
          required: true
          schema:
            type: string
            pattern: ^[A-Za-z]{3}$
            example: ABC
      requestBody:
        content:
          application/json:
            schema:
              maxItems: 1000
              minItems: 1
              type: array
              items:
                $ref: '#/components/schemas/BoardingRequestItem'
        required: true
      responses:
        '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:
    BoardingRequestItem:
      required:
        - location
        - operation
      type: object
      properties:
        operation:
          type: string
          description: Type of operation to perform on a location
          example: CREATE
          enum:
            - CREATE
            - DEACTIVATE_CARD_ACCEPTORS
            - DEACTIVATE_LOCATION
        location:
          $ref: '#/components/schemas/Location'
      description: Request item for boarding operations
    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
    Location:
      required:
        - cardAcceptors
        - locationId
        - mcc
        - name
      type: object
      properties:
        locationId:
          maxLength: 16
          minLength: 1
          pattern: ^[a-zA-Z0-9]*$
          type: string
          description: Location identifier
          example: LOC001
        name:
          maxLength: 128
          minLength: 1
          type: string
          description: Location name
          example: Main Street Store
        cardAcceptors:
          maxItems: 1
          minItems: 1
          type: array
          description: List of card acceptors for this location
          items:
            $ref: '#/components/schemas/CardAcceptor'
        mcc:
          maximum: 9999
          minimum: 742
          type: integer
          description: Merchant Category Code
          format: int32
          example: 5411
        address:
          $ref: '#/components/schemas/Address'
        groupName:
          maxLength: 32
          minLength: 1
          type: string
          description: Group name for the location
          example: East Coast Stores
        contact:
          $ref: '#/components/schemas/Contact'
        bankAccount:
          $ref: '#/components/schemas/BankAccount'
      description: Location data to process
    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
    CardAcceptor:
      required:
        - baseCurrency
        - cardAcceptorId
        - templateId
      type: object
      properties:
        cardAcceptorId:
          maxLength: 16
          minLength: 4
          pattern: ^[a-zA-Z0-9]*$
          type: string
          description: Card acceptor identifier
          example: CA001
        templateId:
          minimum: 1
          type: integer
          description: Template identifier
          format: int32
          example: 1
        description:
          maxLength: 64
          minLength: 1
          type: string
          description: Card acceptor description
          example: Main Terminal
        baseCurrency:
          maximum: 999
          minimum: 1
          type: integer
          description: ISO 4217 currency code
          format: int32
          example: 728
      description: Card acceptor information
    Address:
      type: object
      properties:
        lineOne:
          maxLength: 60
          minLength: 1
          type: string
          description: Address Line One
          example: Apartment 15
        lineTwo:
          maxLength: 60
          minLength: 1
          type: string
          description: Address Line Two
          example: 501 W Glenoaks Blvd
        lineThree:
          maxLength: 60
          minLength: 1
          type: string
          description: Address Line Three
        city:
          maxLength: 32
          minLength: 1
          type: string
          description: City
          example: Glendale
        postalCode:
          maxLength: 20
          minLength: 1
          type: string
          description: Postal Code
          example: '91202'
        country:
          maxLength: 2
          minLength: 2
          pattern: '[a-zA-Z]+'
          type: string
          description: Two letter country as per ISO 31661 standard
          example: IE
        geoLocation:
          $ref: '#/components/schemas/GeoLocation'
      description: Physical address information
    Contact:
      type: object
      properties:
        name:
          maxLength: 60
          minLength: 0
          type: string
          description: Contact name
          example: Jane Smith
        email:
          maxLength: 60
          minLength: 0
          type: string
          description: Contact email address
          example: accounts@merchant.com
      description: Merchant accounting contact
    BankAccount:
      type: object
      properties:
        accountName:
          maxLength: 64
          minLength: 0
          type: string
          description: Account holder name
          example: ACME Payments Ltd
        accountNumber:
          pattern: ^\d{8,15}$
          type: string
          description: Account number (8–15 digits)
          example: '12345678'
        sortCode:
          pattern: ^\d{2}-?\d{2}-?\d{2}$
          type: string
          description: Sort code (6 digits, optional dashes)
          example: 40-30-20
        bankName:
          maxLength: 60
          minLength: 0
          type: string
          description: Bank name
          example: Bank of Ireland
        addressLine1:
          maxLength: 60
          minLength: 0
          type: string
          description: Commission bank address line 1
          example: 1 Main Street
        city:
          maxLength: 32
          minLength: 0
          type: string
          description: Commission bank city
          example: Dublin
        postalCode:
          maxLength: 20
          minLength: 0
          type: string
          description: Commission bank postal code
          example: D02 XY12
        countryName:
          maxLength: 60
          minLength: 0
          type: string
          description: Commission bank country name
          example: Ireland
      description: Commission bank account details
    GeoLocation:
      required:
        - latitude
        - longitude
      type: object
      properties:
        latitude:
          maximum: 90
          exclusiveMaximum: false
          minimum: -90
          exclusiveMinimum: false
          type: number
          format: double
        longitude:
          maximum: 180
          exclusiveMaximum: false
          minimum: -180
          exclusiveMinimum: false
          type: number
          format: double
      description: Geographical coordinates
  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.