# Lista de formas de pagamentos

Retorna lista de formas de pagamentos disponíveis.

Endpoint: GET /api/v3/payments
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

## Query parameters:

  - `payments_id` (string)
    Filtra pelos ID das formas de pagamento. Pode passar mais de um ID numérico separado por virgula.
    Example: "1,2,3"

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

  - `fiscal_code` (string)
    Filtra pelo Código Fiscal do método de pagamento.
    Example: "00"

  - `is_default` (boolean)
    Filtra por formas de pagamento padrão.

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

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

  - `updated_from` (string)
    Filtra por dados que foram atualizadas a partir de uma data. (Formato: YYYY-MM-DDThh:mm:ss+hh:mm).

  - `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)

  - `data.payments` (array)
    Representa a lista de formas de pagamentos

  - `data.payments.id` (integer, required)
    Identificador único da um método de pagamento.
    Example: 123

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

  - `data.payments.fiscal_code` (string, required)
    Código fiscal a ser informado na nota fiscal.

Exemplo:

- 01: Dinheiro
- 02: Cheque
- 03: Cartão de Crédito
- 04: Cartão de Débito
- 05: Crédito de Loja
- 10: Vale Alimentação
- 11: Vale Refeição
- 12: Vale Presente
- 13: Vale Combustível
- 14: Duplicata Mercantil
- 15: Boleto Bancário
- 16: Depósito Bancário
- 17: Pagamento Instantâneo (PIX)
- 18: Transferência bancária, Carteira Digital
- 19: Programa de fidelidade, Cashback, Crédito Virtual
- 90: Sem Pagamento
- 99: Outros
    Enum: "01", "02", "03", "04", "05", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "90", "99"

  - `data.payments.is_editable` (boolean)
    Indica se o método de pagamento pode ser editável ou não.
    Example: true

  - `data.payments.allow_installment` (boolean)
    Indica se o método de pagamento permite ou não o parcelamento.
    Example: true

  - `data.payments.created_at` (string)
    Data da última criação.
    Example: "2020-01-01T09:00:00-03:00"

  - `data.payments.updated_at` (string)
    Data da última atualização.
    Example: "2020-01-01T09:00:00-03:00"

  - `meta` (object)
    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