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.

​
Posibles eventos

Eventos disponibles
  • payment.created
  • payment.deleted
  • payment.rejected
  • payment.approved
  • payment.expired
  • payment.partially_paid
  • payment.partial_expired

​
Estados de cobros

  • pending
  • cancelled
  • approved
  • declined
  • in_progress
  • refunded
  • expired
  • partially_paid
  • partial_expired

​
Ejemplos

​
payment.created / payment.approved

{
  "payment": {
    "id": "99a337b3-3a7d-4e0b-b5ea-7098b562d4dd",
    "source": "Renta PAZCNTPDG0 mes mayo",
    "currency": "COP",
    "amount": 180000,
    "amount_label": "$ 180.000",
    "title": "Renta PAZCNTPDG0 mes mayo",
    "description": "PAZCNTPDG0",
    "phone": "+573155555555",
    "expiration_at": null,
    "due_date": null,
    "document_link": null,
    "external_id": "814",
    "allows": {
      "cards": true,
      "accounts": true,
      "card_extra": false,
      "realtime": false,
      "pse": true,
      "transfiya": true
    },
    "status": "pending",
    "is_test": false,
    "created_at": "2023-07-13T15:42:12.000000Z",
    "paid_at": null,
    "payment_link": "https://pagos.onepay.la/payment/99a337b3-3a7d-4e0b-b5ea-7098b562d4dd",
    "redirect_url": null,
    "provider_id": null,
    "metadata": null,
    "customer": {
      "id": "4e5f6a7b-8c9d-0e1f-2345-6789abcdef01",
      "first_name": "Daniela",
      "last_name": "Lozano",
      "email": "danielaloza@gmail.com",
      "phone": "+573155555555",
      "document_type": null,
      "document_number": null,
      "created_at": "2023-07-01T10:00:00.000000Z",
      "is_test": false
    },
    "method": null,
    "splits": [],
    "company": null,
    "commission": null
  },
  "event": {
    "type": "payment.created",
    "timestamp": 1689262934,
    "environment": "live"
  }
}

​
payment.partially_paid

{
  "payment": {
    "id": "9e5ccd4a-d2f0-49dd-87fc-a0da752bd166",
    "source": "Suscripción Premium",
    "currency": "COP",
    "amount": 500000,
    "amount_label": "$ 500.000",
    "title": "Suscripción Premium",
    "description": null,
    "phone": "+573201112233",
    "expiration_at": "2025-04-20T22:36:24.000000Z",
    "due_date": null,
    "document_link": null,
    "external_id": null,
    "allows": {
      "cards": true,
      "accounts": true,
      "card_extra": false,
      "realtime": false,
      "pse": true,
      "transfiya": true
    },
    "status": "partially_paid",
    "is_test": false,
    "created_at": "2025-04-15T10:00:00.000000Z",
    "paid_at": null,
    "payment_link": "https://pagos.onepay.la/payment/9e5ccd4a-d2f0-49dd-87fc-a0da752bd166",
    "redirect_url": null,
    "provider_id": null,
    "metadata": null,
    "customer": null,
    "method": null,
    "splits": [],
    "company": null,
    "commission": null,
    "partial_payment": {
      "total_paid_in_cents": 20000000,
      "total_paid_label": "$ 200.000",
      "remaining_amount_in_cents": 30000000,
      "remaining_label": "$ 300.000",
      "progress_percentage": 40.0,
      "is_fully_paid": false,
      "min_amount_in_cents": 5000000,
      "max_amount_in_cents": null,
      "max_payment_methods": 3,
      "timeout_hours": 24,
      "partial_expires_at": "2025-04-16T10:00:00+00:00",
      "charges": [
        {
          "id": "3f8b7a21-1d4a-4d2e-8f1a-17e2f1e6b9ab",
          "amount_in_cents": 20000000,
          "amount_label": "$ 200.000",
          "payment_method_type": "account",
          "payment_method": "PSE - Bancolombia",
          "paid_at": "2025-04-15T10:30:00+00:00"
        }
      ]
    }
  },
  "event": {
    "type": "payment.partially_paid",
    "timestamp": 1744714200,
    "environment": "live"
  }
}

​
payment.partial_expired

{
  "payment": {
    "id": "9e5ccd4a-d2f0-49dd-87fc-a0da752bd166",
    "source": "Suscripción Premium",
    "currency": "COP",
    "amount": 500000,
    "amount_label": "$ 500.000",
    "title": "Suscripción Premium",
    "description": null,
    "phone": "+573201112233",
    "expiration_at": "2025-04-20T22:36:24.000000Z",
    "due_date": null,
    "document_link": null,
    "external_id": null,
    "allows": {
      "cards": true,
      "accounts": true,
      "card_extra": false,
      "realtime": false,
      "pse": true,
      "transfiya": true
    },
    "status": "partial_expired",
    "is_test": false,
    "created_at": "2025-04-15T10:00:00.000000Z",
    "paid_at": null,
    "payment_link": "https://pagos.onepay.la/payment/9e5ccd4a-d2f0-49dd-87fc-a0da752bd166",
    "redirect_url": null,
    "provider_id": null,
    "metadata": null,
    "customer": null,
    "method": null,
    "splits": [],
    "company": null,
    "commission": null,
    "partial_payment": {
      "total_paid_in_cents": 20000000,
      "total_paid_label": "$ 200.000",
      "remaining_amount_in_cents": 30000000,
      "remaining_label": "$ 300.000",
      "progress_percentage": 40.0,
      "is_fully_paid": false,
      "min_amount_in_cents": 5000000,
      "max_amount_in_cents": null,
      "max_payment_methods": 3,
      "timeout_hours": 24,
      "partial_expires_at": "2025-04-16T10:00:00+00:00",
      "charges": [
        {
          "id": "3f8b7a21-1d4a-4d2e-8f1a-17e2f1e6b9ab",
          "amount_in_cents": 20000000,
          "amount_label": "$ 200.000",
          "payment_method_type": "account",
          "payment_method": "PSE - Bancolombia",
          "paid_at": "2025-04-15T10:30:00+00:00"
        }
      ]
    }
  },
  "event": {
    "type": "payment.partial_expired",
    "timestamp": 1744800600,
    "environment": "live"
  }
}