La URL de pago apunta a la página web que utiliza el cliente para pagar una deuda. Cada deuda tiene una URL de pago única e irrepetible.
Si la deuda aún no ha sido pagada, la página presenta las opciones de pago que el comercio haya configurado y activado para la aplicación que creó la deuda.
Si la deuda ya ha sido pagada, la página muestra el comprobante de pago.
La URL se genera automáticamente al crear una deuda y es visible en la pantalla de información de la deuda en el UI de administración o en la respuesta a una llamada al API
Anexando /qr
a la URL de pago, se obtiene una imagen con el QR que contiene la URL de pago.
Por ejemplo, si la URL de pago es:
https://staging.adamspay.com/pay/acme/debt/pollada-1-4097105
La URL del QR sería:
https://staging.adamspay.com/pay/acme/debt/pollada-1-4097105/qr
El QR no puede contener parámetros de control.
El aspecto visual de las páginas puede ser personalizado usando un tema visual
Tu software tiene la opción de agregar parámetros al query string de la URL de pago para que AdamsPay tome cierta acción.
El parámetro opcional display
determina el modo de ui que utilizará la página y afecta las clases CSS disponibles para el tema visual.
El parámetro idtoken
permite a tu aplicación pasar información sobre la sesión de usuario a AdamsPay.
Este parámetro debería estar presente solamente durante una redirección o dentro de un iFrame/webview, ya que el idtoken identifica al usuario que abre la URL. No agregues este parámetro a una URL que el usuario pueda compartir, ya que el receptor podría impersonarlo.
El idtoken
sigue el formato especificado por JSON Web Token (JWT) y debe ser firmado utilizando el algoritmo HS256
y el secreto de la aplicación que creó la deuda que representa la URL.
El contenido del JWT se rige según los claims de Openid connect con extensiones de AdamsPay:
iss
debe ser self
aud
debe ser adamspay
sub
en caso que el usuario esté logeado, debe ser el user-id que tu sofware utilice para identificarlo. En blanco de lo contrario.iat
fecha de inicio de validez del tokenexp
fecha de fin de validez del tokenname
nombre completogiven_name
nombresfamily_name
apellidosemail
email (opcional, pero recomendado)phone_number
celularnonce
ID alfanumérico para evitar repetición/replay. De estar presente, el token no puede ser utilizado de vuelta en menos de 3 meses.
En este ejemplo generado con el debugger de https://jwt.io/, el lado derecho representan los claims que tu software desea enviar y el izquierdo el valor del parámetro idtoken
Si AdamsPay acepta el token, la página de pago indicará el usuario identificado (sólo en el ambiente de pruebas):
Puedes obtener más información sobre claims y ID tokens en:
Parámetros con información privada de contexto, deben ser agregados solamente a la URL de una redirección HTTP como la que ocurre durante un pago online y no en URLs estáticas para compartir, como las que envías por e-mail al cliente.
En el caso de idtoken
es recomendable proveer un valor al claim nonce
para evitar que el usuario comparta la URL por accidente.