> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.erp.olist.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar meios de recebimento

> Lista os meios de recebimento (bancos e gateways) da empresa, sem paginação. Meios com configuração incompleta ou inválida não são retornados: bancos sem configuração bancária ou com código de banco desconhecido e gateways sem gateway válido.



## OpenAPI

````yaml https://erp.olist.com/public-api/v3/swagger/swagger-mintlify.json get /meios-recebimento
openapi: 3.0.0
info:
  title: Olist ERP API v3
  description: >-
    Documentação completa: <a href="https://api-docs.erp.olist.com"
    target="_blank">https://api-docs.erp.olist.com</a>
  version: '3.1'
servers:
  - url: https://api.tiny.com.br/public-api/v3
security: []
paths:
  /meios-recebimento:
    get:
      tags:
        - Meios de recebimento
      summary: Listar meios de recebimento
      description: >-
        Lista os meios de recebimento (bancos e gateways) da empresa, sem
        paginação. Meios com configuração incompleta ou inválida não são
        retornados: bancos sem configuração bancária ou com código de banco
        desconhecido e gateways sem gateway válido.
      operationId: ListarMeiosRecebimentoAction
      parameters:
        - $ref: '#/components/parameters/tipoListarMeiosRecebimento'
        - $ref: '#/components/parameters/bancoListarMeiosRecebimento'
        - $ref: '#/components/parameters/gatewayListarMeiosRecebimento'
        - $ref: '#/components/parameters/situacaoListarMeiosRecebimento'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - itens
                properties:
                  itens:
                    type: array
                    items:
                      $ref: '#/components/schemas/MeioRecebimentoResponseModel'
                type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDTO'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
        '503':
          description: Service Unavailable
      security:
        - bearerAuth: []
components:
  parameters:
    tipoListarMeiosRecebimento:
      name: tipo
      in: query
      description: |-
        Pesquisa pelo tipo do meio de recebimento
        - banco - Banco
        - gateway - Gateway
      required: false
      schema:
        enum:
          - banco
          - gateway
      x-enumDescriptions:
        - banco - Banco
        - gateway - Gateway
    bancoListarMeiosRecebimento:
      name: banco
      in: query
      description: |-
        Pesquisa pelo código do banco. Retorna apenas meios do tipo banco
        - 001 - Banco Brasil
        - 033 - Santander
        - 041 - Banrisul
        - 104 - Caixa Sicob
        - 104_SIGCB - Caixa Sigcb
        - 237 - Bradesco
        - 341 - Itau
        - 399 - Hsbc
        - 748 - Sicredi
        - 756 - Sicoob
        - 004 - Banco Nordeste
        - 422 - Banco Safra
        - 136 - Unicred Brasil
        - 091 - Unicred
        - 197 - Stone
        - 077 - Banco Inter
        - 509 - Olist Bank
        - 509_GUEST - Olist Bank Convidado
        - Outro
      required: false
      schema:
        enum:
          - '001'
          - '033'
          - '041'
          - '104'
          - 104_SIGCB
          - '237'
          - '341'
          - '399'
          - '748'
          - '756'
          - '004'
          - '422'
          - '136'
          - '091'
          - '197'
          - '077'
          - '509'
          - 509_GUEST
          - OUTRO
      x-enumDescriptions:
        - 001 - Banco Brasil
        - 033 - Santander
        - 041 - Banrisul
        - 104 - Caixa Sicob
        - 104_SIGCB - Caixa Sigcb
        - 237 - Bradesco
        - 341 - Itau
        - 399 - Hsbc
        - 748 - Sicredi
        - 756 - Sicoob
        - 004 - Banco Nordeste
        - 422 - Banco Safra
        - 136 - Unicred Brasil
        - 091 - Unicred
        - 197 - Stone
        - 077 - Banco Inter
        - 509 - Olist Bank
        - 509_GUEST - Olist Bank Convidado
        - Outro
    gatewayListarMeiosRecebimento:
      name: gateway
      in: query
      description: |-
        Pesquisa pelo gateway. Retorna apenas meios do tipo gateway
        - 1 - Pagarme
        - 2 - Moip
        - 3 - Paypal
        - 4 - Olistpay
        - 5 - Pagarme V2
        - 6 - Stonepos
        - 7 - Smarttef Cielo
        - 8 - Smarttef Rede
        - 9 - Smarttef Getnet
        - 10 - Smarttef Safrapay
        - 11 - Smarttef Pagbank
        - 12 - Smarttef Vero
        - 13 - Smarttef Bin
        - 14 - Smarttef Sicredi
        - 15 - Smarttef Caixa
        - 16 - Smarttef Sipag
        - 17 - Smarttef Picpay
        - 18 - Smarttef Redeflex
        - 99 - Outro
      required: false
      schema:
        enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          - 7
          - 8
          - 9
          - 10
          - 11
          - 12
          - 13
          - 14
          - 15
          - 16
          - 17
          - 18
          - 99
      x-enumDescriptions:
        - 1 - Pagarme
        - 2 - Moip
        - 3 - Paypal
        - 4 - Olistpay
        - 5 - Pagarme V2
        - 6 - Stonepos
        - 7 - Smarttef Cielo
        - 8 - Smarttef Rede
        - 9 - Smarttef Getnet
        - 10 - Smarttef Safrapay
        - 11 - Smarttef Pagbank
        - 12 - Smarttef Vero
        - 13 - Smarttef Bin
        - 14 - Smarttef Sicredi
        - 15 - Smarttef Caixa
        - 16 - Smarttef Sipag
        - 17 - Smarttef Picpay
        - 18 - Smarttef Redeflex
        - 99 - Outro
    situacaoListarMeiosRecebimento:
      name: situacao
      in: query
      description: |-
        Pesquisa pela situação do meio de recebimento
        - 1 - Habilitado
        - 2 - Desabilitado
      required: false
      schema:
        enum:
          - 1
          - 2
      x-enumDescriptions:
        - 1 - Habilitado
        - 2 - Desabilitado
  schemas:
    MeioRecebimentoResponseModel:
      title: ' '
      description: ' '
      required:
        - id
        - nome
        - tipo
        - situacao
        - formas
        - detalhes
      properties:
        id:
          type: integer
        nome:
          type: string
        tipo:
          description: |-

            - banco - Banco
            - gateway - Gateway
          type: string
          enum:
            - banco
            - gateway
          x-enumDescriptions:
            - banco - Banco
            - gateway - Gateway
        situacao:
          description: |-

            - 1 - Habilitado
            - 2 - Desabilitado
          type: integer
          enum:
            - 1
            - 2
          nullable: true
          x-enumDescriptions:
            - 1 - Habilitado
            - 2 - Desabilitado
        formas:
          description: >-
            Formas de recebimento disponíveis no meio, na ordem configurada. Os
            valores correspondem ao campo forma da listagem de formas de
            recebimento
          type: array
          items:
            type: integer
        detalhes:
          discriminator:
            propertyName: tipo
            mapping:
              banco: '#/components/schemas/MeioRecebimentoBancoDetalheResponseModel'
              gateway: '#/components/schemas/MeioRecebimentoGatewayDetalheResponseModel'
          oneOf:
            - $ref: '#/components/schemas/MeioRecebimentoBancoDetalheResponseModel'
            - $ref: '#/components/schemas/MeioRecebimentoGatewayDetalheResponseModel'
      type: object
    ErrorDTO:
      title: ' '
      description: ' '
      properties:
        mensagem:
          description: Mensagem de erro geral
          type: string
          example: Ocorreram erros de validação
        detalhes:
          description: Detalhes específicos do erro
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetailDTO'
          example:
            - campo: codigo
              mensagem: O campo código é obrigatório
          nullable: true
      type: object
    MeioRecebimentoBancoDetalheResponseModel:
      title: ' '
      description: ' '
      required:
        - tipo
        - banco
        - descricao
      properties:
        tipo:
          type: string
          enum:
            - banco
        banco:
          description: |-

            - 001 - Banco Brasil
            - 033 - Santander
            - 041 - Banrisul
            - 104 - Caixa Sicob
            - 104_SIGCB - Caixa Sigcb
            - 237 - Bradesco
            - 341 - Itau
            - 399 - Hsbc
            - 748 - Sicredi
            - 756 - Sicoob
            - 004 - Banco Nordeste
            - 422 - Banco Safra
            - 136 - Unicred Brasil
            - 091 - Unicred
            - 197 - Stone
            - 077 - Banco Inter
            - 509 - Olist Bank
            - 509_GUEST - Olist Bank Convidado
            - Outro
          type: string
          enum:
            - '001'
            - '033'
            - '041'
            - '104'
            - 104_SIGCB
            - '237'
            - '341'
            - '399'
            - '748'
            - '756'
            - '004'
            - '422'
            - '136'
            - '091'
            - '197'
            - '077'
            - '509'
            - 509_GUEST
            - OUTRO
          x-enumDescriptions:
            - 001 - Banco Brasil
            - 033 - Santander
            - 041 - Banrisul
            - 104 - Caixa Sicob
            - 104_SIGCB - Caixa Sigcb
            - 237 - Bradesco
            - 341 - Itau
            - 399 - Hsbc
            - 748 - Sicredi
            - 756 - Sicoob
            - 004 - Banco Nordeste
            - 422 - Banco Safra
            - 136 - Unicred Brasil
            - 091 - Unicred
            - 197 - Stone
            - 077 - Banco Inter
            - 509 - Olist Bank
            - 509_GUEST - Olist Bank Convidado
            - Outro
        descricao:
          type: string
      type: object
    MeioRecebimentoGatewayDetalheResponseModel:
      title: ' '
      description: ' '
      required:
        - tipo
        - gateway
        - descricao
      properties:
        tipo:
          type: string
          enum:
            - gateway
        gateway:
          description: |-

            - 1 - Pagarme
            - 2 - Moip
            - 3 - Paypal
            - 4 - Olistpay
            - 5 - Pagarme V2
            - 6 - Stonepos
            - 7 - Smarttef Cielo
            - 8 - Smarttef Rede
            - 9 - Smarttef Getnet
            - 10 - Smarttef Safrapay
            - 11 - Smarttef Pagbank
            - 12 - Smarttef Vero
            - 13 - Smarttef Bin
            - 14 - Smarttef Sicredi
            - 15 - Smarttef Caixa
            - 16 - Smarttef Sipag
            - 17 - Smarttef Picpay
            - 18 - Smarttef Redeflex
            - 99 - Outro
          type: integer
          enum:
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 9
            - 10
            - 11
            - 12
            - 13
            - 14
            - 15
            - 16
            - 17
            - 18
            - 99
          x-enumDescriptions:
            - 1 - Pagarme
            - 2 - Moip
            - 3 - Paypal
            - 4 - Olistpay
            - 5 - Pagarme V2
            - 6 - Stonepos
            - 7 - Smarttef Cielo
            - 8 - Smarttef Rede
            - 9 - Smarttef Getnet
            - 10 - Smarttef Safrapay
            - 11 - Smarttef Pagbank
            - 12 - Smarttef Vero
            - 13 - Smarttef Bin
            - 14 - Smarttef Sicredi
            - 15 - Smarttef Caixa
            - 16 - Smarttef Sipag
            - 17 - Smarttef Picpay
            - 18 - Smarttef Redeflex
            - 99 - Outro
        descricao:
          type: string
      type: object
    ErrorDetailDTO:
      title: ' '
      description: ' '
      properties:
        campo:
          description: Campo que gerou o erro
          type: string
          example: codigo
        mensagem:
          description: Mensagem de erro específica do campo
          type: string
          example: O campo código é obrigatório
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: Bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.