Skip to main content
GET
/
api
/
payment-requests
/
{payment_request_id}
Consultar estado de un cobro
curl --request GET \
  --url https://api.tupana.ai/api/payment-requests/{payment_request_id}/ \
  --header 'Authorization: <api-key>'
{
  "payment_request_id": "pr_abc123",
  "status": "paid",
  "amount": 50000,
  "currency": "CLP",
  "payment_method": "card",
  "paid_at": "2026-04-06T12:03:45Z",
  "recipient_id": "me_xyz789",
  "issued_document_id": "doc_111",
  "external_id": "booking_abc123",
  "metadata": {}
}

¿Para qué se usa?

Obtiene el estado actual y los detalles completos de una sesión de cobro. Útil como fallback cuando el webhook todavía no llegó pero el usuario ya regresó a tu sitio por redirect.

Qué hace

  • Retorna el estado actual de la sesión (pending, paid, failed, expired, refunded).
  • Si el pago fue exitoso, incluye issued_document_id con el ID del DTE emitido.
  • Incluye el metadata que enviaste al crear la sesión.

Ejemplos de uso

  • Verificar el estado al regresar del redirect: El usuario vuelve a tu sitio y quieres confirmar si pagó antes de mostrarle la pantalla de confirmación.
  • Polling de respaldo: Si por alguna razón no recibiste el webhook, puedes consultar el estado directamente.

Consideraciones importantes

Webhooks son la fuente primaria

El GET es un mecanismo de respaldo. El flujo recomendado es:
  1. Recibir el webhook payment_request.paid y actualizar tu sistema.
  2. Si no llegó el webhook en un tiempo razonable, consulta el GET.
El campo issued_document_id apunta al DTE emitido y puede usarse para consultar el documento en la API de Facturación.

Authorizations

Authorization
string
header
required

API Key para autenticación. Formato: Api-Key YOUR-API-KEY

Path Parameters

payment_request_id
string
required

ID de la sesión de cobro (ej: pr_abc123).

Response

Datos de la sesión de cobro

payment_request_id
string
Example:

"pr_abc123"

status
enum<string>
Available options:
pending,
paid,
failed,
expired,
refunded
Example:

"paid"

amount
integer
Example:

50000

currency
string
Example:

"CLP"

payment_method
enum<string>
Available options:
card,
bank_transfer
Example:

"card"

paid_at
string<date-time> | null
Example:

"2026-04-06T12:03:45Z"

recipient_id
string
Example:

"me_xyz789"

issued_document_id
string | null

ID del DTE emitido al pagarse. null si el pago aún no fue confirmado.

Example:

"doc_111"

external_id
string | null
Example:

"booking_abc123"

metadata
object