Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

La API permite realizar búsquedas filtradas, paginadas y ordenadas sobre los pagos registrados. Los parámetros parámeros de búsqueda se envían como query strings en la URL.

...

2. Tipos de

...

Parámetro

  • filters[]: Permite especificar los criterios de búsqueda.

    • field: Campo sobre el cual se aplicará el filtro.
    • value: Valor a buscar.
    • operation: Operación que define cómo se compara el campo con el valor.
  • sorts[]: Define los criterios de ordenamiento.

    • <nombre del campo>: Campo a ordenar.
    • ascending/descending: Dirección del orden.
  • limit: Cantidad de registros por página.

  • page: Número de página a obtener.

...

3. Operaciones Disponibles

OperaciónValor esperadoDescripción
EXISTS
Boolean (true / false)Consulta si el campo proporcionado existe o no en el objeto
EQUAL
Compara si el valor es igual.
Texto, Número o FechaCompara por igualdad
NOT_EQUAL
Texto, Número o FechaCompara
si el valor es diferente.
por desigualdad
GREATER_THAN
Texto, Número o FechaCompara
si el valor es mayor.
por mayor estricto
GREATER_THAN_OR_EQUAL_TO
Compara si el valor es
Texto, Número o FechaCompara por mayor o igual
.
LESS_THAN
Compara si el valor es menor.
Texto, Número o FechaCompara por menor estricto
LESS_THAN_OR_EQUAL_TO
Compara si el valor es
Texto, Número o FechaCompara por menor o igual
.
IN
Verifica
Lista [valor1,valor2,...]

Consulta si el valor

está en una lista

del campo está incluído dentro del conjunto proporcionado. Incluir corchetes.

NOT_IN
Verifica
Lista [valor1,valor2,...]Consulta si el valor del campo no está
en una lista
incluído dentro del conjunto proporcionado. Incluir corchetes.
CONTAINS
Verifica
StringConsulta si el valor
contiene una subcadena.
del campo tiene como subcadena al valor proporcionado
STARTS_WITH
Verifica si
StringConsulta si el valor del campo comienza con
un
el valor
.
proporcionado
ENDS_WITH
Verifica si termina con un valor.LIKEBusca valores similares (coincidencia parcial). (No recomendado)
StringConsulta si el valor del campo finaliza con el valor proporcionado

...

4. Casos de Búsqueda

4.1. Búsqueda por Email

...

Cómo especificar el dato:

  • Campo: payer.email
  • Operación: EQUAL (igual a)
  • Valor: Dirección de correo electrónico del pagador.

...

Code Block
themeMidnight
titleBúsqueda por Email
curl --location 'https://api.paypertic.com/pagos/?filters%5B0%5D%5Bfield%5D=request_date&filters%5B0%5D%5Bvalue%5D=20250101T000000-0300&filters%5B0%5D%5Boperation%5D=GREATER_THAN_OR_EQUAL_TO&page=1&filters%5B1%5D%5Bfield%5D=request_date&filters%5B1%5D%5Bvalue%5D=20250131T235959-0300&filters%5B1%5D%5Boperation%5D=LESS_THAN_OR_EQUAL_TO&filters%5B2%5D%5Bfield%5D=payer.email&filters%5B2%5D%5Bvalue%5D=germansl@hotmaillucasm%40hotmail.com&filters%5B2%5D%5Boperation%5D=EQUAL&filters%5B3%5D%5Bfield%5D=collector_id&filters%5B3%5D%5Bvalue%5D=999&filters%5B3%5D%5Boperation%5D=EQUAL' \ 
--Hheader 'accept: application/json, text/plain, */*' \ 
--Hheader 'authorization: Bearer <token>TOKEN' \
--header 'origin: https://entidad.paypertic.com' \
--Hheader 'localereferer: es_ARhttps://entidad.paypertic.com/'


...

4.2. Búsqueda por Número de Socio (Referencia Externa)

...

Cómo especificar el dato:

  • Campo: payer.external_reference
  • Operación: EQUAL (igual a)
  • Valor: Número de referencia del socio.

Ejemplo de URL:

...


Code Block
themeMidnight
titleBúsqueda por Número de Socio (Referencia Externa)
curl --location 'https://api.paypertic.com/pagos/?filters%5B0%5D%5Bfield%5D=request_date&filters%5B0%5D%5Bvalue%5D=20250101T000000-0300&filters%5B0%5D%5Boperation%5D=GREATER_THAN_OR_EQUAL_TO&page=1&filters%5B1%5D%5Bfield%5D=request_date&filters%5B1%5D%5Bvalue%5D=20250131T235959-0300&filters%5B1%5D%5Boperation%5D=LESS_THAN_OR_EQUAL_TO&filters%5B2%5D%5Bfield%5D=collector_id&filters%5B2%5D%5Bvalue%5D=

...

999&filters%5B2%5D%5Boperation%5D=EQUAL&filters%5B3%5D%5Bfield%5D=payer.external_reference&filters%5B3%5D%5Bvalue%5D=14984&filters%5B3%5D%5Boperation%5D=EQUAL' \
-

...

-header 'accept: application/json, text/plain, */*' \
-

...

-header 'authorization:

...

 Bearer TOKEN' \
--header 'origin: https://entidad.paypertic.com' \
--header 'referer: https://entidad.paypertic.com/'

...

4.3. Búsqueda por Nombre del Pagador

...

Cómo especificar el dato:

  • Campo: payer.name
  • Operación: EQUAL (igual a)
  • Valor: Nombre del pagador o parte del nombre.

Ejemplo de URL:

...


Code Block
themeMidnight
titleBúsqueda por Nombre del Pagador
curl --location 'https://api.paypertic.com/pagos/?filters%5B0%5D%5Bfield%5D=request_date&filters%5B0%5D%5Bvalue%5D=20250101T000000-0300&filters%5B0%5D%5Boperation%5D=GREATER_THAN_OR_EQUAL_TO&page=1&filters%5B1%5D%5Bfield%5D=request_date&filters%5B1%5D%5Bvalue%5D=20250131T235959-0300&filters%5B1%5D%5Boperation%5D=LESS_THAN_OR_EQUAL_TO&filters%5B2%5D%5Bfield%5D=collector_id&filters%5B2%5D%5Bvalue%5D=

...

999&filters%5B2%5D%5Boperation%5D=EQUAL&filters%5B3%5D%5Bfield%5D=payer.name&filters%5B3%5D%5Bvalue%5D=ruiz&filters%5B3%5D%5Boperation%5D=EQUAL' \
-

...

-header 'accept: application/json, text/plain, */*' \
--

...

header 'authorization:

...

 Bearer TOKEN' \
--header 'origin: https://entidad.paypertic.com' \
--header 'referer: https://entidad.paypertic.com/'

...

4.4. Búsqueda por Estado del Pago (Status)

La búsqueda por estado de pago permite filtrar los pagos según si fueron aprobados, rechazados o reinvertidos reintegrado.

Cómo especificar el dato:

  • Campo: status
  • Operación: EQUAL (igual a)
  • Valor:
    • rejected: Pagos rechazados.
    • refunded: Pagos reinvertidosreintegrado.
    • approved: Pagos aprobados.

Ejemplo de URL:

Búsqueda de Pagos Rechazados (Status: "rejected"):

...

Code Block
themeMidnight
titleBúsqueda de Pagos Rechazados (Status: "rejected")
curl --location 'https://api.paypertic.com/pagos/?filters%5B0%5D%5Bfield%5D=request_date&filters%5B0%5D%5Bvalue%5D=20250101T000000-0300&filters%5B0%5D%5Boperation%5D=GREATER_THAN_OR_EQUAL_TO&page=1&filters%5B1%5D%5Bfield%5D=request_date&filters%5B1%5D%5Bvalue%5D=20250131T235959-0300&filters%5B1%5D%5Boperation%5D=LESS_THAN_OR_EQUAL_TO&filters%5B2%5D%5Bfield%5D=status&filters%5B2%5D%5Bvalue%5D=rejected&filters%5B2%5D%5Boperation%5D=EQUAL' \
-

...

-header 'accept: application/json, text/plain, */*' \
--

...

header 'authorization:

...

 Bearer TOKEN' \
--header 'origin: https://entidad.paypertic.com' \
--header 'referer: https://entidad.paypertic.com/'
Búsqueda de Pagos Reintegrados (Status: "refunded"):

...

Code Block
themeMidnight
titleBúsqueda de Pagos Reintegrados (Status: "refunded")
curl --location 'https://api.paypertic.com/pagos/?filters%5B0%5D%5Bfield%5D=request_date&filters%5B0%5D%5Bvalue%5D=20250101T000000-0300&filters%5B0%5D%5Boperation%5D=GREATER_THAN_OR_EQUAL_TO&page=1&filters%5B1%5D%5Bfield%5D=request_date&filters%5B1%5D%5Bvalue%5D=20250131T235959-0300&filters%5B1%5D%5Boperation%5D=LESS_THAN_OR_EQUAL_TO&filters%5B2%5D%5Bfield%5D=status&filters%5B2%5D%5Bvalue%5D=refunded&filters%5B2%5D%5Boperation%5D=EQUAL' \
-

...

-header 'accept: application/json, text/plain, */*' \
-

...

-header 'authorization:

...

 Bearer TOKEN' \
--header 'origin: https://entidad.paypertic.com' \
--header 'referer: https://entidad.paypertic.com/'
Búsqueda de Pagos Aprobados (Status: "approved"):

...

Code Block
themeMidnight
titleBúsqueda de Pagos Aprobados (Status: "approved")
curl --location 'https://api.paypertic.com/pagos/?filters%5B0%5D%5Bfield%5D=request_date&filters%5B0%5D%5Bvalue%5D=20250101T000000-0300&filters%5B0%5D%5Boperation%5D=GREATER_THAN_OR_EQUAL_TO&page=1&filters%5B1%5D%5Bfield%5D=request_date&filters%5B1%5D%5Bvalue%5D=20250131T235959-0300&filters%5B1%5D%5Boperation%5D=LESS_THAN_OR_EQUAL_TO&filters%5B2%5D%5Bfield%5D=status&filters%5B2%5D%5Bvalue%5D=approved&filters%5B2%5D%5Boperation%5D=EQUAL' \
--

...

header 'accept: application/json, text/plain, */*' \
-

...

-header 'authorization: Bearer

...

 TOKEN' \

...


--header 'origin: https://entidad.paypertic.com' \
--header 'referer: https://entidad.paypertic.com/'

...

5. Respuesta de la API

La API devuelve un objeto JSON con la siguiente estructura en caso de éxito:

...