Links de pago

Crea links de monto fijo para cobrar con tarjeta, Nequi, Bancolombia o PSE, consúltalos, edítalos y desactívalos.

¿Primera vez con este módulo? Sigue la guía Cobrar con links de pago.

Métodos

PaymentLink

Así se ve el objeto que devuelven los métodos de este módulo.

Campo	Tipo	Descripción
`id`	string	Identificador, empieza por `plink_`
`url`	string	Checkout que compartes con el pagador
`active`	boolean	`true` si acepta pagos ahora mismo
`status`	"active" \| "disabled" \| "expired"	Estado del link
`title`	string	Título visible en el checkout
`description`	string \| null	Descripción opcional
`amount`	number	Monto en centavos
`currency`	"COP" \| "USD"	Moneda del monto
`expiresAt`	string \| null	Vencimiento en ISO 8601 UTC
`paymentMethods`	PaymentLinkMethods	`card`, `nequi`, `bancolombiaTransfer` y `pse`
`redirectUrl`	string \| null	A dónde vuelve el pagador
`metadata`	Record<string, string>	Tus datos propios
`livemode`	boolean	`true` si se creó con una llave live
`createdAt`	string	Fecha de creación
`updatedAt`	string	Fecha de la última edición

Crear un link de pago

landapay.paymentLinks.create(params, options?)

Parámetros

Campo	Tipo	Descripción
`title`obligatorio	string	Título visible en el checkout
`amount`obligatorio	number	Monto en centavos: `15_000_000` son $150.000 COP
`currency`	"COP" \| "USD"	`COP` por defecto. Los links en USD se cobran en COP con la tasa del día
`description`	string \| null	Descripción opcional
`expiresAt`	string \| Date \| null	Hasta un año. Un texto sin zona horaria se toma como hora de Colombia
`paymentMethods`	Partial<PaymentLinkMethods>	Por defecto se aceptan todos los métodos habilitados en el proyecto
`redirectUrl`	string \| null	Recibe `payment_id` y `payment_link_id` en la URL al volver
`metadata`	Record<string, string \| number \| boolean \| null>	Hasta 50 pares llave/valor. Al actualizar se combina con la actual; `null` en una llave la borra
`options`	RequestOptions	Opcional. `idempotencyKey`, `timeout` (ms) y `maxRetries` solo para esta llamada

Devuelve

Promise<PaymentLink>

EjemploTypeScript

1const link = await landapay.paymentLinks.create({2  title: "Pedido A-1001",3  amount: 15_000_000,4  expiresAt: "2026-12-31T23:59:59",5  paymentMethods: { pse: false },6  redirectUrl: "https://tutienda.com/pago",7  metadata: { orderId: "A-1001" },8});9 10console.log(link.url);

Obtener un link de pago

landapay.paymentLinks.retrieve(id, options?)

Parámetros

Campo	Tipo	Descripción
`id`obligatorio	string	Id del link (`plink_...`)
`options`	RequestOptions	Opcional. `idempotencyKey`, `timeout` (ms) y `maxRetries` solo para esta llamada

Devuelve

Promise<PaymentLink>

EjemploTypeScript

const link = await landapay.paymentLinks.retrieve("plink_7QWERTY2345ASDFG");

Actualizar un link de pago

landapay.paymentLinks.update(id, params, options?)

Acepta los mismos campos de create, todos opcionales, y active para activarlo o desactivarlo.

Parámetros

Campo	Tipo	Descripción
`id`obligatorio	string	Id del link (`plink_...`)
`params`obligatorio	PaymentLinkUpdateParams	Campos a cambiar; `null` borra los opcionales
`options`	RequestOptions	Opcional. `idempotencyKey`, `timeout` (ms) y `maxRetries` solo para esta llamada

Devuelve

Promise<PaymentLink>

EjemploTypeScript

1const link = await landapay.paymentLinks.update("plink_7QWERTY2345ASDFG", {2  amount: 12_000_000,3  expiresAt: null,4});

Desactivar un link de pago

landapay.paymentLinks.disable(id, options?)

El link deja de recibir pagos. Equivale a update(id, { active: false }).

Parámetros

Campo	Tipo	Descripción
`id`obligatorio	string	Id del link (`plink_...`)
`options`	RequestOptions	Opcional. `idempotencyKey`, `timeout` (ms) y `maxRetries` solo para esta llamada

Devuelve

Promise<PaymentLink>

EjemploTypeScript

await landapay.paymentLinks.disable("plink_7QWERTY2345ASDFG");

Reactivar un link de pago

landapay.paymentLinks.enable(id, options?)

Vuelve a recibir pagos si no ha vencido. Equivale a update(id, { active: true }).

Parámetros

Campo	Tipo	Descripción
`id`obligatorio	string	Id del link (`plink_...`)
`options`	RequestOptions	Opcional. `idempotencyKey`, `timeout` (ms) y `maxRetries` solo para esta llamada

Devuelve

Promise<PaymentLink>

EjemploTypeScript

await landapay.paymentLinks.enable("plink_7QWERTY2345ASDFG");