Skip to main content
POST
/
connect-links
Crear link de captura
curl --request POST \
  --url https://api.onepay.la/v1/connect-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-idempotency: <x-idempotency>' \
  --data '
{
  "customer_id": "<string>",
  "single_use": true,
  "notify": true,
  "external_id": "<string>",
  "redirect_url": "<string>",
  "metadata": {}
}
'
{
    "id": "9e92f61e-e90f-4fbb-a551-080fd4fb4f6f",
    "customer_id": "9957858a-c2f1-4f18-a5c2-216b4127e278",
    "single_use": false,
    "visits": 0,
    "completed": 0,
    "external_id": "31231231231",
    "allows": {
        "cards": true,
        "accounts": true,
        "card_extra": false,
        "realtime": false,
        "pse": true,
        "transfiya": true
    },
    "created_at": "2025-04-01T20:45:16.000000Z",
    "updated_at": "2025-04-01T20:45:16.000000Z",
    "url": "https://pagos.onepay.la/connect-link/9e92f61e-e90f-4fbb-a551-080fd4fb4f6f"
}

Headers

x-idempotency
string
required
Token único para garantizar la idempotencia de la petición

Body

customer_id
string
required
ID del cliente que completará el formulario. Ver cómo crear un cliente.
single_use
boolean
Define si el enlace de conexión (Connect Link) será de un solo uso o de múltiples usos. Si se establece en true, el enlace será de un solo uso; si es false, permitirá múltiples conexiones.
notify
boolean
Indica si se debe notificar al cliente cuando se complete el pago
Métodos de pago permitidosEl método de pago disponible depende de la configuración de tu cuenta. Comunícate con el equipo de soporte para habilitar métodos adicionales.
MétodoCampo requeridoDescripción
Cuenta bancaria (ACH)account_idDébito directo desde cuenta bancaria registrada
Tarjeta de crédito/débitocard_idCargo a tarjeta tokenizada
Solo uno de los dos (account_id o card_id) debe estar presente en la petición.
external_id
string
ID único del cliente en tu sistema
redirect_url
string
URL a la que se redirigirá al cliente después de completar el pago
metadata
object
Metadatos adicionales que deseas asociar con el link
redirect_url
string
URL de redirección

Response

{
    "id": "9e92f61e-e90f-4fbb-a551-080fd4fb4f6f",
    "customer_id": "9957858a-c2f1-4f18-a5c2-216b4127e278",
    "single_use": false,
    "visits": 0,
    "completed": 0,
    "external_id": "31231231231",
    "allows": {
        "cards": true,
        "accounts": true,
        "card_extra": false,
        "realtime": false,
        "pse": true,
        "transfiya": true
    },
    "created_at": "2025-04-01T20:45:16.000000Z",
    "updated_at": "2025-04-01T20:45:16.000000Z",
    "url": "https://pagos.onepay.la/connect-link/9e92f61e-e90f-4fbb-a551-080fd4fb4f6f"
}