{
  "payin_id": "4f8a1b2c-3d4e-5f60-7a8b-9c0d1e2f3a4b",
  "account_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "country": "BO",
  "currency": "BOB",
  "local_amount": "700.00",
  "fx_rate": "6.91",
  "usdt_credited": "100.302460",
  "fee": "1.000000",
  "settlement_asset": "USDC",
  "conversion_status": "done",
  "instrument_id": "7e3f1b2c-4d5e-6f70-8a9b-0c1d2e3f4a5b",
  "instrument": {
    "instrument_id": "7e3f1b2c-4d5e-6f70-8a9b-0c1d2e3f4a5b",
    "account_number": "701458092378",
    "purpose": "fondeo",
    "status": "active"
  },
  "payer": {
    "name": "JUAN PEREZ",
    "document": "1234567",
    "account": "1000001"
  },
  "idempotency_key": "order-10042"
}

Payin acreditado

Se recibió un cobro fiat y se acreditó a la cuenta. Para links de cobro universal (kind: checkout) el payload trae además settled_via (ej. qr, crypto:tron:usdt, cbpay), settlement_asset y asset_amount; los pagos crypto agregan crypto_amount y los pagos desde la app CBPay agregan transfer_id, asset y amount. Cuando la cuenta configuró un default_payin_asset distinto del asset acreditado, el payload trae además settlement_asset y conversion_status de la conversión automática post-crédito.

Cada entrega incluye X-Webhook-Event, X-Webhook-Event-ID, X-Webhook-Delivery-ID, X-Webhook-Timestamp y X-Webhook-Signature = hex(HMAC-SHA256(secret, timestamp + "." + body)). Responde 2xx; hasta 5 intentos con backoff incremental.

WEBHOOK

payin_credited

{
  "payin_id": "4f8a1b2c-3d4e-5f60-7a8b-9c0d1e2f3a4b",
  "account_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "country": "BO",
  "currency": "BOB",
  "local_amount": "700.00",
  "fx_rate": "6.91",
  "usdt_credited": "100.302460",
  "fee": "1.000000",
  "settlement_asset": "USDC",
  "conversion_status": "done",
  "instrument_id": "7e3f1b2c-4d5e-6f70-8a9b-0c1d2e3f4a5b",
  "instrument": {
    "instrument_id": "7e3f1b2c-4d5e-6f70-8a9b-0c1d2e3f4a5b",
    "account_number": "701458092378",
    "purpose": "fondeo",
    "status": "active"
  },
  "payer": {
    "name": "JUAN PEREZ",
    "document": "1234567",
    "account": "1000001"
  },
  "idempotency_key": "order-10042"
}

Autorizaciones

Authorization

string

header

requerido

JWT de sesión (de register/login) o llave de API (pk_...). X-API-Key: <token> se acepta como header alternativo.

Cuerpo

application/json

payin_id

string

account_id

string

country

string

currency

string

local_amount

string

fx_rate

string

usdt_credited

string

fee

string

settlement_asset

string

conversion_status

string

instrument_id

string<uuid>

Instrumento de depósito dedicado que recibió el payin; se omite cuando no aplica.

instrument

object

Instrumento de depósito dedicado que recibió el payin. Se omite en cobros genéricos y payins históricos.

Show child attributes

payer

object

Identidad del pagador reportada por el banco para créditos nuevos, cuando está disponible.

Show child attributes

idempotency_key

string

Respuesta

200

Devuelve cualquier 2xx para confirmar la entrega.