Skip to main content

Módulo de pagos

image.png

El módulos de Pagos (Payments)  permiten acceder a los movimientos financieros asociados a reservas. Comparten la misma estructura de autenticación y respuesta que los módulos anteriores.

Obtener listado paginado de pagos

Función: obtener una lista paginada de pagos, permitiendo filtrar por fechas, reserva, moneda, método de pago, pagador o IDs específicos.

Parámetros disponibles

Parámetro Descripción
take Cantidad de registros a retornar (obligatorio).
skip Cantidad de registros a omitir.
filters[payment_ids] IDs de pagos separados por comas (opcional).
filters[reservation_id] ID de la reserva asociada (opcional).
filters[date_from] Fecha inicial del rango de pago (Y-m-d) (opcional).
filters[date_to] Fecha final del rango de pago (Y-m-d) (opcional).
filters[currency_code] Código de moneda del pago, ej: USD (opcional).
filters[method] Slug del método de pago, ej: efectivo (opcional).
filters[payer_identification] Identificación del pagador (opcional).

Pasos para ejecutar la consulta

  1. Ingrese a {BASE_URL}/api/public/v1/payments

  2. Busque la sección payments→ Listado paginado de pagos.

  3. En el campo take, indique cuántos registros desea obtener (por ejemplo, 10).

  4. Si lo necesita, agregue filtros como:

    • date_from y date_to para un rango de fechas.

    • reservation_id si quiere pagos de una reserva específica.

    • currency_code, method o payer_identification.

  5. Pulse “Enviar petición”.

  6. Verifique la respuesta: si la solicitud es correcta, recibirá un código 200 OK con los datos paginados.

image.png

Consultar Información de un pago en especifico por ID

Función: obtener la información básica y detallada de un pago identificado por su {id}.

Parámetros disponibles

Parámetro Tipo Descripción
id integer Identificador del pago que se desea consultar (obligatorio).

Ejemplo: 87

Pasos para ejecutar la consulta

  1. Ingrese a {BASE_URL}/api/public/v1/payments

  2. Busque la sección payments → Consultar información de un pago por ID.

  3. En el campo id, escriba el identificador del pago que desea consultar.

  4. Pulse “Enviar petición”.

  5. Si el registro existe, recibirá un código 200 OK con toda la información del pago.

  6. Si el pago no se encuentra, el sistema responderá con 404 NOT_FOUND.

  7. Ante errores inesperados, retornará 500 INTERNAL_ERROR.

Back to top