Skip to content
Vesvank

Listar Payment Requests

Permite obtener una lista paginada de todas las solicitudes de pago creadas.

Endpoint

Section titled “Endpoint”
GET /api/v1/payment_requests

Parámetros de consulta

Section titled “Parámetros de consulta”

Paginación

Section titled “Paginación”
limit (integer)
Número máximo de resultados a retornar por página (máximo 50). Opcional.
page (integer)
Número de página a consultar. Opcional. Por defecto es 1.

Filtros

Section titled “Filtros”
customer_dni (string)
Filtra por el DNI del cliente. Opcional.
customer_email (string)
Filtra por el email del cliente. Opcional.
status (string)
Filtra por el estado de la solicitud de pago. Opcional.
Valores permitidos:
waiting_for_paymentwaiting_for_payment_confirmationpaidcanceled
created_at (string|object)
Filtra por fecha de creación. Puede ser una fecha específica (YYYY-MM-DD) o un rango de fechas ({start: 'YYYY-MM-DD', end: 'YYYY-MM-DD'}). Opcional.

Respuesta

Section titled “Respuesta”

Retorna un objeto con la lista de solicitudes de pago y metadatos de paginación.

Códigos de estado

Section titled “Códigos de estado”
  • 200 OK - Solicitudes listadas exitosamente
  • 401 Unauthorized - Error de autenticación
  • 400 Bad Request - Error en los parámetros de filtrado

Ejemplos de solicitud

Section titled “Ejemplos de solicitud”

Listar con paginación

Section titled “Listar con paginación”
Terminal window
curl -X GET 'https://api.vesvank.com/api/v1/payment_requests?limit=1&page=3' \
  -H "Authorization: Bearer YOUR_API_KEY"

Filtrar por DNI y estado

Section titled “Filtrar por DNI y estado”
Terminal window
curl -X GET 'https://api.vesvank.com/api/v1/payment_requests?customer_dni=V18000014&status=waiting_for_payment' \
  -H "Authorization: Bearer YOUR_API_KEY"

Filtrar por rango de fechas

Section titled “Filtrar por rango de fechas”
Terminal window
curl -X GET 'https://api.vesvank.com/api/v1/payment_requests?created_at[start]=2024-03-01&created_at[end]=2024-03-31' \
  -H "Authorization: Bearer YOUR_API_KEY"

Ejemplo de respuesta

Section titled “Ejemplo de respuesta”
{
  "meta": {
    "current_page": 3,
    "limit": 1,
    "total_pages": 80,
    "total_objects": 80
  },
  "data": [
    {
      "id": "preq_4PzyMk09NYopC8jL6B3rvabK",
      "description": "Basic subscription",
      "external_id": "order_010203",
      "token": "PR0f42b071",
      "status": "waiting_for_payment",
      "created_at": 1747521596,
      "updated_at": 1747521596,
      "main_amount": {
        "amount_cents": 4892,
        "amount": 48.92,
        "currency_iso": "USD"
      },
      "conversion_amount": {
        "amount_cents": 489200,
        "amount": 4892.0,
        "currency_iso": "VES"
      },
      "customer": {
        "id": "cus_Pn4r3mwOX5gDf50zpyKYl7Ze",
        "dni": "V18000014",
        "email": "example14@vesvank.com"
      },
      "rate": {
        "amount_cents": 10000,
        "amount": 100.0,
        "currency_iso": "VES"
      },
      "succeeded_payment_intent": null,
      "pending_payment_intents": [],
      "rejected_payment_intents": [],
      "payment_url": "https://subdomain.vesvank.com/payments_portal/payment_requests/PR0f42b071"
    }
  ]
}