# Enumere todas las solicitudes de pago.

Enumere todas las solicitudes de pago asociadas con su cuenta.

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

## Query parameters:

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

  - `limit` (integer)
    Indica cuántos resultados devolver por página. Por defecto, devolvemos 20 resultados por página.

ℹ️ El número mínimo de resultados devueltos por página es 1 y el máximo es 100. Si introduces un valor mayor que 100, nuestra API usará por defecto el valor máximo (100).
    Example: 15

  - `search` (string)
    Devuelve resultados que coincidan con la reference que buscaste.

Nota:
Este filtro admite consultas de búsqueda tanto completas como parciales. Por ejemplo, buscar trai puede coincidir con los siguientes valores (extraídos del campo reference):

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

  - `customer_id` (string)
    El identificador único creado por Belvo utilizado para referenciar al cliente.
    Example: "0d1a377b-b4c5-4a94-9e2e-83e59d1f6a9c"

  - `order` (string)
    Devuelve los resultados en orden ascendente (de más antiguo a más reciente) o descendente (de más reciente a más antiguo), según el createdDate.

Puede ser:
  - asc para orden ascendente
  - desc para orden descendente
    Enum: "asc", "desc"

  - `start_date` (string)
    Devuelve los elementos con una createdDate mayor o igual a la fecha especificada. La fecha debe estar en el formato YYYY-MM-DD.
    Example: "2024-01-01"

  - `end_date` (string)
    Devuelve los elementos con una createdDate menor o igual a la fecha especificada. La fecha debe estar en el formato YYYY-MM-DD.
    Example: "2024-01-30"

## Response 200 fields (application/json):

  - `items` (array)
    Una matriz de objetos de solicitud de pago.

  - `items.id` (string)
    El identificador único creado por Belvo utilizado para referenciar la solicitud de pago.
    Example: "0d1a377b-b4c5-4a94-9e2e-83e59d1f6a9c"

  - `items.createdDate` (string,null)
    La marca de tiempo ISO-8601 cuando se creó la solicitud de pago en la base de datos de Belvo.
    Example: "2022-02-09T08:45:50.406032Z"

  - `items.lastUpdatedDate` (string,null)
    La marca de tiempo ISO-8601 cuando se actualizó por última vez la información sobre la solicitud de pago.
    Example: "2022-02-09T08:45:50.406032Z"

  - `items.chargebackDate` (string,null)
    La marca de tiempo ISO-8601 cuando Belvo marcó la solicitud de pago como chargeback. Solo está presente cuando el status es chargeback. Los contracargos registrados antes de que se introdujera bankChargebackDate contienen la fecha reportada por la institución financiera aquí en su lugar.
    Example: "2022-02-11T17:42:11.123Z"

  - `items.bankChargebackDate` (string,null)
    La fecha que la institución financiera reportó para el contracargo, en formato YYYY-MM-DD. Úsela para conciliar con los estados de cuenta de la institución financiera. null cuando la solicitud de pago no es un contracargo o fue contracargada antes de que se introdujera este campo.
    Example: "2022-02-10"

  - `items.status` (string)
    El estado de la solicitud de pago. Puede ser uno de los siguientes:
  - initial
    La solicitud de pago ha sido creada.
  - processing
    Los archivos de cobro han sido generados para la solicitud de pago. Esperando respuesta de la institución financiera.
  - successful
    La institución financiera ha confirmado la solicitud de pago y los fondos han sido transferidos.
  - failed
    La institución financiera ha reportado un error en la solicitud de pago y no se han transferido fondos.
  - canceled
    La solicitud fue cancelada. Esto solo es posible si la solicitud de pago no ha pasado al estado processing.
  - chargeback
    La institución financiera revirtió una solicitud de pago que fue successful.
    Enum: "initial", "processing", "successful", "failed", "canceled", "chargeback"

  - `items.failedReason` (string,null)
    El código de falla de la institución financiera.

  - `items.failedReasonMessage` (string,null)
    El mensaje de falla de la institución financiera, que describe la razón de la falla.

  - `items.amount` (string)
    El monto a debitar del cliente.
    Example: "100000.00"

  - `items.currency` (string)
    El código de moneda de tres letras ISO 4217 de la transacción. Por el momento, solo admitimos mxn.
    Enum: "mxn"

  - `items.customer` (string)
    El identificador único creado por Belvo utilizado para referenciar al cliente.
    Example: "3118128a-6792-4b06-bd61-4acf6f6ad6b5"

  - `items.customerName` (string)
    El nombre del cliente.
    Example: "Carlos Vives"

  - `items.reference` (string)
    Una referencia para la solicitud de pago.
    Example: "Monthly gym subscription"

  - `items.paymentMethod` (object)

  - `items.paymentMethod.type` (string)
    El tipo de cuenta. Para México, este valor se establece en bank_account.
    Enum: "bank_account"

  - `items.paymentMethod.details` (object)
    Detalles relacionados con la cuenta bancaria asociada con el método de pago.

  - `items.paymentMethod.details.accountNumber` (string)
    El número de cuenta bancaria.
    Example: "445566790"

  - `items.paymentMethod.details.accountType` (string)
    El tipo de cuenta bancaria. Puede ser:
  - savings
  - checking
  - debit_card
    Enum: "savings", "checking", "debit_card"

  - `items.paymentMethod.details.bank` (string)
    El nombre del banco mexicano donde se mantiene la cuenta.

Para ver una lista completa de instituciones, por favor visita nuestra página dedicada de Instituciones de Pago.

  - `items.loanInformation` (object)
    (Metadata opcional) Información sobre el préstamo asociado con la solicitud de pago.

  - `items.loanInformation.reference` (string)
    Su referencia para el préstamo asociado con la solicitud de pago.
    Example: "Camera Purchase 1432"

  - `items.loanInformation.disbursementDate` (string)
    La fecha en que se desembolsó el préstamo, en formato YYYY-MM-DD.
    Example: "2025-01-01"

  - `items.loanInformation.installmentNumber` (integer)
    El número de la cuota que se está pagando.
    Example: 1

  - `items.loanInformation.installmentAmount` (number)
    El monto de la cuota que se está pagando.
    Example: 100.02

  - `items.loanInformation.installmentDueDate` (string)
    La fecha de vencimiento de la cuota que se está pagando, en formato YYYY-MM-DD.
    Example: "2025-03-01"

  - `items.loanInformation.totalAmount` (number)
    El monto total del préstamo.
    Example: 12000.24

  - `items.loanInformation.totalInstallments` (integer)
    El número total de cuotas para el préstamo.
    Example: 12

  - `metadata` (object)
    Metadatos adicionales sobre el conjunto de resultados paginados.

  - `metadata.totalItems` (integer)
    El número total de elementos en el conjunto de resultados paginados.
    Example: 100

  - `metadata.itemCount` (integer)
    El número de elementos en la página actual.
    Example: 10

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

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

  - `metadata.currentPage` (integer)
    El número de página actual.
    Example: 1

  - `links` (object)
    Enlaces para navegar por el conjunto de resultados paginados.

  - `links.first` (string)
    La URL a la primera página del conjunto de resultados paginados.
    Example: "/{resource}?limit=20"

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

  - `links.next` (string)
    La URL a la siguiente página del conjunto de resultados paginados.
    Example: "/{resource}?page=3&limit=20"

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

## Response 400 fields (application/json):

  - `statusCode` (integer)
    El código de estado HTTP para este error.
    Example: 400

  - `error` (string)
    La descripción del código de estado HTTP para este error.
    Example: "Bad Request"

  - `message` (any)
    Una breve descripción del error, indicando qué está mal con la solicitud.
> Nota: Devolvemos una cadena o un arreglo de cadenas, dependiendo del/los error(es) de validación.

La descripción puede ser (entre otras):

  - 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)
    El código de estado HTTP para este error.
    Example: 401

  - `error` (string)
    La descripción del código de estado HTTP para este error.
    Example: "Unauthorized"

  - `message` (string)
    Una breve descripción del error, indicando qué está mal con la solicitud. En el caso de un error 401 Unauthorized, el mensaje es:

  - Unauthorized credentials
    Example: "Unauthorized credentials"