Cómo cobrar

Abres un cobro, le muestras las instrucciones a tu cliente, él paga y el dinero entra a tu saldo.

Para cobrar creas una cuenta de cobro (funding account). Caibo la abre con el banco del país y te devuelve las instrucciones que le muestras a tu cliente: un código PIX, una cuenta para transferir. Cuando el banco confirma el pago, lo acreditamos a tu saldo y te avisamos.

POST /v1/funding-accounts 201 pending webhook funding_account.active con instrucciones Muestra las instrucciones Paga webhook payin.completed GET /v1/balances Tu sistema Caibo Pay Tu cliente

Dos formas de cobrar

Capabilities dice, para cada método y moneda, cuál se usa (collection):

collectionCómo se pidePara qué
paymentCon amountUn pago único por un monto exacto: una orden, una factura. Se cierra cuando se paga.
accountSin amountUna cuenta que recibe cualquier depósito, de cualquier monto, mientras esté abierta.

Si pides la forma equivocada, la API te lo dice: 422 amount_required (ese cobro necesita un monto) o 422 one_payment_unavailable (ese cobro no admite monto).

El pagador paga la orden, y nada más

En un pago único, lo que ve tu cliente es exactamente el monto de tu orden: una orden de 1,000.00 PEN se paga con 1,000.00 PEN. Si el banco cobra una comisión por recibir, la cubre Caibo; tu cliente no la ve ni la paga.

Estados de una cuenta de cobro

statusQué significa
pendingLa estamos abriendo con el banco.
activeLista: instructions trae lo que el pagador necesita.
failedNo se pudo abrir; failure_code dice por qué. No se muestran instrucciones.
closedYa no recibe depósitos. Un pago único se cierra cuando su cobro termina.
EventoCuándo
funding_account.activeLa cuenta está lista, con sus instrucciones.
funding_account.failedNo se pudo abrir.
payin.completedUn pago entró y se acreditó a tu saldo.
payin.failedUn pago no se concretó (por ejemplo, venció sin pagarse).

Dónde termina el dinero

Cada cobro se acredita en tu saldo en su settlement_currency: la moneda de liquidación que indica capabilities (settlement_asset) o la que elijas entre settlement_currencies. No hay etapa intermedia: el dinero se registra recién cuando el banco confirma, y entonces ya está disponible.

En esta página