Crear link de captura

Crea un nuevo link de captura, para que el cliente pueda registrar su información de pago.

POST https://api.onepay.la/v1/connect-links

Crear link de captura

cURL

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,
  "allows": {
    "cards": true,
    "accounts": true,
    "wallets": true,
    "card_extra": true,
    "realtime": true,
    "pse": true,
    "full_extra": true,
    "pse_debit": true,
    "breb": true
  },
  "external_id": "<string>",
  "redirect_url": "<string>",
  "metadata": {}
}
'

200

{
    "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

allows · object

Configuración de métodos de pago permitidos.

Show properties

cards · boolean · default: true

Permite pagos con tarjetas.

accounts · boolean · default: true

Permite pagos con cuentas bancarias.

wallets · boolean · default: true

Permite pagos con billeteras digitales.

card_extra · boolean · default: false

El usuario pagador debe de asumir un costo extra en la transacción aprox. 2.65%

realtime · boolean · default: false

Permite pagos en tiempo real.

pse · boolean · default: true

Permite pagos a través de PSE.

full_extra · boolean · default: false

El usuario pagador asume el costo completo de la transacción.

pse_debit · boolean · default: false

Permite débitos automáticos a través de PSE.

breb · boolean · default: true

Permite pagos a través de BREB (transferencias bancarias).

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

200

{
    "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"
}