Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.onepay.la/llms.txt

Use this file to discover all available pages before exploring further.

Cada notificación llega como un POST con Content-Type: application/json al URL de tu webhook. El body siempre incluye los campos event (nombre del evento) y data (objeto del recurso relacionado).

​
Estructura general

{
  "event": "nombre.del.evento",
  "data": {
    // Objeto del recurso según el tipo de evento
  }
}

​
Pagos

{
  "event": "payment.approved",
  "data": {
    "id": "9e02966f-2ddf-4ee7-a391-5b5b7653e232",
    "amount": 150000,
    "amount_label": "$1.500",
    "currency": "COP",
    "status": "approved",
    "reference": "PAY-001",
    "customer": {
      "id": "9dd4158b-0e45-42bc-b56f-a4c1f856814d",
      "first_name": "Carlos",
      "last_name": "García",
      "email": "carlos@ejemplo.com"
    },
    "paid_at": "2025-01-20T14:30:00+00:00",
    "created_at": "2025-01-20T14:00:00+00:00"
  }
}

{
  "event": "payment.rejected",
  "data": {
    "id": "9e02966f-2ddf-4ee7-a391-5b5b7653e233",
    "amount": 150000,
    "currency": "COP",
    "status": "rejected",
    "reference": "PAY-002",
    "customer": {
      "id": "9dd4158b-0e45-42bc-b56f-a4c1f856814d",
      "first_name": "Carlos",
      "last_name": "García",
      "email": "carlos@ejemplo.com"
    },
    "created_at": "2025-01-20T14:00:00+00:00"
  }
}

{
  "event": "payment.expired",
  "data": {
    "id": "9e02966f-2ddf-4ee7-a391-5b5b7653e234",
    "amount": 150000,
    "currency": "COP",
    "status": "expired",
    "reference": "PAY-003",
    "created_at": "2025-01-20T14:00:00+00:00"
  }
}

{
  "event": "payment.partially_paid",
  "data": {
    "id": "9e02966f-2ddf-4ee7-a391-5b5b7653e236",
    "amount": 500000,
    "amount_label": "$5.000",
    "currency": "COP",
    "status": "partially_paid",
    "reference": "PAY-004",
    "customer": {
      "id": "9dd4158b-0e45-42bc-b56f-a4c1f856814d",
      "first_name": "Carlos",
      "last_name": "García",
      "email": "carlos@ejemplo.com"
    },
    "partial_payment": {
      "total_paid_in_cents": 200000,
      "total_paid_label": "$2.000",
      "remaining_amount_in_cents": 300000,
      "remaining_label": "$3.000",
      "progress_percentage": 40,
      "is_fully_paid": false,
      "min_amount_in_cents": 100000,
      "max_amount_in_cents": null,
      "max_payment_methods": 3,
      "timeout_hours": 24,
      "partial_expires_at": "2025-01-21T14:00:00+00:00",
      "charges": [
        {
          "id": "4dc959d0-d96a-377a-823e-5e05cfde896f",
          "amount": 200000,
          "status": "paid",
          "paid_at": "2025-01-20T14:30:00+00:00"
        }
      ]
    },
    "created_at": "2025-01-20T14:00:00+00:00"
  }
}

{
  "event": "payment.partial_expired",
  "data": {
    "id": "9e02966f-2ddf-4ee7-a391-5b5b7653e237",
    "amount": 500000,
    "amount_label": "$5.000",
    "currency": "COP",
    "status": "partial_expired",
    "reference": "PAY-005",
    "customer": {
      "id": "9dd4158b-0e45-42bc-b56f-a4c1f856814d",
      "first_name": "Carlos",
      "last_name": "García",
      "email": "carlos@ejemplo.com"
    },
    "partial_payment": {
      "total_paid_in_cents": 200000,
      "total_paid_label": "$2.000",
      "remaining_amount_in_cents": 300000,
      "remaining_label": "$3.000",
      "progress_percentage": 40,
      "is_fully_paid": false,
      "min_amount_in_cents": 100000,
      "max_amount_in_cents": null,
      "max_payment_methods": 3,
      "timeout_hours": 24,
      "partial_expires_at": "2025-01-21T14:00:00+00:00",
      "charges": [
        {
          "id": "4dc959d0-d96a-377a-823e-5e05cfde896f",
          "amount": 200000,
          "status": "paid",
          "paid_at": "2025-01-20T14:30:00+00:00"
        }
      ]
    },
    "created_at": "2025-01-20T14:00:00+00:00"
  }
}

​
Cargos

{
  "event": "charge.paid",
  "data": {
    "id": "9e02966f-2ddf-4ee7-a391-5b5b7653e232",
    "title": "Mensualidad Enero 2025",
    "amount": 85000,
    "amount_label": "$850",
    "currency": "COP",
    "status": "paid",
    "payment_method_type": "Card",
    "payment_method_id": "4dc959d0-d96a-377a-823e-5e05cfde896f",
    "customer_id": "9e02966e-8beb-4e02-ba0c-bea875a07b22",
    "is_test": false,
    "paid_at": "2025-01-20T14:30:00+00:00",
    "created_at": "2025-01-20T14:00:00+00:00"
  }
}

{
  "event": "charge.failed",
  "data": {
    "id": "9e02966f-2ddf-4ee7-a391-5b5b7653e235",
    "title": "Mensualidad Febrero 2025",
    "amount": 85000,
    "currency": "COP",
    "status": "declined",
    "remarks": {
      "code": "INSUFFICIENT_FUNDS",
      "description": "Fondos insuficientes en la cuenta."
    },
    "customer_id": "9e02966e-8beb-4e02-ba0c-bea875a07b22",
    "is_test": false,
    "created_at": "2025-01-20T14:00:00+00:00"
  }
}

​
Dispersiones

{
  "event": "cashout.completed",
  "data": {
    "id": "9d44ce43-a227-4566-b107-5a6bc01cbcdf",
    "customer_id": "9b7c5f38-b2b5-4b0d-8e4c-458192e88eae",
    "account_id": "9d0ac58c-2226-4f1c-b305-15e6dc3b47f6",
    "amount": 1000000,
    "currency": "COP",
    "status": "processed",
    "method": "ACH",
    "external_id": "PAYROLL-2391",
    "is_test": false,
    "created_at": "2025-01-20T18:07:18+00:00"
  }
}

{
  "event": "cashout.rejected",
  "data": {
    "id": "9d44ce43-a227-4566-b107-5a6bc01cbcde",
    "customer_id": "9b7c5f38-b2b5-4b0d-8e4c-458192e88eae",
    "account_id": "9d0ac58c-2226-4f1c-b305-15e6dc3b47f6",
    "amount": 1000000,
    "currency": "COP",
    "status": "failed",
    "method": "ACH",
    "external_id": "PAYROLL-2392",
    "is_test": false,
    "created_at": "2025-01-20T18:07:18+00:00"
  }
}

​
Suscripciones

{
  "event": "subscription.paid",
  "data": {
    "id": "8c33bd52-f118-3455-a280-4a5ac90bcace",
    "status": "active",
    "amount": 50000,
    "currency": "COP",
    "customer_id": "9dd4158b-0e45-42bc-b56f-a4c1f856814d",
    "next_billing_at": "2025-02-20T00:00:00+00:00",
    "created_at": "2025-01-20T14:00:00+00:00"
  }
}

{
  "event": "subscription.canceled",
  "data": {
    "id": "8c33bd52-f118-3455-a280-4a5ac90bcace",
    "status": "canceled",
    "amount": 50000,
    "currency": "COP",
    "customer_id": "9dd4158b-0e45-42bc-b56f-a4c1f856814d",
    "canceled_at": "2025-01-20T14:00:00+00:00",
    "created_at": "2025-01-01T14:00:00+00:00"
  }
}

​
Cuentas bancarias

{
  "event": "account.connected",
  "data": {
    "id": "9d0ac58c-2226-4f1c-b305-15e6dc3b47f6",
    "customer_id": "9dd4158b-0e45-42bc-b56f-a4c1f856814d",
    "subtype": "SAVINGS",
    "status": "ACTIVE",
    "bank": {
      "id": "9e02966e-8d60-49b0-ad66-372bf73c4a54",
      "name": "Bancolombia"
    },
    "created_at": "2025-01-20T14:00:00+00:00"
  }
}

​
Facturas

{
  "invoice": {
    "id": "9e8f1a2b-3c4d-5e6f-7a8b-9c0d1e2f3a4b",
    "name": "Factura #1234 - Servicio Internet Marzo 2026",
    "amount": 75000,
    "provider": "wisphub",
    "provider_id": "INV-2026-1234",
    "reference": "CLI-5678",
    "status": "CREATED",
    "remarks": null,
    "metadata": {},
    "due_date": "2026-04-30T23:59:59.000000Z",
    "created_at": "2026-04-01T10:30:00.000000Z",
    "updated_at": "2026-04-01T10:30:00.000000Z",
    "payment_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "is_test": false
  },
  "event": {
    "type": "invoice.created",
    "timestamp": 1743508200,
    "environment": "live",
    "company_id": "f1e2d3c4-b5a6-9788-7654-321fedcba098"
  }
}

{
  "invoice": {
    "id": "9e8f1a2b-3c4d-5e6f-7a8b-9c0d1e2f3a4b",
    "name": "Factura #1234 - Servicio Internet Marzo 2026",
    "amount": 75000,
    "provider": "wisphub",
    "provider_id": "INV-2026-1234",
    "reference": "CLI-5678",
    "status": "PAID",
    "remarks": null,
    "metadata": {
      "plan": "50MB",
      "client_code": "CLI-5678"
    },
    "due_date": "2026-04-30T23:59:59.000000Z",
    "created_at": "2026-04-01T10:30:00.000000Z",
    "updated_at": "2026-04-15T14:22:10.000000Z",
    "payment_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "is_test": false,
    "payment": {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "source": "Factura #1234",
      "currency": "COP",
      "amount": 75000,
      "amount_label": "$75,000",
      "title": "Factura #1234",
      "description": "Servicio Internet Marzo 2026",
      "phone": "+573001234567",
      "expiration_at": "2026-04-30T23:59:59.000000Z",
      "due_date": "2026-04-30T23:59:59.000000Z",
      "document_link": null,
      "external_id": "INV-2026-1234",
      "allows": [],
      "status": "APPROVED",
      "is_test": false,
      "created_at": "2026-04-01T10:30:00.000000Z",
      "paid_at": "2026-04-15T14:22:10.000000Z",
      "payment_link": "https://pay.onepay.la/p/a1b2c3d4",
      "redirect_url": "https://miempresa.com/gracias",
      "provider_id": "TXN-987654",
      "metadata": null
    }
  },
  "event": {
    "type": "invoice.paid",
    "timestamp": 1744727530,
    "environment": "live",
    "company_id": "f1e2d3c4-b5a6-9788-7654-321fedcba098"
  }
}

{
  "invoice": {
    "id": "9e8f1a2b-3c4d-5e6f-7a8b-9c0d1e2f3a4b",
    "name": "Factura #1234 - Servicio Internet Marzo 2026",
    "amount": 75000,
    "provider": "wisphub",
    "provider_id": "INV-2026-1234",
    "reference": "CLI-5678",
    "status": "PAID_FROM_PROVIDER",
    "remarks": null,
    "metadata": {
      "plan": "50MB",
      "client_code": "CLI-5678"
    },
    "due_date": "2026-04-30T23:59:59.000000Z",
    "created_at": "2026-04-01T10:30:00.000000Z",
    "updated_at": "2026-04-10T08:15:00.000000Z",
    "payment_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "is_test": false,
    "payment": {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "source": "Factura #1234",
      "currency": "COP",
      "amount": 75000,
      "amount_label": "$75,000",
      "title": "Factura #1234",
      "description": "Servicio Internet Marzo 2026",
      "phone": "+573001234567",
      "expiration_at": "2026-04-30T23:59:59.000000Z",
      "due_date": "2026-04-30T23:59:59.000000Z",
      "document_link": null,
      "external_id": "INV-2026-1234",
      "allows": [],
      "status": "APPROVED",
      "is_test": false,
      "created_at": "2026-04-01T10:30:00.000000Z",
      "paid_at": null,
      "payment_link": "https://pay.onepay.la/p/a1b2c3d4",
      "redirect_url": null,
      "provider_id": null,
      "metadata": null
    }
  },
  "event": {
    "type": "invoice.canceled",
    "timestamp": 1744272900,
    "environment": "live",
    "company_id": "f1e2d3c4-b5a6-9788-7654-321fedcba098"
  }
}
¿Necesitas un evento que no está en esta lista? Revisa la lista completa de eventos y configura tu webhook para recibirlos.