openapi: 3.1.0
info:
  title: Get Bin
  description: Get first 8 digits of a card
  version: 25R1.0
paths:
  /admin/card/getBin:
    post:
      tags:
        - bin
      description: Get BIN
      operationId: getBIN
      parameters:
        - name: Api-Key
          in: header
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetBINRequest'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBINResponse'

components:
  schemas:
    GetBINRequest:
      required:
        - service
        - principal
      type: object
      properties:
        issuerCode:
          maxLength: 5
          minLength: 5
          type: string
          description: Issuer code
        principal:
          $ref: '#/components/schemas/RefPrincipal'
        requestId:
          type: string
          description: Request ID
          format: String
        service:
          maxLength: 255
          minLength: 1
          type: string
          description: Calling service
          format: String
        subIssuerCode:
          maxLength: 5
          minLength: 5
          type: string
          description: sub issuer code
      description: GetBINRequest DTO resource representation
    GetBINResponse:
      type: object
      properties:
        service:
          maxLength: 255
          minLength: 1
          type: string
          description: Calling service
          format: String
        issuerCode:
          type: string
          description: Issuer Code
          format: String of 5 digits
        subIssuerCode:
          type: string
          description: Sub Issuer Code
          format: String of 5 digits
        bin:
          type: string
          description: First 8 digits of PAN
      description: GetBINResponse DTO resource representation
    RefPrincipal:
      type: object
      properties:
        type:
          type: string
          description: "Principal type : 'cardId', 'tokenPan', 'vPan', 'tokenVPan' or 'cardHolderId'"
          format: PrincipalType object
          enum:
            - tokenPan
            - cardHolderId
            - tokenVPan
            - vPan
            - cardId
        value:
          type: string
          description: Principal value
          format: "String of 1 to 255 characters\nFor «vPan» type : String\
                \ of 15 to 19 digits.\n\n«tokenPan» or «tokenVPan» : String of 15 to 50 characters\n\n«cardHolderId»:\
                \ String of 10 to 30 characters\n«cardId»: String of 36 characters, standard representation of a UUID"
      description: principal
      format: RefPrincipal object