Skip to main content
GET
/
payments
/
{payment_id}
curl https://api.onepay.la/v1/payments/9e5ccd4a-d2f0-49dd-87fc-a0da752bd166 \
  -H "Authorization: Bearer sk_test_xxx"

{
  "id": "9bf2bc44-28d4-4693-9896-7fc1fe1f5b65",
  "source": "Factura Movistar Noviembre",
  "currency": "COP",
  "amount": 63040,
  "amount_label": "$ 63.040",
  "title": "Factura Movistar Noviembre",
  "description": "Factura Movistar Noviembre",
  "phone": "+573138977841",
  "expiration_at": "2024-05-03T16:47:09.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": "approved",
  "is_test": false,
  "created_at": "2024-05-02T16:47:09.000000Z",
  "paid_at": "2024-05-02T18:00:00.000000Z",
  "payment_link": null,
  "redirect_url": null,
  "provider_id": null,
  "metadata": null,
  "customer": {
    "id": "4e5f6a7b-8c9d-0e1f-2345-6789abcdef01",
    "first_name": "Juan",
    "last_name": "Demo",
    "email": "hola@onepay.la",
    "phone": "+573167591039",
    "document_type": "CC",
    "document_number": "1234567890",
    "created_at": "2024-04-01T10:00:00.000000Z",
    "is_test": false
  },
  "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.

​
payment_id
string
required
ID del cobro creado previamente. Ver cómo crear un cobro.
curl https://api.onepay.la/v1/payments/9e5ccd4a-d2f0-49dd-87fc-a0da752bd166 \
  -H "Authorization: Bearer sk_test_xxx"

​
Response

​
id
string
Identificador único del cobro
​
source
string
Título del cobro (mismo valor que title)
​
currency
string
Código de moneda ISO (ej: COP)
​
amount
number
Monto del cobro en pesos
​
amount_label
string
Monto formateado (ej: "$ 1.400.000")
​
title
string
Título del cobro
​
description
string
Descripción del cobro
​
phone
string
Número de teléfono del cliente
​
expiration_at
string
Fecha de expiración del cobro (ISO 8601)
​
due_date
string
Fecha de vencimiento (ISO 8601)
​
document_link
string
URL del documento adjunto
​
external_id
string
ID externo del cobro en tu sistema
​
allows
object
Métodos de pago habilitados para este cobro
​
status
string
Estado actual del cobro: pending, approved, declined, cancelled, expired, in_progress, refunded, partially_paid, partial_expired
​
is_test
boolean
Indica si el cobro fue creado en modo prueba
​
created_at
string
Fecha de creación (ISO 8601)
​
paid_at
string
Fecha de pago (ISO 8601). null si aún no ha sido pagado.
​
payment_link
string
URL del link de pago
​
redirect_url
string
URL de redirección tras el pago
​
provider_id
string
ID del proveedor de pago
​
metadata
object
Metadatos adicionales del cobro
​
customer
object
Datos del cliente que realizó el pago. null si aún no ha pagado.
​
method
object
Método de pago utilizado. null si aún no ha pagado.
​
splits
array
Reglas de split aplicadas al cobro
​
company
object
Datos de la empresa. Presente cuando se consulta con credenciales que incluyen la empresa.
​
commission
object
Comisión aplicada. null si no aplica.
​
partial_payment
object
Información de pago parcial. Solo presente cuando el cobro tiene partial_payment_config configurado. Ver crear cobro para detalle de campos.

​
Response Example

{
  "id": "9bf2bc44-28d4-4693-9896-7fc1fe1f5b65",
  "source": "Factura Movistar Noviembre",
  "currency": "COP",
  "amount": 63040,
  "amount_label": "$ 63.040",
  "title": "Factura Movistar Noviembre",
  "description": "Factura Movistar Noviembre",
  "phone": "+573138977841",
  "expiration_at": "2024-05-03T16:47:09.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": "approved",
  "is_test": false,
  "created_at": "2024-05-02T16:47:09.000000Z",
  "paid_at": "2024-05-02T18:00:00.000000Z",
  "payment_link": null,
  "redirect_url": null,
  "provider_id": null,
  "metadata": null,
  "customer": {
    "id": "4e5f6a7b-8c9d-0e1f-2345-6789abcdef01",
    "first_name": "Juan",
    "last_name": "Demo",
    "email": "hola@onepay.la",
    "phone": "+573167591039",
    "document_type": "CC",
    "document_number": "1234567890",
    "created_at": "2024-04-01T10:00:00.000000Z",
    "is_test": false
  },
  "method": null,
  "splits": [],
  "company": null,
  "commission": null
}