Skip to main content
GET
GET /payment-link/{id} devuelve uno de tus enlaces de pago. Consúltalo para saber si un enlace fue pagado: status es active, used, expired o cancelled, y usesCount es la cantidad de pagos exitosos recibidos a través de él. Un enlace que pertenece a otro comercio, o al otro entorno, devuelve 404.

Ejemplo

Los pagos realizados a través de un enlace son pagos normales: envían los webhooks de pago habituales, y la reference del enlace es su orderCode.

Autorizaciones

Authorization
string
header
requerido

Your secret API key: Bearer prv_production_xxx (production) or Bearer prv_sandbox_xxx (sandbox).

Parámetros de ruta

id
string<uuid>
requerido

The payment link id.

Parámetros de consulta

merchantCode
string

Your merchant account identifier. Required if the key maps to more than one merchant account.

Respuesta

The payment link

id
string<uuid>
url
string<uri>

The hosted checkout URL to share with the payer.

type
enum<string>
Opciones disponibles:
one-time,
subscription
status
enum<string>

used once a single-use link takes its first successful payment, or a reusable link reaches maxUses.

Opciones disponibles:
active,
used,
expired,
cancelled
amountMode
enum<string>
Opciones disponibles:
fixed,
customer_entered
amount
object

Absent on subscription links. For customer_entered links only currency and exponent are set.

amountMin
integer<int64>

Minimum payer-entered amount, minor units.

amountMax
integer<int64>

Maximum payer-entered amount, minor units.

subscriptionPlanId
integer<int64>
checkoutConfigId
string<uuid>
title
string
description
string
reference
string
customerEmail
string
customerName
string
returnUrl
string<uri>
saveCardEnabled
boolean
reusable
boolean
maxUses
integer
usesCount
integer

Number of successful payments taken through this link.

environment
enum<string>
Opciones disponibles:
production,
sandbox
expiresAt
string<date-time>
usedAt
string<date-time>
createdAt
string<date-time>