# Liste todos os métodos de pagamento

Liste todos os métodos de pagamento associados à sua conta.

Endpoint: GET /payment_methods
Version: 1.0.0
Security: ApiKeyAuth, ApiKeySecret

## Query parameters:

  - `page` (integer)
    Um número de página dentro do conjunto de resultados paginados.
    Example: 1

  - `limit` (integer)
    Indica quantos resultados retornar por página. Por padrão, retornamos 20 resultados por página.

ℹ️ O número mínimo de resultados retornados por página é 1 e o máximo é 100. Se você inserir um valor maior que 100, nossa API usará o valor máximo (100) por padrão.
    Example: 15

  - `search` (string)
    Retorne resultados que correspondam à reference que você pesquisou.

Nota:
Este filtro suporta consultas de pesquisa completas e parciais. Por exemplo, pesquisar por trai pode corresponder aos seguintes valores (extraídos do campo reference):

- Awesome training sneakers
- Training equipment
    Example: "trai"

  - `customer_id` (string)
    O identificador único criado pela Belvo usado para referenciar o cliente.
    Example: "0d1a377b-b4c5-4a94-9e2e-83e59d1f6a9c"

  - `type` (string)
    O tipo de conta. Pode ser:

  - bank_account
    Usado para a maioria das contas bancárias.
    Enum: "bank_account"

## Response 200 fields (application/json):

  - `items` (array)
    Um array de objetos de método de pagamento do cliente.

  - `items.id` (string)
    O identificador único criado pela Belvo usado para referenciar o método de pagamento.
    Example: "3118128a-6792-4b06-bd61-4acf6f6ad6b5"

  - `items.createdDate` (string,null)
    O timestamp ISO-8601 quando o cliente foi criado no banco de dados da Belvo.
    Example: "2022-02-09T08:45:50.406032Z"

  - `items.lastUpdatedDate` (string,null)
    O carimbo de data e hora ISO-8601 quando as informações sobre o cliente foram atualizadas pela última vez.
    Example: "2022-02-09T08:45:50.406032Z"

  - `items.status` (string)
    O status do método de pagamento pode ser:

- pending_agreement_acceptance
  O método precisa ser aceito pelo proprietário da conta bancária. Isso pode ser feito enviando um Link de Configuração para o proprietário ou utilizando nosso recurso de API de Acordos.
  
- waiting_for_activation_response
  O proprietário aceitou o método de pagamento. Os arquivos de registro e cobrança foram gerados.
  A instituição financeira agora precisa enviar uma resposta sobre as informações da conta bancária (OK ou Não OK).
  
- active
  A instituição financeira confirmou com sucesso o registro da conta bancária. O método de pagamento agora pode ser usado para solicitações de pagamento.
  Nota: O status pode mudar para inactive se o proprietário cancelar ou remover o método de pagamento na instituição financeira.
  
- error
  A instituição financeira não conseguiu confirmar o registro da conta bancária (geralmente devido ao proprietário fornecer informações incorretas da conta bancária ou um erro na instituição financeira).
  
- inactive
  O método de pagamento não pode ser usado. Isso geralmente ocorre quando o proprietário cancela sua conta e a instituição financeira nos informa que o método não é mais válido.
    Enum: "pending_agreement_acceptance", "waiting_for_activation_response", "active", "error", "inactive"

  - `items.type` (string)
    O tipo de conta. Para o México, esse valor é definido como bank_account.
    Enum: same as `type` (1 values)

  - `items.customer` (object)
    Detalhes sobre o cliente associado ao método de pagamento.

  - `items.customer.id` (string)
    O identificador único criado pela Belvo usado para referenciar o cliente atual.
    Example: "3118128a-6792-4b06-bd61-4acf6f6ad6b5"

  - `items.customer.firstname` (string)
    O primeiro nome do cliente.
    Example: "Carlos"

  - `items.customer.lastname` (string)
    O sobrenome do cliente.
    Example: "Vives"

  - `items.customer.email` (string)
    O email do cliente.
    Example: "carlos-vives@musica.mx"

  - `items.customer.phone` (string)
    O número de telefone do cliente (incluindo o código do país).
    Example: "+523001234567"

  - `items.details` (object)
    Detalhes sobre a conta bancária associada ao método de pagamento.

  - `items.details.accountNumber` (string)
    O número da conta bancária.
    Example: "445566790"

  - `items.details.accountType` (string)
    O tipo de conta bancária. Pode ser:
  - savings
  - checking
  - debit_card
    Enum: "savings", "checking", "debit_card"

  - `items.details.bank` (string)
    O nome do banco mexicano onde a conta está mantida.

Para uma lista completa de instituições, consulte nossa página dedicada de Instituições de Pagamento.

  - `metadata` (object)
    Metadados adicionais sobre o conjunto de resultados paginados.

  - `metadata.totalItems` (integer)
    O número total de itens no conjunto de resultados paginados.
    Example: 100

  - `metadata.itemCount` (integer)
    O número de itens na página atual.
    Example: 10

  - `metadata.itemsPerPage` (integer)
    O número de itens solicitados por página.
    Example: 10

  - `metadata.totalPages` (integer)
    O número total de páginas no conjunto de resultados paginados.
    Example: 10

  - `metadata.currentPage` (integer)
    O número da página atual.
    Example: 1

  - `links` (object)
    Links para navegar no conjunto de resultados paginados.

  - `links.first` (string)
    A URL para a primeira página do conjunto de resultados paginados.
    Example: "/{resource}?limit=20"

  - `links.last` (string)
    A URL para a última página do conjunto de resultados paginados.
    Example: "/{resource}?page=4&limit=20"

  - `links.next` (string)
    A URL para a próxima página do conjunto de resultados paginados.
    Example: "/{resource}?page=3&limit=20"

  - `links.previous` (string)
    A URL para a página anterior do conjunto de resultados paginados.
    Example: "/{resource}?page=2&limit=20"

## Response 400 fields (application/json):

  - `statusCode` (integer)
    O código de status HTTP para este erro.
    Example: 400

  - `error` (string)
    A descrição do código de status HTTP para este erro.
    Example: "Bad Request"

  - `message` (any)
    Uma breve descrição do erro, indicando o que está errado com a solicitação.
> Nota: Retornamos uma string ou um array de strings, dependendo do(s) erro(s) de validação.

A descrição pode ser (entre outras):

  - id must be a UUID
  - Not enough balance
  - amount is not a valid decimal number.
  - currency must be one of the following values: cop, mxn, usd
  - reference must be a string
  - Customer not found for merchant
  - documentType is a required field
    Example: "id must be a UUID"

## Response 401 fields (application/json):

  - `statusCode` (integer)
    O código de status HTTP para este erro.
    Example: 401

  - `error` (string)
    A descrição do código de status HTTP para este erro.
    Example: "Unauthorized"

  - `message` (string)
    Uma breve descrição do erro, indicando o que está errado com a solicitação. No caso de um erro 401 Unauthorized, a mensagem é:

  - Unauthorized credentials
    Example: "Unauthorized credentials"