# Lista métodos de pagamento

Lista os métodos de pagamento vinculados ao aplicativo.

Endpoint: GET /api/v3/apps/{appId}/payment-methods
Version: 3.0.0
Security: OAuth2

## Header parameters:

  - `CPlug-Company-Id` (number, required)
    Id da Empresa (Company).

Você pode localizar os IDs das empresas no _endpoint_ de listagem de empresas.
    Example: 12

## Path parameters:

  - `appId` (integer, required)
    ID do aplicativo.

## Query parameters:

  - `page` (number)
    Indica a página da paginação.

  - `per_page` (number)
    Indica a quantidade de itens por página.

  - `name` (string)
    Filtra pelo nome do método de pagamento.
    Example: "pix"

  - `deleted` (string)
    Filtro para indicar se deve retornar dados apagados ou não.
    Enum: "not_include", "include", "only"

## Response 200 fields (application/json):

  - `data` (object, required)

  - `data.app_payment_methods` (array, required)
    Lista de métodos de pagamento do aplicativo.

  - `data.app_payment_methods.id` (integer, required)
    Identificador único do método de pagamento.
    Example: 1

  - `data.app_payment_methods.name` (string, required)
    Nome do método de pagamento.
    Example: "Dinheiro"

  - `data.app_payment_methods.type` (string, required)
    Tipo do método de pagamento.
    Enum: "MONEY", "CREDIT", "DEBIT", "OTHERS"

  - `data.app_payment_methods.installment_settings` (array, required)
    Configurações de parcelamento do método de pagamento.

  - `data.app_payment_methods.installment_settings.installment` (object, required)
    Representa uma configuração de parcelamento do método de pagamento.

  - `data.app_payment_methods.installment_settings.installment.min` (integer, required)
    Quantidade mínima de parcelas.
    Example: 1

  - `data.app_payment_methods.installment_settings.installment.max` (integer, required)
    Quantidade máxima de parcelas.
    Example: 5

  - `data.app_payment_methods.installment_settings.installment.days_between` (integer)
    Dias entre as parcelas. Deve estar presente se e somente se o max seja maior que 1.
    Example: 30

  - `data.app_payment_methods.installment_settings.card_brand` (object)
    Bandeira do cartão.

Caso null, significa que essa regra de cálculo se aplica a todos as outras bandeiras aceitas
pelo método de pagamento, ou que o método de pagamento não aceita bandeiras.

  - `data.app_payment_methods.installment_settings.card_brand.id` (integer)
    Identificador único da bandeira.
    Example: 123

  - `data.app_payment_methods.installment_settings.card_brand.name` (string)
    Nome da bandeira.
    Example: "Master"

  - `data.app_payment_methods.installment_settings.card_brand.icon` (string)
    ícone da bandeira.
    Example: "mastercard.png"

  - `data.app_payment_methods.installment_settings.card_brand.nfe_code` (string)
    Código da NFe da bandeira.
    Example: "02"

  - `data.app_payment_methods.installment_settings.rate` (number, required)
    Taxa(%) da parcela.
    Example: 0.85

  - `data.app_payment_methods.installment_settings.fare` (object, required)
    Tarifa da parcela.

  - `data.app_payment_methods.installment_settings.fare.amount` (number, required)
    Valor expresso como um número decimal das principais unidades monetárias
    Example: 99.95

  - `data.app_payment_methods.installment_settings.fare.currency` (string, required)
    Código de moeda de 3 letras conforme definido pela ISO-4217
    Example: "BRL"

  - `data.app_payment_methods.installment_settings.days_first_payment` (integer, required)
    Dias para o 1º pagamento.
    Example: 15

  - `data.app_payment_methods.fiscal_code` (string, required)
    Código fiscal do método de pagamento.
    Example: "01"

  - `data.app_payment_methods.is_installment_allowed` (boolean, required)
    Indica se o método de pagamento permite parcelamento.

  - `data.app_payment_methods.created_at` (string, required)
    Data da criação.
    Example: "2025-06-23T19:15:27.000000Z"

  - `data.app_payment_methods.updated_at` (string, required)
    Data da última atualização.
    Example: "2025-06-23T19:15:27.000000Z"

  - `meta` (object, required)
    Representa as informações de Metadado da paginação da listagem.

  - `meta.current_page` (integer, required)
    Página atual na paginação.
    Example: 1

  - `meta.last_page` (integer, required)
    Quantidade total de páginas.
    Example: 10

  - `meta.per_page` (integer, required)
    Quantidade de resultados por página.
    Example: 20

  - `meta.total` (integer, required)
    Quantidade total de itens.
    Example: 200

## Response 400 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "missing_headers"

  - `message` (string)
    Descrição do erro.
    Example: "error message"

  - `meta` (array)
    Dados adicionais sobre o erro.

## Response 422 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "uneditable_entity"

  - `message` (string)
    Descrição do erro.
    Example: "description error"

  - `meta` (array)
    Dados adicionais sobre o erro.

  - `meta.field` (string, required)
    Nome do campo no qual existe um erro de validação.
    Example: "name"

  - `meta.validations` (array)

  - `meta.validations.type` (string, required)
    Tipo da validação aplicada.
    Example: "Required"

  - `meta.validations.value` (array)
    Tipo de valor aplicável (esse campo pode ser vazio).


## Response 401 fields

## Response 404 fields