Consultar cargo

curl https://api.onepay.la/v1/customers/session/charges/9e02966f-2ddf-4ee7-a391-5b5b7653e232 \
  -H "Authorization: Bearer sk_test_xxx" \
  -H "x-customer-token: 12|a1b2c3d4e5f6..."

const response = await fetch(
  'https://api.onepay.la/v1/customers/session/charges/9e02966f-2ddf-4ee7-a391-5b5b7653e232',
  {
    headers: {
      'Authorization': 'Bearer sk_test_xxx',
      'X-Customer-Token': '12|a1b2c3d4e5f6...'
    }
  }
);

const charge = await response.json();

import requests

response = requests.get(
    'https://api.onepay.la/v1/customers/session/charges/9e02966f-2ddf-4ee7-a391-5b5b7653e232',
    headers={
        'Authorization': 'Bearer sk_test_xxx',
        'X-Customer-Token': '12|a1b2c3d4e5f6...'
    }
)

charge = response.json()

{
  "charge_id": "9e02966f-2ddf-4ee7-a391-5b5b7653e232",
  "status": "created",
  "amount": 50000,
  "currency": "COP",
  "description": "Pago mensualidad marzo",
  "remarks": null,
  "paid_at": null,
  "created_at": "2026-03-17T21:30:00+00:00"
}

{
  "charge_id": "9e02966f-2ddf-4ee7-a391-5b5b7653e232",
  "status": "paid",
  "amount": 50000,
  "currency": "COP",
  "description": "Pago mensualidad marzo",
  "remarks": null,
  "paid_at": "2026-03-17T21:32:15+00:00",
  "created_at": "2026-03-17T21:30:00+00:00"
}

{
  "charge_id": "9e02966f-2ddf-4ee7-a391-5b5b7653e232",
  "status": "failed",
  "amount": 50000,
  "currency": "COP",
  "description": "Pago mensualidad marzo",
  "remarks": "CUSTOMER_APPROVAL_EXPIRED",
  "paid_at": null,
  "created_at": "2026-03-17T21:30:00+00:00"
}

{
  "message": "Cargo no encontrado."
}

GET

customers

session

charges

{chargeId}

curl https://api.onepay.la/v1/customers/session/charges/9e02966f-2ddf-4ee7-a391-5b5b7653e232 \
  -H "Authorization: Bearer sk_test_xxx" \
  -H "x-customer-token: 12|a1b2c3d4e5f6..."

const response = await fetch(
  'https://api.onepay.la/v1/customers/session/charges/9e02966f-2ddf-4ee7-a391-5b5b7653e232',
  {
    headers: {
      'Authorization': 'Bearer sk_test_xxx',
      'X-Customer-Token': '12|a1b2c3d4e5f6...'
    }
  }
);

const charge = await response.json();

import requests

response = requests.get(
    'https://api.onepay.la/v1/customers/session/charges/9e02966f-2ddf-4ee7-a391-5b5b7653e232',
    headers={
        'Authorization': 'Bearer sk_test_xxx',
        'X-Customer-Token': '12|a1b2c3d4e5f6...'
    }
)

charge = response.json()

{
  "charge_id": "9e02966f-2ddf-4ee7-a391-5b5b7653e232",
  "status": "created",
  "amount": 50000,
  "currency": "COP",
  "description": "Pago mensualidad marzo",
  "remarks": null,
  "paid_at": null,
  "created_at": "2026-03-17T21:30:00+00:00"
}

{
  "charge_id": "9e02966f-2ddf-4ee7-a391-5b5b7653e232",
  "status": "paid",
  "amount": 50000,
  "currency": "COP",
  "description": "Pago mensualidad marzo",
  "remarks": null,
  "paid_at": "2026-03-17T21:32:15+00:00",
  "created_at": "2026-03-17T21:30:00+00:00"
}

{
  "charge_id": "9e02966f-2ddf-4ee7-a391-5b5b7653e232",
  "status": "failed",
  "amount": 50000,
  "currency": "COP",
  "description": "Pago mensualidad marzo",
  "remarks": "CUSTOMER_APPROVAL_EXPIRED",
  "paid_at": null,
  "created_at": "2026-03-17T21:30:00+00:00"
}

{
  "message": "Cargo no encontrado."
}

Consulta el estado actual de un cargo previamente creado con POST /customers/session/charges. Útil para hacer polling del estado del cargo mientras el cliente aprueba o rechaza vía WhatsApp.

Solo puedes consultar cargos que pertenezcan al cliente autenticado. Intentar consultar un cargo de otro cliente retorna 404.

Headers

string

required

Bearer token de tu empresa.

string

required

Token de sesión del cliente obtenido en /customers/login/verify.

Path Parameters

string

required

ID del cargo a consultar. Retornado al crear el cargo con POST /customers/session/charges.

Response

string

Identificador único del cargo.

string

Estado actual del cargo. Valores posibles:

created — Pendiente de aprobación
paid — Aprobado y cobrado exitosamente
failed — Rechazado o expirado

integer

Monto del cargo en centavos.

string

Moneda del cargo (COP, USD).

string

Descripción del cargo.

string | null

Motivo del fallo cuando status es failed. null en otros estados.

string | null

Fecha y hora del pago en formato ISO 8601. null si aún no ha sido pagado.

string

Fecha y hora de creación del cargo en formato ISO 8601.

curl https://api.onepay.la/v1/customers/session/charges/9e02966f-2ddf-4ee7-a391-5b5b7653e232 \
  -H "Authorization: Bearer sk_test_xxx" \
  -H "x-customer-token: 12|a1b2c3d4e5f6..."

const response = await fetch(
  'https://api.onepay.la/v1/customers/session/charges/9e02966f-2ddf-4ee7-a391-5b5b7653e232',
  {
    headers: {
      'Authorization': 'Bearer sk_test_xxx',
      'X-Customer-Token': '12|a1b2c3d4e5f6...'
    }
  }
);

const charge = await response.json();

import requests

response = requests.get(
    'https://api.onepay.la/v1/customers/session/charges/9e02966f-2ddf-4ee7-a391-5b5b7653e232',
    headers={
        'Authorization': 'Bearer sk_test_xxx',
        'X-Customer-Token': '12|a1b2c3d4e5f6...'
    }
)

charge = response.json()

{
  "charge_id": "9e02966f-2ddf-4ee7-a391-5b5b7653e232",
  "status": "created",
  "amount": 50000,
  "currency": "COP",
  "description": "Pago mensualidad marzo",
  "remarks": null,
  "paid_at": null,
  "created_at": "2026-03-17T21:30:00+00:00"
}

{
  "charge_id": "9e02966f-2ddf-4ee7-a391-5b5b7653e232",
  "status": "paid",
  "amount": 50000,
  "currency": "COP",
  "description": "Pago mensualidad marzo",
  "remarks": null,
  "paid_at": "2026-03-17T21:32:15+00:00",
  "created_at": "2026-03-17T21:30:00+00:00"
}

{
  "charge_id": "9e02966f-2ddf-4ee7-a391-5b5b7653e232",
  "status": "failed",
  "amount": 50000,
  "currency": "COP",
  "description": "Pago mensualidad marzo",
  "remarks": "CUSTOMER_APPROVAL_EXPIRED",
  "paid_at": null,
  "created_at": "2026-03-17T21:30:00+00:00"
}

{
  "message": "Cargo no encontrado."
}

Crear cargo

Enviar campaña masiva de WhatsApp

API

Empresas

Métodos de pago

Recaudo

Balances

Webhooks

Fintech as a service

Headers

Path Parameters

Response

​Headers

​Path Parameters

​Response

Headers

Path Parameters

Response