Documentación
Ir a AlegraForoNovedadesContactoX/Twitter

Consultar pagos recurrentes

get
https://api.alegra.com/api/v1/recurring-payments

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 0

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

integer
≤ 30
Defaults to 30

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.

string
enum
Defaults to ASC

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

Allowed:
string
enum

Campo por el cual se desea ordenar.

Allowed:
boolean
Defaults to false

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.

integer

Filtra los pagos por id del cliente.

Response

Updated 7 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago