> ## 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 do comerciante > Lista os provedor de pagamento do comerciante aplicando os filtros informados. ## OpenAPI ````yaml https://payment-ms.supergasbras.app/swagger/v1/swagger.json get /v1/merchants/{merchantId}/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/merchants/{merchantId}/providers: get: tags: - Providers summary: Listar provedor de pagamento do comerciante description: >- Lista os provedor de pagamento do comerciante aplicando os filtros informados. operationId: listMerchantProviders parameters: - name: merchantId in: path description: Identificador da comerciante required: true schema: type: string format: uuid - name: limit in: query description: Número de registros a serem retornados schema: type: integer format: int64 example: 50 example: 50 - name: offset in: query description: >- Número do começo de registros a serem retornados. **Nota:** Limitado a 10.000 registros. Recomendamos a utilização do `keyset` para paginação continua. schema: type: integer format: int64 example: 0 example: 0 - name: keyset in: query description: >- Identificador usado para paginação baseada em cursor. **Nota:** Somente será considerado caso o valor do campo `offset` seja 0. schema: type: string example: cGl0OmJXRnBibDlwYm1SbGVDNXdjbWx0WVhKNTpbMTcwMDAwMDAwMDAwMF0= example: cGl0OmJXRnBibDlwYm1SbGVDNXdjbWx0WVhKNTpbMTcwMDAwMDAwMDAwMF0= - name: states in: query description: Filtra pelos estados dos provedores de pagamento 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/MerchantProviderDtoIPaginatedDataResponse' '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: MerchantProviderDtoIPaginatedDataResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MerchantProviderDto' nullable: true readOnly: true pagination: $ref: '#/components/schemas/IPaginationData' additionalProperties: false IErrorDataResponse: type: object properties: errors: type: array items: $ref: '#/components/schemas/ErrorData' nullable: true readOnly: true additionalProperties: false MerchantProviderDto: required: - code - enabledMethods - id - merchant - methods - name - priority - provider - state type: object properties: merchant: $ref: '#/components/schemas/IdentityDto' provider: $ref: '#/components/schemas/ProviderSummaryDto' code: minLength: 1 type: string description: Código do provedor readOnly: true example: getnetSep name: minLength: 1 type: string description: Nome do provedor example: Getnet SEP priority: type: integer description: Prioridade do provedor format: int32 example: 1 methods: type: array items: type: string description: Tipos dos métodos de pagamento habilitados para o provedor example: - Credit enabledMethods: type: array items: $ref: '#/components/schemas/MethodSummaryDto' description: Métodos de pagamento habilitados para o provedor credentials: type: object additionalProperties: {} description: Credenciais do provedor nullable: true example: type: GETNET_SEP sellerId: 2921abbe-fb28-427c-882e-2258d98b4b39 clientApiKey: da52e0c1-d87d-46e2-b7f2-fc4cd9f6a8d3 clientSecret: 8186a258-d2ab-4275-8349-34884f1b882e acquirer: type: object additionalProperties: {} description: Configurações da Adquirente nullable: true example: merchantId: 2921abbe-fb28-427c-882e-2258d98b4b39 brands: - Mastercard - Visa attributes: type: object additionalProperties: nullable: true description: Atributos customizados de chave e valor nullable: true example: externalId: '123456' 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 IPaginationData: type: object properties: limit: type: integer format: int64 offset: type: integer format: int64 keyset: type: string nullable: true count: type: integer format: int64 totalCount: type: integer format: int64 additionalProperties: false ErrorData: type: object properties: code: type: string nullable: true target: type: string nullable: true message: type: string nullable: true additionalProperties: false IdentityDto: required: - id type: object properties: id: type: string description: Identificador do registro format: uuid additionalProperties: false description: Identificador genérico ProviderSummaryDto: required: - code - environment - id - name - type type: object properties: id: type: string description: Identificador do provedor format: uuid example: e71f2762-e4c4-4ef6-8764-02b97f347ec4 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: Digital resolutionKey: type: string description: Chave de resolução do provedor nullable: true additionalProperties: false MethodSummaryDto: required: - environment - name - type type: object properties: name: minLength: 1 type: string description: Nome do método de pagamento example: Dinheiro type: minLength: 1 type: string description: Tipo do método de pagamento example: Cash environment: minLength: 1 enum: - physical - digital type: string description: Ambiente do pagamento example: Physical additionalProperties: false securitySchemes: Bearer: type: http description: Token de acesso `accessToken` obtido do serviço de autenticação. scheme: Bearer bearerFormat: JWT ````