Saltar al contenido principal

Pagos

Consulta un pago recibido por un link o por el cobro de una suscripción y confirma si fue aprobado antes de entregar el pedido.

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

Métodos

Payment

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

CampoTipoDescripción
idstringIdentificador, empieza por pay_
statusPaymentStatuspending, approved, declined, error, voided o refunded. Solo approved confirma un cobro
referencestringReferencia visible del pago
amountnumberMonto en centavos de currency
currency"COP" | "USD"Moneda del cobro
amountCopnumberMonto cobrado en centavos de COP
netAmountCopnumber | nullLo que recibes tras comisiones
paymentMethodPaymentMethodSummary | nulltype, brand y last4
payer{ name; email; phone }Datos del pagador
customerstringId del cliente (cus_...)
paymentLinkstring | nullLink que originó el pago
subscriptionstring | nullSuscripción que originó el cobro
failure{ code; message } | nullMotivo del rechazo o del error
paidAtstring | nullFecha de aprobación
livemodebooleantrue si es un pago real
createdAtstringFecha de creación

Obtener un pago

landapay.payments.retrieve(id, options?)

Parámetros

CampoTipoDescripción
idobligatoriostringId del pago (pay_...)
optionsRequestOptionsOpcional. idempotencyKey, timeout (ms) y maxRetries solo para esta llamada

Devuelve

Promise<Payment>

EjemploTypeScript
const payment = await landapay.payments.retrieve("pay_9ZXCVB2345NMLKJH"); if (payment.status === "approved") {  // Entregar el pedido}