Este método permite que se listen las operaciones realizadas y así poder conocer sus detalles y el estado actual.
A continuación, se visualizan la lista de parámetros que recibe y la información que devuelve:
| Nombre | Tipo | Descripción |
|---|---|---|
| version | Texto | Versión del protocolo: - Valor fijo “2.0” |
| credenciales | Estructura Credenciales | Contiene la información para generar el token |
| pagos | Array de Estructura Pago | Estructura con los criterios de búsqueda |
| Credenciales | ||
|---|---|---|
| Nombre | Tipo | Descripción |
| id_organismo | Numérico entero | Código de organismo |
| token | Texto | El token devuelto por obtener_token |
| Pago | ||
|---|---|---|
| Nombre | Tipo | Descripción |
| CodigoUnicoTransaccion | Numérico entero | Identificador único de la operación |
| ExternoId | Texto | Identificador proporcionado por el Organismo |
| ExternoId_2 | Texto (100) | Identificador proporcionado por el Organismo |
| ExternoId_3 | Texto (512) | Identificador proporcionado por el Organismo. Puede usarlo para armar un protocolo interno |
| Estado | Set | Estado de las operaciones. Los valores posibles son:
|
| CodBarras | Texto | El código de barras completo correspondiente al pago a identificar |
| Implementador | Numérico entero | Opcional. El Identificador asignado al implementador. Para filtrar las operaciones del implementador |
| FechaPagoDesde | Fecha (aaaa-mm-dd hh:mm:ss) | Fecha de inicio del pago, inicio del rango |
| FechaPagoHasta | Fecha (aaaa-mm-dd hh:mm:ss) | Fecha de inicio del pago, final del rango |
| FechaAcreditacionDesde | Fecha (aaaa-mm-dd hh:mm:ss) | Fecha de acreditación en el medio de pago, inicio del rango |
| FechaAcreditacionHasta | Fecha (aaaa-mm-dd hh:mm:ss) | Fecha de acreditación en el medio de pago, final del rango |
| FechaNovedadAcreditacionDesde | Fecha (aaaa-mm-dd hh:mm:ss) | Fecha de acreditación en el ePagos, inicio del rango |
| FechaNovedadAcreditacionHasta | Fecha (aaaa-mm-dd hh:mm:ss) | Fecha de acreditación en el ePagos, final del rango |
| Pagina Nuevo | Numérico entero | El número de página de los resultados. Comenzando en 1. Se devuelven de a 100 resultados. |
| Nombre | Tipo | Descripción |
|---|---|---|
| id_resp | Numérico entero | El código de respuesta |
| respuesta | Texto | La descripción de la respuesta |
| token | Texto | El token con el que se hizo la consulta |
| id_organismo | Numérico entero | El código de organismo |
| pagos | Array de Estructura Pagos | Las operaciones disponibles para su Organismo según los filtros realizados |
| pagina Nuevo | Numérico entero | El número de página devuelta |
| cantidadTotal Nuevo | Numérico entero | El número total de resultados |
| Pagos | ||
|---|---|---|
| Nombre | Tipo | Descripción |
| CodigoUnicoTransaccion | Numérico entero | Identificador único de la operación |
| Externa | Texto | Identificador proporcionado por el Organismo |
| Externa_2 | Texto | Identificador proporcionado por el Organismo |
| Externa_3 | Texto | Identificador proporcionado por el Organismo |
| Convenio | Numérico entero | El número de convenio de la operación |
| Importe | Numérico decimal | El monto de la operación sin incluir los costos de financiación al usuario (si existieran) |
| Estado | Texto (1) | El estado actual de la operación |
| Implementador | Numérico entero | Identificador del implementador. Puede venir vacío si no lo tiene |
| FechaPago | Fecha (aaaa-mm-dd hh:mm:ss) | Fecha de inicio del pago |
| FechaAcreditacion | Fecha (aaaa-mm-dd hh:mm:ss) | Fecha de acreditación en el medio de pago |
| FechaNovedadAcreditacion | Fecha (aaaa-mm-dd hh:mm:ss) | Fecha de acreditación en ePagos |
| FormaPago | Array de la Estructura FormaPago | Estructura con la información de la forma de pago de la operación |
| DatosPagador | Estructura DatosPagador | Estructura con la información del usuario que hizo la operación |
| DatosContribuyente | Estructura DatosContribuyente | Estructura con la información de pago del contribuyente que hizo la operación |
| PagosAdicionales | Array de Estructura PagosAdicionales | Contiene la información de los pagos adicionales relacionados a esta operación |
| Recibo | Texto | De estar la operación acreditada, se devuelve una URL para poder descargar el recibo del pago enviado al usuario |
| Url_QR | Texto | Devuelve la URL a usar para el pago en línea (tarjeta de crédito y/o débito de la operación) |
| FormaPago | ||
|---|---|---|
| Nombre | Tipo | Descripción |
| Identificador | Numérico entero | El código de forma de pago |
| Tipo | Set | Devuelve el tipo de forma de pago, uno de estos valores:
|
| Importe | Numérico decimal | El importe de la operación |
| CodigoPago | Texto | El número de pago corto disponible en algunos medios de pago |
| CodigoBarras | Texto | El número de código de barras para el pago, disponible en algunos medios de pago |
| DatosPagador | ||
|---|---|---|
| Nombre | Tipo | Descripción |
| Nombre | Texto | El nombre del usuario que hizo el pago |
| Apellido | Texto | El apellido del usuario que hizo el pago |
| Texto | La dirección de email del usuario que hizo el pago | |
| Identificacion | Estructura IdentificacionPagador | Estructura con la información de identificación del usuario que hizo el pago |
| IdentificacionPagador | ||
|---|---|---|
| Nombre | Tipo | Descripción |
| tipo_doc_pagador | Numérico entero | El tipo de documento del pagador |
| numero_doc_pagador | Numérico entero | El número de documento del pagador |
| cuit_doc_pagador | Numérico entero | El número de cuit del pagador |
| DatosContribuyente | ||
|---|---|---|
| Nombre | Tipo | Descripción |
| Nombre | Texto | Nombre del contribuyente que hizo el pago |
| Apellido | Texto | Apellido del contribuyente que hizo el pago |
| Texto | Email del contribuyente que hizo el pago | |
| Dominios | Array de Texto | Si corresponde se puede obtener la lista de dominios relacionados |
| Identificacion | Estructura IdentificacionPagador | Estructura con la información de identificación del contribuyente que hizo el pago |
| Turno | Array de Estructura TurnosContribuyente | Estructura con la información de los turnos del contribuyente |
| TurnosContribuyente | ||
|---|---|---|
| Nombre | Tipo | Descripción |
| Fecha | Fecha (AAAA-MM-DD) | La fecha del turno |
| Hora | Hora (HH:MM:SS) | La hora del turno |
| Dominio | Texto | El dominio asignado |
| PagosAdicionales | ||
|---|---|---|
| Nombre | Tipo | Descripción |
| CodigoUnicoTransaccion | Númerico entero | Identificador único de la operación |
| FormaPago | Texto | Texto con la descripción de la forma de pago |
| Monto | Numérico decimal | El importe del pago adicional |
| FechaPago | Fecha | La fecha de acreditación del pago adicional |
| FechaNovedad | Fecha | La fecha de novedad de acreditación del pago adicional. Esto es cuando ePagos lo acredita en su sistema |
| IdPago | Numérico entero | Identificador único del pago adicional |
| id_resp | Tipo | Respuesta |
|---|---|---|
| 04001 | Correcta | Pagos devueltos |
| 04002 | Error | Error al validar el token. |
| 04003 | Error | Error interno al intentar devolver los pagos |
| 04004 | Error | El rango de fechas supera el límite permitido |
| 04005 | Error | Error al validar el parámetro: [_parametro_] |
| 04006 | Error | Versión inválida del protocolo |