Referencia del SDK
Referencia de la librería landapay: cliente, links de pago, suscripciones, planes, clientes, pagos y webhooks, con parámetros, tipos y ejemplos en TypeScript.
Importar
Lo que exporta landapayTypeScript
// Instancia lista que lee LANDAPAY_* del entornoimport { landapay } from "landapay"; // Clase para crear clientes con opciones propiasimport Landapay from "landapay"; // Errores y tiposimport { InvalidRequestError, type Subscription } from "landapay";Módulos
ClienteCrea el cliente de Landa Pay o usa la instancia lista que lee tu configuración de las variables de entorno.
landapayLinks de pagoCrea links de monto fijo para cobrar con tarjeta, Nequi, Bancolombia o PSE, consúltalos, edítalos y desactívalos.landapay.paymentLinksSuscripcionesSuscribe a tus clientes con un plan existente o definido en la misma llamada, y consulta, actualiza, cambia de plan, cancela, reanuda o abre la página para actualizar el método de pago.landapay.subscriptionsPlanesCrea planes reutilizables con precio, frecuencia, prueba gratis y precios introductorios. Para un plan de un solo uso, defínelo al crear la suscripción.landapay.plansClientesCrea, consulta y actualiza los clientes de tu proyecto. También puedes crearlos al vuelo al suscribir con subscriptions.create.landapay.customersPagosConsulta un pago recibido por un link o por el cobro de una suscripción y confirma si fue aprobado antes de entregar el pedido.landapay.paymentsWebhooksVerifica la firma de los webhooks que envía Landa Pay y obtén el evento tipado, listo para usar con un switch sobre event.type.landapay.webhooksTodos los métodos
| Método | Qué hace |
|---|---|
| landapay | Instancia lista para usar |
| new Landapay | Crear un cliente con opciones propias |
| livemode | Saber si la llave es de producción |
| paymentLinks.create | Crear un link de pago |
| paymentLinks.retrieve | Obtener un link de pago |
| paymentLinks.update | Actualizar un link de pago |
| paymentLinks.disable | Desactivar un link de pago |
| paymentLinks.enable | Reactivar un link de pago |
| subscriptions.create | Suscribir a un cliente |
| subscriptions.retrieve | Obtener una suscripción |
| subscriptions.retrieveCheckout | Obtener el checkout de una suscripción |
| subscriptions.update | Actualizar una suscripción |
| subscriptions.cancel | Cancelar una suscripción |
| subscriptions.resume | Reanudar una suscripción |
| subscriptions.previewPlanChange | Calcular un cambio de plan sin aplicarlo |
| subscriptions.changePlan | Cambiar el plan de una suscripción |
| subscriptions.cancelPlanChange | Deshacer un cambio de plan programado |
| subscriptions.listInvoices | Listar las facturas de una suscripción |
| subscriptions.createPaymentMethodSession | Abrir la página para actualizar el método de pago |
| plans.create | Crear un plan |
| plans.retrieve | Obtener un plan |
| plans.update | Actualizar un plan |
| plans.delete | Eliminar un plan |
| customers.create | Crear un cliente |
| customers.retrieve | Obtener un cliente |
| customers.update | Actualizar un cliente |
| customers.getOrCreateId | Obtener o crear un cliente |
| payments.retrieve | Obtener un pago |
| webhooks.constructEvent | Verificar y leer un webhook |
| webhooks.verifySignature | Verificar solo la firma |
| webhooks.generateTestHeader | Firmar un webhook de prueba |
Convenciones
Todos los métodos que llaman a la API son async y aceptan un último argumento opcional con idempotencyKey, timeout y maxRetries.
Los parámetros y las respuestas usan camelCase, los montos van en centavos y las fechas llegan como texto ISO 8601 en UTC. Más detalles en Configuración y Errores.