Skip to main content
GET
/
payment-intents
/
{id}
Obtener payment intent
curl --request GET \
  --url https://api.onepay.la/v1/payment-intents/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "9bf2bc44-28d4-4693-9896-7fc1fe1f5b65",
  "description": "Pago factura 001-2024",
  "amount": 63040,
  "amount_label": "$63.040",
  "currency": "COP",
  "status": "paid",
  "payment_method_type": "CreditCard",
  "payment_method_id": "3f8b7a21-1d4a-4d2e-8f1a-17e2f1e6b9ab",
  "source": {
    "type": "Payment",
    "id": "12e34567-89ab-4cde-f012-3456789abcde"
  },
  "created_at": "2024-10-20T12:00:00.000000Z",
  "paid_at": "2024-10-20T12:10:10.000000Z",
  "remarks": null,
  "is_test": true,
  "network_id": "prov-123",
  "external_id": "EXT-12345",
  "method": {
    "id": "3f8b7a21-1d4a-4d2e-8f1a-17e2f1e6b9ab",
    "brand": "visa",
    "label": "Personal",
    "last_four": "4242",
    "expiration_date": "12/2028",
    "customer_id": "1c2d3e4f-5678-90ab-cdef-111213141516",
    "created_at": "2024-09-15T10:20:30.000000Z",
    "country": "CO"
  },
  "customer": {
    "id": "4e5f6a7b-8c9d-0e1f-2345-6789abcdef01",
    "first_name": "Juan",
    "last_name": "Pérez",
    "email": "juan.perez@example.com",
    "phone": "+573001112233",
    "document_type": "CC",
    "document_number": "1234567890",
    "created_at": "2024-09-10T09:00:00.000000Z",
    "is_test": true
  }
}

​
Path Parameters

​
id
string
ID del payment intent (UUID)

​
Response

​
id
string
Identificador único (UUID)
​
description
string
Descripción del cobro
​
amount
number
Monto del cobro en unidades monetarias (no centavos)
​
amount_label
string
Monto formateado con moneda
​
currency
string
Moneda. Ej: COP
​
status
string
Estado actual
​
payment_method_type
string
Tipo del método de pago (CreditCard, Account, Wallet, etc.)
​
payment_method_id
string
ID del método de pago
​
source
object
Origen del cobro (Link, Payment, Plan, Subscription). Puede variar según el caso.
​
created_at
string
Fecha de creación (ISO 8601)
​
paid_at
string|null
Fecha de pago si aplica
​
remarks
object|null
Observaciones o marcas internas
​
is_test
boolean
Indica si pertenece al entorno de pruebas
​
network_id
string|null
ID de la red/proveedor si aplica
​
external_id
string|null
ID externo proporcionado por tu sistema
​
method
object
Método de pago asociado. La forma del objeto depende de payment_method_type.
​
customer
object
Cliente asociado al cobro

​
Response Example

{
  "id": "9bf2bc44-28d4-4693-9896-7fc1fe1f5b65",
  "description": "Pago factura 001-2024",
  "amount": 63040,
  "amount_label": "$63.040",
  "currency": "COP",
  "status": "paid",
  "payment_method_type": "CreditCard",
  "payment_method_id": "3f8b7a21-1d4a-4d2e-8f1a-17e2f1e6b9ab",
  "source": {
    "type": "Payment",
    "id": "12e34567-89ab-4cde-f012-3456789abcde"
  },
  "created_at": "2024-10-20T12:00:00.000000Z",
  "paid_at": "2024-10-20T12:10:10.000000Z",
  "remarks": null,
  "is_test": true,
  "network_id": "prov-123",
  "external_id": "EXT-12345",
  "method": {
    "id": "3f8b7a21-1d4a-4d2e-8f1a-17e2f1e6b9ab",
    "brand": "visa",
    "label": "Personal",
    "last_four": "4242",
    "expiration_date": "12/2028",
    "customer_id": "1c2d3e4f-5678-90ab-cdef-111213141516",
    "created_at": "2024-09-15T10:20:30.000000Z",
    "country": "CO"
  },
  "customer": {
    "id": "4e5f6a7b-8c9d-0e1f-2345-6789abcdef01",
    "first_name": "Juan",
    "last_name": "Pérez",
    "email": "juan.perez@example.com",
    "phone": "+573001112233",
    "document_type": "CC",
    "document_number": "1234567890",
    "created_at": "2024-09-10T09:00:00.000000Z",
    "is_test": true
  }
}