Skip to main content
POST
https://api.onepay.la/v1
utilities
/
direct-debits
/
link
Generar link de domiciliación
curl --request POST \
  --url https://api.onepay.la/v1/utilities/direct-debits/link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reference": "<string>",
  "phone": "<string>",
  "approx_amount": 123,
  "expiration_minutes": 123
}
'
{
  "url": "https://onepay.la/s/abc123",
  "reference": "3167591038",
  "expires_at": "2026-02-16T15:55:00.000000-05:00"
}
Genera una URL firmada con tiempo de expiración que redirige al checkout de domiciliación. El cliente podrá registrar su método de pago (tarjeta o cuenta) para el cobro automático de sus facturas.
La compañía debe tener al menos un servicio de facturación (BillService) habilitado para poder generar el link.

Body

reference
string
required
Referencia de la factura o servicio a domiciliar. Mínimo 1 carácter, máximo 60.
phone
string
Número de teléfono del cliente en formato E.164. Si se envía, el checkout lo pre-llenará.
approx_amount
number
Monto aproximado del cobro (en pesos). Se muestra al cliente como referencia. Mínimo 0.
expiration_minutes
integer
Minutos de validez del link. Mínimo 60, máximo 43200 (30 días). Por defecto 4320 (3 días).

Ejemplos de uso

curl https://api.onepay.la/v1/utilities/direct-debits/link \
  -X POST \
  -H "Authorization: Bearer sk_test_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "reference": "3167591038",
    "phone": "+573001234567",
    "approx_amount": 45000,
    "expiration_minutes": 4320
  }'

Response

url
string
URL corta que redirige al checkout de domiciliación. Este link es público y puede compartirse con el cliente.
reference
string
La referencia enviada en el request.
expires_at
string
Fecha y hora de expiración del link en formato ISO 8601.
{
  "url": "https://onepay.la/s/abc123",
  "reference": "3167591038",
  "expires_at": "2026-02-16T15:55:00.000000-05:00"
}

Notas importantes

  • El link generado es una URL firmada con expiración. Una vez vencido, el cliente verá un error 403.
  • Se genera automáticamente una URL corta para facilitar el envío por WhatsApp o SMS.
  • El cliente podrá registrar una tarjeta o cuenta bancaria como método de pago automático.