latestOpenAPI 3.0.32026-07-24398641.3 MB

cd52d3f68f1b

Pagos recurrentes

Consultar pagos recurrentes

Endpoint que permite consultar los pagos registrados en la aplicación

get/recurring-payments

Query parameters

startinteger

Desde cuál pago se quiere consultar. Por ejemplo para consultar desde el pago 20, se envía start=20.

limitinteger

Cantidad de pagos a partir del inicio que se desea retornar. Por defecto retorna 30 pagos. Si este valor es mayor que 30, la aplicación retorna error.

order_direction'ASC' | 'DESC'

Orden ascendente o descendente en el cual se quieren retornar los pagos. Opciones disponibles son DESC o ASC. Por defecto es ASC (ascendente).

order_field'id' | 'number' | 'date' | 'type'

Campo por el cual se desea ordenar.

metadataboolean

Incluir en los resultados metadatos. Se debe tener en cuenta que si se envía este parámetro el objeto que retorna la aplicación incluye un atributo "metadata" y otro "data" en donde se envían los pagos. Actualmente la información que se envía en metadata incluye el total de pagos que tiene registrada la empresa. Si se envía el parámetro type retorna el total de pagos del tipo enviado.

client_idinteger

Filtra los pagos por id del cliente.

Response

Se obtiene una lista que contiene los pagos recurrentes

Schema[] required— unresolved $ref