# Listar todos os Consents

Liste todos os Consentimentos que você criou para seus Métodos de Pagamento.

Endpoint: GET /consents
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

## Response 200 fields (application/json):

  - `items` (array, required)
    Um array de objetos de consentimento.

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

  - `items.status` (string, required)
    O status do consentimento. Pode ser um dos seguintes:

Inicial:
- awaiting_information: O consentimento foi criado e agora os arquivos acompanhantes devem ser enviados.

Após o envio dos arquivos:
- submitted: Todos os documentos necessários foram enviados e o consentimento está pendente de confirmação.
- incomplete_information: Um ou mais arquivos estão faltando ou são inválidos.

Estados finais:
- confirmed: Os arquivos associados foram revisados e aceitos. O consentimento agora está ativo e você pode fazer solicitações de pagamento.
- rejected: Os documentos enviados foram rejeitados e o consentimento não foi concedido.
- received_chargeback: O cliente recebeu um chargeback após o consentimento ter sido confirmed.
    Enum: "awaiting_information", "submitted", "confirmed", "incomplete_information", "rejected", "received_chargeback"

  - `items.paymentMethodId` (string, required)
    O identificador único criado pela Belvo usado para referenciar o método de pagamento.
    Example: "0d1a377b-b4c5-4a94-9e2e-83e59d1f6a9c"

  - `items.isBankNotified` (boolean, required)
    Indica se o banco foi notificado sobre o Consentimento. Isso é definido como true no caso de um chargeback ser recebido e a evidência do Consentimento ter sido enviada para o banco.

  - `metadata` (object, required)
    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, required)
    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"

## Response 404 fields (application/json):

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

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

  - `message` (string)
    Uma breve descrição do erro, indicando o que está errado com a solicitação. A descrição pode ser (entre outras):

  - Payout Target not found
  - Payment method not found
  - Customer not found
    Example: "Payout Target not found"