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

# Listar provedor de pagamento

> Lista os provedor de pagamento aplicando os filtros informados.



## OpenAPI

````yaml https://payment-ms.supergasbras.app/swagger/v1/swagger.json get /v1/providers
openapi: 3.0.4
info:
  title: Payment
  description: >-
    A API Payment é responsável pelo gerenciamento de comerciantes (merchants), 

    incluindo funcionalidades para adquirentes, provedores, processamento de
    pagamentos, 

    entre outras atividades de pagamento.
  version: v1
  x-logo:
    url: |-
      data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQQAAACaBAMAAAC9PSu+AAAACX
      BIWXMAAA7DAAAOwwHHb6hkAAAAG1BMVEUAAADTMADTMQDTMgDTMQAAAAAAAAAAAAAAAABolM
      biAAAACXRSTlMAQL+A/0CAv/9sbqsWAAAFqklEQVR4nO2ZvXajOhDHhW2wyyTHD5BNeIB7Nj
      zAbswDuLHjkiaY0k0MZZoYHvtqPjQI7LvNngy30L+IQUijHzOjkRwbExQUFBQUFBQUFBQUFB
      QUNJWih2djfr7cTUfwkOcbY7I8/zEZwtoh/J5m/miI8M8EBOkQYaOPkOVDhFydYZ6PEXLtUK
      TXCK+6BHbyK4T8lypCegtB1Q2z/BZC/qiIkN1GUHTDnOfzESA0ud5msWCvZx4CxkavUGfsdE
      GAm1QzEnN2AnwSApSlmWYkeD1gcdjQB0QgVVwTGU0dcfTX/PprxWRgz+PUvzg5OSG1koHjAB
      +Agqlh3RBxu4I4C3Fm3KFTTs9ULR9n/UKgDXruJcWjCsJC6pI7pnCdmKntlmt8+7k4gd1whx
      86SyITBDmrUUmIVBFGXl/TjdqqTHGiRe6dFme52y01EdY+QqSMQO7O/DrECIM2ZQTTlwpFhP
      X/A0GqcZ8LkyHMJ1kRC39DmFNd0ESw7z8oTQspTTpfbjPZEDZ+06hmf6vWsiEMtimjuE0tJP
      D+Zr2RBwqaeadWdMND3h+lH1UQIlqVdGR8uYse3CEyy7X+zxHxoT339SoZoSI6oFAknH7LmV
      JF/C0q8hHuBofJb5f79ui54dFQYLT+5eW+ydE5njOBwNT+65ayGxzD650Z1AkFQQ2iIvQTrp
      6BYCZtKprLq5vo/p627FQ1DhyAzZ9bvlnodX/GB1kXakqpOg8JdP8DTG7INxj8+6dc3wl9SX
      h6ek694qCpeX4l9d9lsjHBBL9PjRgm+GFoxPA6yW+V82xqAqsXRzDdT6UmerEl4enHhD8YBw
      UFBQUF6Sg+nt/hoyzhbl9u4bK0H1Y7Eje9uyG7Y1nw5d5dsRkaYuRq68awRZzIDWYlndUFP+
      G26Qqz7LjNdKQv6tV1NPYNLksaXtmHaLihIXHfka64n7377Ocrja+Gh1whgJkxAnbpH6Plll
      FAHw6h28pg6hfTO/XzjZwAj68RLjcQTmKELCY0m3veCsJJBtPMS+ZP/EbSyqKXzdgLbV2j7a
      47QxLg0xravtBIez7yi6wYa0lmToBQlhV25CGIaA786is7uBx64YB5MM4Fui+M9E3Q3xX8rb
      AxuYj/P9EyDGnR4c4q9WOEhhEq6J74TrCdPyUiAwQD7zRCWMJf9uKWI3vE2xVnJSMsBQHNYD
      NO3s/nB6ItbiPAkBEC9Il9L9qbmOH6tHNO8REsPFk9DNIAtXRL5AbCyeWCj8D9HNnFoKcTZw
      YQdruG0rFgg+ilhOG69n1AQBl8Ka4RYsoFynNGOMjK4WZ420aWCZgBBJsg7bbPhYL9j1fxeD
      0YrjPX6WhfZIywP0JHzAeHAME6YBpQhds6BKprRXJsnNkTZSIVkBHDkZbxCIGmGCBQUi99L1
      ADFqeSCggj0KIsVjxdDNFa0cyVqy+ekgb6UR6xUURAK2faGxhBvOWVMx5okopLk903KmhjhK
      3hpZTwy+/J9lAVjd2i7S0jSDgp7wDBOlpWBOeFq8b8fg6owboGCFKYuk4SueKqPsxJRkgcQn
      3emiuElvz0RWa+sDZ6bgUTcR97QijE+VScxCm9moKdi5Yw0ktJlwHCkuaq0D+Y6c7yl5jpEb
      C0us2JtxWbj3FbmOHCBqBy13DhfbdXlyHCB236uChxkcCrX6Bjx7tA3RBeuTuQM+2AN1fdD2
      4Hp44XiB/P0jtBdq6VAx0g8FsiwhJ97vZC2VzB/5Vrc08pF/DWLWTsL4N79WeR/rDxXwjAe5
      LAFm6VQQgTlxQ9IEUR3UClA4P3JrP0qniJc5H6MH9ASFw2UEd3YoKaU7IZRuiXUyUFlDKkGj
      vBal/XH3RV1jWW70ROiSXJOpSa9jVYjY8ddtzzcRDPj2AG1iwEvcYHdFpMjmfjTovYsWzaDx
      MUFBQUFBQUFBQUFBQUFPT3+hdhiavi0aIAlwAAAABJRU5ErkJggg==
    altText: Logo
servers: []
security:
  - Bearer: []
tags:
  - name: Customers
    description: Representa as informações dos clientes no sistema de pagamento.
  - name: Merchants
    description: Representa as informações dos comerciantes no sistema de pagamento.
  - name: Methods
    description: >-
      Representa as informações dos métodos de pagamento no sistema de
      pagamento.
  - name: Payments
    description: Representa as informações dos clientes no sistema de pagamento.
  - name: Providers
    description: Representa as informações dos comerciantes no sistema de pagamento.
paths:
  /v1/providers:
    get:
      tags:
        - Providers
      summary: Listar provedor de pagamento
      description: Lista os provedor de pagamento aplicando os filtros informados.
      operationId: listProviders
      parameters:
        - name: types
          in: query
          description: Filtra pelos tipos dos provedores de pagamento
          schema:
            type: array
            items:
              enum:
                - none
                - bank
                - acquirer
                - subAcquirer
                - paymentServiceProvider
                - gateway
                - wallet
                - localPayment
              type: string
              example: none
            example:
              - Bank
              - Acquirer
              - SubAcquirer
              - PaymentServiceProvider
              - Gateway
              - Wallet
          example:
            - Bank
            - Acquirer
            - SubAcquirer
            - PaymentServiceProvider
            - Gateway
            - Wallet
        - name: states
          in: query
          description: Filtra pelos estados dos provedores de pagamento do comerciante
          schema:
            type: array
            items:
              enum:
                - enabled
                - disabled
              type: string
              example: enabled
            example:
              - Enabled
          example:
            - Enabled
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderDtoIDataListResponse'
        '400':
          description: Algum parâmetro está faltando ou está incorreto.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorDataResponse'
        '401':
          description: O usuário não está autenticado, o token está expirado ou é inválido.
          content:
            application/json: {}
        '403':
          description: O usuário não tem as permissões necessárias para o acesso.
          content:
            application/json: {}
        '500':
          description: Ocorreu um erro inesperado ao processar a solicitação.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorDataResponse'
components:
  schemas:
    ProviderDtoIDataListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ProviderDto'
          nullable: true
          readOnly: true
      additionalProperties: false
    IErrorDataResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorData'
          nullable: true
          readOnly: true
      additionalProperties: false
    ProviderDto:
      required:
        - code
        - environment
        - id
        - name
        - schema
        - state
        - type
      type: object
      properties:
        name:
          minLength: 1
          type: string
          description: Nome do provedor
          example: Getnet SEP
        code:
          minLength: 1
          type: string
          description: Código do provedor
          example: getnetSep
        type:
          minLength: 1
          enum:
            - none
            - bank
            - acquirer
            - subAcquirer
            - paymentServiceProvider
            - gateway
            - wallet
            - localPayment
          type: string
          description: Tipo do provedor
          example: Gateway
        environment:
          minLength: 1
          enum:
            - physical
            - digital
          type: string
          description: Ambiente do pagamento
          example: Physical
        schema:
          minLength: 1
          type: string
          description: Esquema JSON com as configurações do provedor
        state:
          minLength: 1
          enum:
            - enabled
            - disabled
          type: string
          description: Estado do provedor
          example: Enabled
        id:
          type: string
          description: Identificador do registro
          format: uuid
        createdAt:
          type: string
          format: date-time
        modifiedAt:
          type: string
          format: date-time
          nullable: true
      additionalProperties: false
    ErrorData:
      type: object
      properties:
        code:
          type: string
          nullable: true
        target:
          type: string
          nullable: true
        message:
          type: string
          nullable: true
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: http
      description: Token de acesso `accessToken` obtido do serviço de autenticação.
      scheme: Bearer
      bearerFormat: JWT

````