Obtener un payin
Autorizaciones
JWT de sesión (de register/login) o llave de API (pk_...).
X-API-Key: <token> se acepta como header alternativo.
Parámetros de ruta
Respuesta
El payin.
qr, collect, push, card, checkout, pos Monto en la moneda local, como texto decimal plano (por ejemplo "5000000"). Nunca en notación científica.
El saldo virtual en que se liquida el payin. Los payins de checkout y POS denominan el cobro en el asset de su link (sin currency/local_amount hasta que se usa un método de pago local; el monto del cobro es asset_amount en este asset). Los demás payins acreditados lo traen cuando la cuenta configuró un default_payin_asset distinto de USDT — el neto acreditado se auto-convierte a este asset.
USDT, USDC, BTC, GOLD Solo payins de checkout y POS — el monto del cobro denominado en settlement_asset (presente en todo estado, incluidos pendiente y vencido).
Estado de la auto-conversión — en payins de checkout/POS cuando el pago llegó en un asset distinto de settlement_asset, y en los demás payins cuando la cuenta configuró un default_payin_asset distinto de USDT. pending_retry se reintenta automáticamente. Se omite cuando no aplica conversión.
pending_retry, done pending, credited, unassigned, expired, failed Solo payins con tarjeta que tienen una demora de settlement configurada — cuándo queda disponible el SALDO de este payin (created_at más las settlement_hours de la comisión payin_card). El payin queda confirmado de inmediato: el estado es credited y el webhook payin_credited se emite al momento del pago; lo que espera al settle_at es solo el crédito del saldo (y la auto-conversión, cuando está configurada). Un payin cuya demora ya venció al aprobarse o asignarse se liquida de inmediato. Ausente cuando el saldo se liquida al confirmarse.
Presente (true) mientras el saldo de un payin con tarjeta credited sigue programado para su settle_at. Mientras esté presente, el payin no se puede devolver (422 settlement_pending) — la plata aún no está en tu saldo. Ausente una vez que el saldo cae en el ledger.
Cuándo cayó realmente en tu ledger el saldo de este payin acreditado — al confirmarse para payins sin demora de settlement, o cuando corrió el settlement programado (o un org-admin lo liberó antes) para payins con tarjeta diferidos.
Tu tasa de payin al momento del abono (presente una vez que el pago fue recibido y convertido).
Monto abonado al saldo. También presente SIN fx_rate en cobros checkout/POS liquidados en crypto o vía transferencia CBPay (no aplica cotización FX).
Presente solo cuando el payin tiene devoluciones o un contracargo. Se deriva de los montos acumulados — el status del payin nunca se reescribe.
partial, full USDT acumulado debitado por devoluciones y contracargos de este payin.
Monto acumulado devuelto en la moneda local original.
Presente solo cuando el payin queda failed en cobros activos: dónde se originó el rechazo (provider = el banco del pagador, core = la validación previa al cobro) más el código y mensaje concretos.
Transferencias anunciadas y depósitos sin asignar — de dónde salió la identidad del pagador. declared la enviaste tú, account_identity se usó por defecto el documento verificado del titular, none no había identidad disponible (solo la referencia puede conciliar), bank_event (depósitos sin asignar) se leyó de la transferencia que llegó.
declared, account_identity, none, bank_event Identidad del pagador asociada al payin, cuando se conoce.
Snapshot congelado de la cuenta bancaria de destino anunciada al pagador (payins bank_transfer anunciados en corredores con instrucciones configuradas — hoy CL, PY y US). El texto nunca cambia tras la creación; la imagen QR se regenera al leer con tu branding vigente. En el corredor US/USD este bloque es el riel doméstico (routing number ABA).
Snapshot congelado del riel internacional SWIFT (BIC + banco corresponsal), presente solo en el corredor US/USD cuando tu organización tiene configurada la variante swift. El pagador elige cualquiera de los dos rieles; ambos comparten la misma reference.
Cómo se concilió la transferencia con este payin (traza de auditoría). charge_link significa que el abono pagó el cobro creado para este payin (QR, link de checkout o tarjeta) y se vinculó uno a uno por ese cobro — la señal más fuerte, sin heurísticas. manual_assign significa que un admin de la org lo ruteó a mano.
charge_link, reference, payer_document, payer_account, payer_name, amount_single_candidate, dedicated_clabe, collect_settlement, manual_assign Por qué el depósito NO se pudo conciliar automáticamente, en payins unassigned — no_match, ambiguous_amount (dos o más anuncios comparten el monto), ambiguous_payer, claim_lost (otro evento tomó el anuncio primero) o assigned_to:<payin_id>.
Cantidad de anuncios pendientes que coincidían con el monto y la moneda de un depósito unassigned (2 o más significa que el depósito era ambiguo).