Saltar al contenido
Docs

Referencia

Consultar un link

GET/v1/partner/payment-links/{publicId}payment-links:read

Consulta un link de pago por su ULID. Ajeno o inexistente responde 404.

Propósito

Obtiene el detalle de un link de pago específico. Incluye el estado actual, el número de pagos completados y la URL para compartir.

Estados posibles

EstadoSignificado
ACTIVEEl link acepta pagos
EXPIREDLa fecha de expiración pasó
CANCELLEDFue cancelado manualmente con POST /payment-links/:id/cancel
COMPLETEDSe alcanzó el máximo de usos (usesCount == maxUses)

Seguridad

Solo puedes ver links de wallets de tus usuarios. Ajeno o inexistente → 404.

Parámetros de ruta

publicId
El link, de `POST /payment-links` o de `GET /payment-links`. ULID de 26 caracteres; ajeno o inexistente ⇒ 404 (nunca 403: un 403 confirmaría que existe). Ejemplo: 01JKX7CBRP0000000000000024

Respuesta 200

Detalle del link

  • amountobjeto
    • amountstring

      String decimal de dos decimales; nunca number

      Ejemplo: "1500.00"

    • currencystring

      Ejemplo: "MXN"

  • cancelledAtobjetopuede venir null

    admite null

  • conceptstringpuede venir null

    admite null

    Ejemplo: "Pago de servicio fotográfico"

  • createdAtstring

    Ejemplo: "2026-09-04T15:04:05.000Z"

  • expiresAtstringpuede venir null

    admite null

    Ejemplo: "2026-09-07T15:04:05.000Z"

  • maxUsesnumber

    Ejemplo: 1

  • Dueño de la wallet.

    Ejemplo: "01JKX7PEND0000000000000036"

  • publicIdstring

    Ejemplo: "01JKX7CBRP0000000000000024"

  • shareUrlstringpuede venir null

    URL para compartir por WhatsApp, correo o QR.

    admite null

    Ejemplo: "https://pay.slan.mx/l/abc123"

  • statusenum

    Estado derivado del reloj: un link vencido nunca dice ACTIVE.

    ACTIVEEXHAUSTEDEXPIREDCANCELLED

    Ejemplo: "ACTIVE"

  • usesCountnumber

    Ejemplo: 0

  • Wallet asociada al link.

    Ejemplo: "01JKX7MNDR0000000000000037"

Errores

EstadoCódigosCuándo
401sin codeSin x-api-key válida
403sin codeLa llave no tiene el scope payment-links:read
404LINK_NOT_FOUNDError con code: LINK_NOT_FOUND
429RATE_LIMITEDLimite de uso: 120 por minuto por credencial. Respeta la cabecera `Retry-After`.