Listar payment intents

Obtiene una lista paginada de payment intents (intentos de pago) de tu compañía

GET https://api.onepay.la/v1/payment-intents

Listar payment intents

cURL

curl --request GET \
  --url https://api.onepay.la/v1/payment-intents \
  --header 'Authorization: Bearer <token>'

200

{
  "current_page": 1,
  "from": 1,
  "last_page": 3,
  "per_page": 20,
  "to": 20,
  "total": 50,
  "data": [
    {
      "id": "a1b2c3d4-1111-2222-3333-444455556666",
      "description": "Cargo suscripción Premium",
      "amount": 63040,
      "amount_label": "$63.040",
      "currency": "COP",
      "status": "processing",
      "payment_method_type": "CreditCard",
      "payment_method_id": "3f8b7a21-1d4a-4d2e-8f1a-17e2f1e6b9ab",
      "source": {
        "type": "Link",
        "id": "9b7e45b5-05e2-4b4e-bb1c-3d8a6a3c15e2"
      },
      "created_at": "2024-11-02T16:47:09.000000Z",
      "paid_at": null,
      "remarks": null,
      "is_test": true,
      "network_id": null,
      "external_id": null
    },
    {
      "id": "7777c3d4-8888-9999-aaaa-bbbbccccdddd",
      "description": "Pago factura 001-2024",
      "amount": 250000,
      "amount_label": "$250.000",
      "currency": "COP",
      "status": "paid",
      "payment_method_type": "Account",
      "payment_method_id": "8d3fe7c0-6f0c-4de0-99d2-4c86f4f0a9f0",
      "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"
    }
  ]
}

Query Parameters

filter[id] · string

ID único del payment intent

filter[status] · string

Filtra por estado. Valores posibles: created, paid, processing, failed, refunded, disputed.

filter[external_id] · string

Identificador externo definido por tu sistema para correlacionar transacciones.

sort · string

Ordena los resultados. Valores: created_at | -created_at | paid_at | -paid_at

page · number

Página a consultar (paginación base 1). Por defecto: 1

Response

data · array

Lista de payment intents

Show Ver objeto

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

current_page · number

Página actual

from · number|null

Índice inicial del listado

last_page · number

Número total de páginas

per_page · number

Tamaño de página (por defecto 20)

to · number|null

Índice final del listado

total · number

Total de registros

Response Example

200

{
  "current_page": 1,
  "from": 1,
  "last_page": 3,
  "per_page": 20,
  "to": 20,
  "total": 50,
  "data": [
    {
      "id": "a1b2c3d4-1111-2222-3333-444455556666",
      "description": "Cargo suscripción Premium",
      "amount": 63040,
      "amount_label": "$63.040",
      "currency": "COP",
      "status": "processing",
      "payment_method_type": "CreditCard",
      "payment_method_id": "3f8b7a21-1d4a-4d2e-8f1a-17e2f1e6b9ab",
      "source": {
        "type": "Link",
        "id": "9b7e45b5-05e2-4b4e-bb1c-3d8a6a3c15e2"
      },
      "created_at": "2024-11-02T16:47:09.000000Z",
      "paid_at": null,
      "remarks": null,
      "is_test": true,
      "network_id": null,
      "external_id": null
    },
    {
      "id": "7777c3d4-8888-9999-aaaa-bbbbccccdddd",
      "description": "Pago factura 001-2024",
      "amount": 250000,
      "amount_label": "$250.000",
      "currency": "COP",
      "status": "paid",
      "payment_method_type": "Account",
      "payment_method_id": "8d3fe7c0-6f0c-4de0-99d2-4c86f4f0a9f0",
      "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"
    }
  ]
}