---
title: "Lista todos os métodos de pagamento disponíveis."
method: GET
path: "/v1/payment_methods"
tags: ["payment_methods"]
---

# Lista todos os métodos de pagamento disponíveis.

`GET /v1/payment_methods`

## Request

- Base URL: `//app.vindi.com.br/api` (relative, and the document’s source URL is not known)
- URL: `//app.vindi.com.br/api/v1/payment_methods`
- Auth: HTTP basic

Métodos de pagamento representam as opções de pagamento disponíveis para seus clientes. Leia a documentação sobre [paginação](http://atendimento.vindi.com.br/hc/pt-br/articles/203020644#pagination) e [filtros de busca](http://atendimento.vindi.com.br/hc/pt-br/articles/204163150).

#### Atributos para busca
<code>id</code>, <code>name</code> e <code>code</code>.

## Query parameters

- `page` integer
- `per_page` integer
- `query` string
- `sort_by` 'id' | 'name' | 'code'
- `sort_order` 'asc' | 'desc'

## Response `200`

Consulta realizada com sucesso.

- PaymentMethod[]
  - `id` integer, required: ID do método de pagamento
  - `public_name` string, required: Nome público do método de pagamento
  - `name` string, required: Nome interno do método de pagamento
  - `code` string, required: Código externo para referência via API
  - `type` string, required: Tipo do método de pagamento
  - `status` 'active' | 'inactive' | 'deleted', required: Status do método de pagamento
  - `settings` string: Configurações específicas do método de pagamento
  - `set_subscription_on_success` 'do_not_set' | 'set_without_authorization' | 'set_with_authorization' | 'legacy', required: Se configurado como "set_without_authorization", assinaturas pagas com sucesso através deste método serão automaticamente atribuídas ao mesmo
  - `allow_as_alternative` string, required: Indica se este método de pagamento será oferecido como alternativa para cobranças emitidas usando outros métodos
  - `payment_companies` PaymentCompany[]: Lista de bandeiras ou bancos habilitados para este método de pagamento
    - `id` integer, required: ID da bandeira ou banco
    - `name` string, required: Nome da bandeira ou banco
    - `code` string, required: Código para referência via API
  - `maximum_attempts` integer: Número máximo de tentativas automáticas de cobrança para este método de pagamento
  - `created_at` string, required: Data e hora do cadastro do método de pagamento
  - `updated_at` string, required: Data e hora da última atualização do método de pagamento

## Other responses

- `400`: Erro de sintaxe JSON no corpo do request.
- `422`: Parâmetros inválidos. Verificar erro na resposta.

---

[API](https://skmtc.dev/vindi/apis/api-vindi.md) - [All operations](https://skmtc.dev/vindi/apis/api-vindi/llms.txt) - [OpenAPI document](https://skmtc.dev/vindi/apis/api-vindi/revisions/3e857e1cdd03?raw)