# Listar todas as solicitações de pagamento

Liste todas as solicitações de pagamento associadas à sua conta.

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

  - `order` (string)
    Retorne os resultados em ordem ascendente (do mais antigo para o mais recente) ou descendente (do mais recente para o mais antigo), de acordo com o createdDate.

Pode ser:
  - asc para ordem ascendente
  - desc para ordem descendente
    Enum: "asc", "desc"

  - `start_date` (string)
    Retorne itens com um createdDate maior ou igual à data especificada. A data deve estar no formato YYYY-MM-DD.
    Example: "2024-01-01"

  - `end_date` (string)
    Retorne itens com um createdDate menor ou igual à data especificada. A data deve estar no formato YYYY-MM-DD.
    Example: "2024-01-30"

## Response 200 fields (application/json):

  - `items` (array)
    Um array de objetos de solicitação de pagamento.

  - `items.id` (string)
    O identificador único criado pela Belvo usado para referenciar a solicitação de pagamento.
    Example: "0d1a377b-b4c5-4a94-9e2e-83e59d1f6a9c"

  - `items.createdDate` (string,null)
    O carimbo de data e hora ISO-8601 quando a solicitação de pagamento foi criada 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 a solicitação de pagamento foram atualizadas pela última vez.
    Example: "2022-02-09T08:45:50.406032Z"

  - `items.chargebackDate` (string,null)
    O timestamp ISO-8601 quando a Belvo marcou a solicitação de pagamento como chargeback. Presente apenas quando o status é chargeback. Chargebacks registrados antes da introdução de bankChargebackDate mantêm a data relatada pela instituição financeira aqui.
    Example: "2022-02-11T17:42:11.123Z"

  - `items.bankChargebackDate` (string,null)
    A data que a instituição financeira informou para o estorno, no formato YYYY-MM-DD. Use-a para reconciliar com os extratos da instituição financeira. null quando a solicitação de pagamento não é um estorno ou foi estornada antes de este campo ser introduzido.
    Example: "2022-02-10"

  - `items.status` (string)
    O status da solicitação de pagamento. Pode ser:

  - initial
    A solicitação de pagamento foi criada.
  - processing
    Os arquivos de cobrança foram gerados para a solicitação de pagamento. Aguardando resposta da instituição financeira.
  - successful
    A instituição financeira confirmou a solicitação de pagamento e os fundos foram transferidos.
  - failed
    A instituição financeira relatou um erro na solicitação de pagamento e nenhum fundo foi transferido.
  - canceled
    A solicitação foi cancelada. Isso só é possível se a solicitação de pagamento não tiver passado para o status processing.
  - chargeback
    A instituição financeira reverteu uma solicitação de pagamento que foi successful.
    Enum: "initial", "processing", "successful", "failed", "canceled", "chargeback"

  - `items.failedReason` (string,null)
    O código de falha da instituição financeira.

  - `items.failedReasonMessage` (string,null)
    A mensagem de falha da instituição financeira, descrevendo o motivo da falha.

  - `items.amount` (string)
    O valor a debitar do cliente.
    Example: "100000.00"

  - `items.currency` (string)
    O código de moeda de três letras ISO 4217 da transação. No momento, só oferecemos suporte a mxn.
    Enum: "mxn"

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

  - `items.customerName` (string)
    O nome do cliente.
    Example: "Carlos Vives"

  - `items.reference` (string)
    Uma referência para a solicitação de pagamento.
    Example: "Monthly gym subscription"

  - `items.paymentMethod` (object)

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

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

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

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

  - `items.paymentMethod.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.

  - `items.loanInformation` (object)
    (Metadata opcional) Metadados sobre o empréstimo associado à solicitação de pagamento.

  - `items.loanInformation.reference` (string)
    Sua referência para o empréstimo associado à solicitação de pagamento.
    Example: "Camera Purchase 1432"

  - `items.loanInformation.disbursementDate` (string)
    A data em que o empréstimo foi desembolsado, no formato YYYY-MM-DD.
    Example: "2025-01-01"

  - `items.loanInformation.installmentNumber` (integer)
    O número da parcela que está sendo paga.
    Example: 1

  - `items.loanInformation.installmentAmount` (number)
    O valor da parcela sendo paga.
    Example: 100.02

  - `items.loanInformation.installmentDueDate` (string)
    A data de vencimento da parcela que está sendo paga, no formato YYYY-MM-DD.
    Example: "2025-03-01"

  - `items.loanInformation.totalAmount` (number)
    O valor total do empréstimo.
    Example: 12000.24

  - `items.loanInformation.totalInstallments` (integer)
    O número total de parcelas para o empréstimo.
    Example: 12

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