Skip to main content
GET
/
invoices
/
{invoice_id}
Obtener factura
curl --request GET \
  --url https://api.onepay.la/v1/invoices/{invoice_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "2f2b1e5a-1a2b-4c33-8a18-5e9f3b9f4b1a",
  "name": "Internet plan - Octubre",
  "amount": 50000,
  "provider": "biller",
  "provider_id": "987654",
  "reference": "INV-12345678",
  "status": "CREATED",
  "remarks": null,
  "metadata": { "key": "value" },
  "due_date": null,
  "created_at": "2025-10-20T15:06:00.000000Z",
  "updated_at": "2025-10-20T15:06:00.000000Z",
  "payment_id": "c1f4b0aa-6a12-4471-8a3d-1a2b3c4d5e6f",
  "is_test": false,
  "partial_payment_config": null,
  "payment": {
    "id": "c1f4b0aa-6a12-4471-8a3d-1a2b3c4d5e6f",
    "source": "Internet plan - Octubre",
    "currency": "COP",
    "amount": 50000,
    "amount_label": "$ 50.000",
    "title": "Internet plan - Octubre",
    "description": "Internet plan - Octubre",
    "phone": "+573167591038",
    "expiration_at": null,
    "due_date": null,
    "document_link": "https://example.com/document.pdf",
    "external_id": "987654",
    "allows": { "accounts": true, "cards": true, "card_extra": false, "realtime": false },
    "status": "pending",
    "is_test": false,
    "created_at": "2025-10-20T15:06:00.000000Z",
    "paid_at": null,
    "payment_link": "https://pagos.onepay.la/payment/c1f4b0aa-6a12-4471-8a3d-1a2b3c4d5e6f",
    "redirect_url": null,
    "provider_id": null,
    "metadata": null,
    "customer": null,
    "method": null,
    "splits": [],
    "company": null,
    "commission": null
  }
}

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.

Path params

invoice_id
string
required
ID de la factura creada previamente. Ver cómo crear una factura.

Response

id
string
Identificador único de la factura
name
string
Nombre o concepto de la factura
amount
number
Monto de la factura en pesos
provider
string
Proveedor de la factura (ej: "biller")
provider_id
string
ID de la factura en tu sistema
reference
string
Referencia de pago de la factura
status
string
Estado de la factura: CREATED, PAID, FAILED, CANCELLED
remarks
string
Notas o comentarios adicionales
metadata
object
Metadatos adicionales de la factura
due_date
string
Fecha de vencimiento de la factura (ISO 8601)
created_at
string
Fecha de creación (ISO 8601)
updated_at
string
Fecha de última actualización (ISO 8601)
payment_id
string
ID del cobro asociado a esta factura
is_test
boolean
Indica si la factura fue creada en modo prueba
partial_payment_config
object
Configuración de pagos parciales. null si no aplica.
payment
object
Cobro asociado a la factura (objeto completo PaymentJsonResource). Ver crear cobro para detalle de campos.

Response Example

{
  "id": "2f2b1e5a-1a2b-4c33-8a18-5e9f3b9f4b1a",
  "name": "Internet plan - Octubre",
  "amount": 50000,
  "provider": "biller",
  "provider_id": "987654",
  "reference": "INV-12345678",
  "status": "CREATED",
  "remarks": null,
  "metadata": { "key": "value" },
  "due_date": null,
  "created_at": "2025-10-20T15:06:00.000000Z",
  "updated_at": "2025-10-20T15:06:00.000000Z",
  "payment_id": "c1f4b0aa-6a12-4471-8a3d-1a2b3c4d5e6f",
  "is_test": false,
  "partial_payment_config": null,
  "payment": {
    "id": "c1f4b0aa-6a12-4471-8a3d-1a2b3c4d5e6f",
    "source": "Internet plan - Octubre",
    "currency": "COP",
    "amount": 50000,
    "amount_label": "$ 50.000",
    "title": "Internet plan - Octubre",
    "description": "Internet plan - Octubre",
    "phone": "+573167591038",
    "expiration_at": null,
    "due_date": null,
    "document_link": "https://example.com/document.pdf",
    "external_id": "987654",
    "allows": { "accounts": true, "cards": true, "card_extra": false, "realtime": false },
    "status": "pending",
    "is_test": false,
    "created_at": "2025-10-20T15:06:00.000000Z",
    "paid_at": null,
    "payment_link": "https://pagos.onepay.la/payment/c1f4b0aa-6a12-4471-8a3d-1a2b3c4d5e6f",
    "redirect_url": null,
    "provider_id": null,
    "metadata": null,
    "customer": null,
    "method": null,
    "splits": [],
    "company": null,
    "commission": null
  }
}
Códigos de error
  • 401 Unauthorized: token ausente o inválido.
  • 403 Forbidden: compañía inactiva o sin permisos.
  • 404 Not Found: la factura no existe o pertenece a otra compañía.