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.
| Campo | Tipo | Descripción |
|---|---|---|
id | string | Identificador, empieza por pay_ |
status | PaymentStatus | pending, approved, declined, error, voided o refunded. Solo approved confirma un cobro |
reference | string | Referencia visible del pago |
amount | number | Monto en centavos de currency |
currency | "COP" | "USD" | Moneda del cobro |
amountCop | number | Monto cobrado en centavos de COP |
netAmountCop | number | null | Lo que recibes tras comisiones |
paymentMethod | PaymentMethodSummary | null | type, brand y last4 |
payer | { name; email; phone } | Datos del pagador |
customer | string | Id del cliente (cus_...) |
paymentLink | string | null | Link que originó el pago |
subscription | string | null | Suscripción que originó el cobro |
failure | { code; message } | null | Motivo del rechazo o del error |
paidAt | string | null | Fecha de aprobación |
livemode | boolean | true si es un pago real |
createdAt | string | Fecha de creación |
Obtener un pago
landapay.payments.retrieve(id, options?)
Parámetros
| Campo | Tipo | Descripción |
|---|---|---|
idobligatorio | string | Id del pago (pay_...) |
options | RequestOptions | Opcional. 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}