Listar Links de pago

get

https://api.akua.la/v1/links

Obtiene una lista paginada de links de pago con capacidad de búsqueda y filtrado avanzado. Permite realizar búsquedas eficientes sobre los campos de los links. Útil para dashboards, reportes, y administración de links creados. Permite filtrar por estado, tipo, fechas de expiración, y buscar por texto libre en múltiples campos simultáneamente.

Query Params

query

string

Texto de búsqueda libre que se aplica a múltiples campos (client_id, type, status). Permite encontrar links escribiendo cualquier texto relacionado. Ejemplo: 'payment' encontrará todos los links de tipo payment.

page

integer

≥ 1

Defaults to 1

Número de página para la paginación. Comienza en 1. Por defecto: 1.

page_size

integer

1 to 100

Defaults to 20

Cantidad de resultados por página. Rango: 1-100. Por defecto: 20.

status

string

enum

Filtrar por estado del link. Valores posibles: 'created' (recién creado), 'opened' (visto pero no usado), 'used' (completado/convertido), 'expired' (expiró por tiempo). Puede especificar múltiples valores separados por coma.

Allowed:

type

string

enum

Filtrar por tipo de link. Valores: 'payment', 'card_enrollment', 'merchant_onboarding', 'client_onboarding', 'terminal_onboarding'. Puede especificar múltiples valores separados por coma.

Allowed:

client_id

string

Filtrar por ID del cliente que creó el link. Los IDs de cliente comienzan con el prefijo 'cli-'.

expires_at_from

date-time

Filtrar links que expiran desde esta fecha (formato ISO 8601). Útil para encontrar links que expiran en un rango de fechas específico.

expires_at_to

date-time

Filtrar links que expiran hasta esta fecha (formato ISO 8601). Se usa junto con expires_at_from para definir un rango.

Responses

Language

Credentials

OAuth2

Request

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Lista de links obtenida exitosamente. Retorna un array de links con información de paginación.

400Error en los parámetros de búsqueda o filtros. Verifica que los valores de los parámetros sean válidos.

401No autorizado. El token de autenticación es inválido, ha expirado o no fue proporcionado. Este endpoint requiere autenticación mediante token JWT.

500Error interno del servidor.