Links de Pago

Los links de pago son generados para redirigir a una url de Amplify, en donde el consumidor puede realizar el pago y ser redirigido nuevamente a la página del comprador. Es una alternativa al uso del sdk.

API

[POST] https://api.getamplify.app/payment_link

Autenticación requerida. Para utilizar este endpoint es necesario enviar los siguientes headers:

{
  "apiKey": "123xxx456",
  "clientId": "123xxx456",
}

Crea un link de pago

{
   "name": "Link de pago",
    "description": "Descripción del link de pago",
    "amount": 1, 
    "metadata": {
        "order_id": "123456",
        "customer_id": "123456"
    },
    "expires_at": "2050-12-31T23:59:59Z",
    "max_uses": 1
}

Campo	Requerido	Valor	Descripción
name		string	Nombre a mostrar en el checkout
description		string	Descripción a mostrar en el checkout
amount		number	Precio en USD, acepta valores mayores a 1 y hasta 6 posiciones decimales
metadata		object	Metadata que el vendedor decida enviar para hacer un seguimiento de la venta
expires_at		ISO 8601, UTC	Fecha de expiración del link de pago, luego de esta fecha el link es invalidado
max_uses		int	Cantidad máxima de usos del link de pago

Respuesta:

{
    "name": "Link de Pago",
    "shortId": "ABC123",
    "description": "Descripción",
    "amount": "1",
    "metadata": null,
    "status": "ACTIVE",
    "receiverId": "1234",
    "userId": "1234",
    "uses": 0,
    "apiKeyType": "PRODUCTION",
    "logic": "SELF",
    "_id": "679252ab508d61f025fc5c30",
    "created_at": "2025-01-23T14:31:07.473Z",
    "updated_at": "2025-01-23T14:31:07.473Z",
    "__v": 0
}

Redirección

Para utilizar el link de pago debemos insertar el shortId en las siguientes urls:

---

DESARROLLO: https://test.getamplify.app/payments/${shortId}

PRODUCCIÓN: https://getamplify.app/payments/${shortId}

---

Si deseamos que cuando se complete el pago se redirija automáticamente a alguna URL, debemos envíar dicha URL en el query param redirect_url.

Ejemplo:

https://getamplify.app/payments/ABC123?redirect_url=https://getamplify.app

La URL debe estar codificada para evitar errores de redirección.