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

# Retrieve payment method settings

> Recupere as configurações dos métodos de pagamento na sua conta HubSpot. Este endpoint fornece informações sobre a configuração atual dos métodos de pagamento, incluindo seu status de capacidade e moedas aceitas. É útil para entender quais métodos de pagamento estão ativos e seu status padrão.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/2027-03-beta/commerce-payment-methods-v2027-03-beta.json GET /commerce/payment-methods/2027-03-beta/settings
openapi: 3.0.1
info:
  title: Commerce Payment Methods
  description: Basepom for all HubSpot Projects
  version: 2027-03-beta
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Basic
paths:
  /commerce/payment-methods/2027-03-beta/settings:
    get:
      tags:
        - Basic
      summary: Recuperar configurações de método de pagamento
      description: >-
        Recupere as configurações dos métodos de pagamento na sua conta HubSpot.
        Este endpoint fornece informações sobre a configuração atual dos métodos
        de pagamento, incluindo seu status de capacidade e moedas aceitas. É
        útil para entender quais métodos de pagamento estão ativos e seu status
        padrão.
      operationId: get-/commerce/payment-methods/2027-03-beta/settings
      parameters: []
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/CommercePaymentMethodSettingsPublicResponse
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - crm.objects.invoices.read
        - oauth2:
            - crm.schemas.invoices.read
        - oauth2:
            - cpq.quotes.write
        - oauth2:
            - crm.objects.quotes.read
        - oauth2:
            - crm.schemas.quotes.read
        - oauth2:
            - cpq.quotes.read
        - oauth2:
            - crm.schemas.subscriptions.read
        - oauth2:
            - crm.objects.subscriptions.read
components:
  schemas:
    CommercePaymentMethodSettingsPublicResponse:
      required:
        - paymentMethodSettings
      type: object
      properties:
        paymentMethodSettings:
          type: array
          description: >-
            Uma lista de CommercePaymentMethodSettingPublic correspondente a
            métodos de pagamento individuais.
          items:
            $ref: '#/components/schemas/CommercePaymentMethodSettingPublic'
    CommercePaymentMethodSettingPublic:
      required:
        - activeCurrencies
        - commercePaymentMethod
        - isDefaultOn
        - supportedCurrencies
      type: object
      properties:
        activeCurrencies:
          type: array
          description: >-
            Uma lista de moedas que estão ativas nesta conta e são compatíveis
            com o commercePaymentMethod agrupado. Os valores válidos estão
            vinculados às opções de várias moedas disponíveis na conta.
          example: USD,CAD,EUR,MXN
          items:
            type: string
            enum:
              - USD
              - AED
              - AFN
              - ALL
              - AMD
              - ANG
              - AOA
              - ARS
              - AUD
              - AWG
              - AZN
              - BAM
              - BBD
              - BDT
              - BIF
              - BMD
              - BND
              - BOB
              - BRL
              - BSD
              - BWP
              - BYN
              - BZD
              - CAD
              - CDF
              - CHF
              - CLP
              - CNY
              - COP
              - CRC
              - CVE
              - CZK
              - DJF
              - DKK
              - DOP
              - DZD
              - EGP
              - ETB
              - EUR
              - FJD
              - FKP
              - GBP
              - GEL
              - GIP
              - GMD
              - GNF
              - GTQ
              - GYD
              - HKD
              - HNL
              - HRK
              - HTG
              - HUF
              - IDR
              - ILS
              - INR
              - ISK
              - JMD
              - JPY
              - KES
              - KGS
              - KHR
              - KMF
              - KRW
              - KYD
              - KZT
              - LAK
              - LBP
              - LKR
              - LRD
              - LSL
              - MAD
              - MDL
              - MGA
              - MKD
              - MMK
              - MNT
              - MOP
              - MRO
              - MUR
              - MVR
              - MWK
              - MXN
              - MYR
              - MZN
              - NAD
              - NGN
              - NIO
              - NOK
              - NPR
              - NZD
              - PAB
              - PEN
              - PGK
              - PHP
              - PKR
              - PLN
              - PYG
              - QAR
              - RON
              - RSD
              - RUB
              - RWF
              - SAR
              - SBD
              - SCR
              - SEK
              - SGD
              - SHP
              - SLE
              - SLL
              - SOS
              - SRD
              - STD
              - SZL
              - THB
              - TJS
              - TOP
              - TRY
              - TTD
              - TWD
              - TZS
              - UAH
              - UGX
              - UYU
              - UZS
              - VND
              - VUV
              - WST
              - XAF
              - XCD
              - XOF
              - XPF
              - YER
              - ZAR
              - ZMW
              - BGN
              - BHD
              - BOV
              - BTN
              - CHE
              - CHW
              - CLF
              - COU
              - CUC
              - CUP
              - ERN
              - GHS
              - IQD
              - IRR
              - JOD
              - KPW
              - KWD
              - LYD
              - MRU
              - MXV
              - OMR
              - SDG
              - SSP
              - STN
              - SVC
              - SYP
              - TMT
              - TND
              - USN
              - UYI
              - VEF
              - XAG
              - XAU
              - XBA
              - XBB
              - XBC
              - XBD
              - XDR
              - XPD
              - XPT
              - XSU
              - XUA
              - ZWL
        commercePaymentMethod:
          type: string
          description: >-
            O tipo de método de pagamento. Os valores válidos incluem 'CASH',
            'CHECK', 'WIRE_TRANSFER', 'CARD', 'ACH', 'SEPA', 'BACS', 'PADS',
            'KLARNA', 'AFFIRM' e 'OTHER'.
          enum:
            - ACH
            - AFFIRM
            - BACS
            - CARD
            - CASH
            - CHECK
            - KLARNA
            - OTHER
            - PADS
            - SEPA
            - WIRE_TRANSFER
        isDefaultOn:
          type: boolean
          description: >-
            Um booleano que indica se este método de pagamento está definido
            como a opção padrão.
        supportedCurrencies:
          type: array
          description: >-
            Uma lista completa das moedas compatíveis com o
            commercePaymentMethod agrupado.
          example: USD,EUR,CAD,MXN
          items:
            type: string
            enum:
              - USD
              - AED
              - AFN
              - ALL
              - AMD
              - ANG
              - AOA
              - ARS
              - AUD
              - AWG
              - AZN
              - BAM
              - BBD
              - BDT
              - BIF
              - BMD
              - BND
              - BOB
              - BRL
              - BSD
              - BWP
              - BYN
              - BZD
              - CAD
              - CDF
              - CHF
              - CLP
              - CNY
              - COP
              - CRC
              - CVE
              - CZK
              - DJF
              - DKK
              - DOP
              - DZD
              - EGP
              - ETB
              - EUR
              - FJD
              - FKP
              - GBP
              - GEL
              - GIP
              - GMD
              - GNF
              - GTQ
              - GYD
              - HKD
              - HNL
              - HRK
              - HTG
              - HUF
              - IDR
              - ILS
              - INR
              - ISK
              - JMD
              - JPY
              - KES
              - KGS
              - KHR
              - KMF
              - KRW
              - KYD
              - KZT
              - LAK
              - LBP
              - LKR
              - LRD
              - LSL
              - MAD
              - MDL
              - MGA
              - MKD
              - MMK
              - MNT
              - MOP
              - MRO
              - MUR
              - MVR
              - MWK
              - MXN
              - MYR
              - MZN
              - NAD
              - NGN
              - NIO
              - NOK
              - NPR
              - NZD
              - PAB
              - PEN
              - PGK
              - PHP
              - PKR
              - PLN
              - PYG
              - QAR
              - RON
              - RSD
              - RUB
              - RWF
              - SAR
              - SBD
              - SCR
              - SEK
              - SGD
              - SHP
              - SLE
              - SLL
              - SOS
              - SRD
              - STD
              - SZL
              - THB
              - TJS
              - TOP
              - TRY
              - TTD
              - TWD
              - TZS
              - UAH
              - UGX
              - UYU
              - UZS
              - VND
              - VUV
              - WST
              - XAF
              - XCD
              - XOF
              - XPF
              - YER
              - ZAR
              - ZMW
              - BGN
              - BHD
              - BOV
              - BTN
              - CHE
              - CHW
              - CLF
              - COU
              - CUC
              - CUP
              - ERN
              - GHS
              - IQD
              - IRR
              - JOD
              - KPW
              - KWD
              - LYD
              - MRU
              - MXV
              - OMR
              - SDG
              - SSP
              - STN
              - SVC
              - SYP
              - TMT
              - TND
              - USN
              - UYI
              - VEF
              - XAG
              - XAU
              - XBA
              - XBB
              - XBC
              - XBD
              - XDR
              - XPD
              - XPT
              - XSU
              - XUA
              - ZWL
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: A categoria de erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Um identificador exclusivo para a solicitação. Inclua este valor em
            relatórios de erro ou tickets de suporte
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: mais informações sobre o erro
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um mapa de nomes de links para URIs associados que contêm
            documentação sobre o erro ou as etapas de correção recomendadas
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa uma resposta de erro retornada pela API quando uma operação
        falha. Este componente é usado em vários endpoints para fornecer
        informações detalhadas sobre o erro encontrado.
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: O código de status associado ao detalhe do erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: O nome do campo ou parâmetro no qual o erro foi encontrado.
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa informações detalhadas sobre um erro ocorrido na API. Este
        componente é usado para fornecer contexto e detalhes adicionais sobre os
        erros, geralmente como parte de uma resposta de erro.
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            cpq.quotes.read: ''
            cpq.quotes.write: ''
            crm.objects.invoices.read: ''
            crm.objects.quotes.read: ''
            crm.objects.subscriptions.read: ''
            crm.schemas.invoices.read: ''
            crm.schemas.quotes.read: ''
            crm.schemas.subscriptions.read: ''

````