Convertir Link de pago

post

https://api.akua.la/v1/links/{link_id}/convert

Marca un link como convertido (usado) y ejecuta el caso de uso asociado al tipo de link. Este endpoint es CRÍTICO para el flujo de pagos y onboarding. Para links de tipo 'payment', procesa el pago y puede requerir información del monto si el link es de tipo 'custom'. Para otros tipos (onboarding, enrollment), ejecuta el flujo específico de ese tipo. IMPORTANTE: Un link de uso único (multi_use=false) solo puede convertirse una vez. Links multi-uso pueden convertirse múltiples veces hasta alcanzar max_uses. La conversión valida automáticamente: expiración, permisos de cliente, límites de uso, y reglas de negocio específicas del tipo de link. Soporta JSON y multipart/form-data para casos que requieren adjuntar archivos durante la conversión (ej: documentos de onboarding).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

link_id

string

required

Identificador del link de pago a convertir. Los identificadores comienzan con el prefijo 'pl-'.

Body Params

amount

object

Información del monto a pagar. REQUERIDO SOLO para links de tipo 'payment' con amount.type='custom' (monto variable). PROHIBIDO para links con amount.type='fixed' (monto fijo ya definido). El monto debe estar dentro del rango min_amount y max_amount si fueron especificados.

instrument

object

Información del instrumento de pago a utilizar para procesar la transacción. Requerido para links de tipo 'payment'.

metadata

object

Metadata adicional específica de esta conversión que se fusionará con la metadata del link. Útil para agregar información del contexto de pago (IP, user agent, tracking IDs, etc.).

Headers

Client-Id

string

required

Identificador del cliente que solicita la conversión. REQUERIDO para validar permisos y registrar auditoría. Los IDs de cliente comienzan con 'cli-'.

Responses

Language

Credentials

OAuth2

Loading…

Response

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

application/json

200Link convertido exitosamente

400Error en la solicitud. Causas comunes: monto requerido pero no proporcionado (custom links), monto proporcionado cuando no se permite (fixed links), monto fuera del rango permitido (min_amount/max_amount), moneda no coincide con la del link, datos de conversión inválidos o incompletos.

403Acceso no autorizado. El Client-Id proporcionado no tiene permisos para convertir este link. Solo el cliente propietario del link puede ejecutar la conversión.

409Conflicto. El link ya fue usado anteriormente (para links de uso único) o ha alcanzado el número máximo de usos permitidos (para links multi-uso con max_uses). Los links en estos estados no pueden convertirse nuevamente.

410Link expirado. El link ha alcanzado su fecha de expiración (expires_at) y ya no puede ser usado. Es necesario crear un nuevo link.

415Tipo de contenido no soportado. Solo se acepta 'application/json' o 'multipart/form-data'. Verifica el header Content-Type de tu request.

500Error interno del servidor.