{
  "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 credited

A fiat collection was received and credited to the account. For universal checkout links (kind: checkout) the payload also carries settled_via (e.g. qr, crypto:tron:usdt, cbpay), settlement_asset and asset_amount; crypto payments add crypto_amount and CBPay app payments add transfer_id, asset and amount. When the account configured a default_payin_asset other than the credited asset the payload also carries settlement_asset and conversion_status for the automatic post-credit conversion.

Every delivery includes X-Webhook-Event, X-Webhook-Event-ID, X-Webhook-Delivery-ID, X-Webhook-Timestamp and X-Webhook-Signature = hex(HMAC-SHA256(secret, timestamp + "." + body)). Respond 2xx; up to 5 attempts with incremental backoff.

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"
}

Authorizations

Authorization

string

header

required

Session JWT (from register/login) or API key (pk_...). X-API-Key: <token> is accepted as an alternative header.

Body

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>

Dedicated deposit instrument that received the payin; omitted when not applicable.

instrument

object

Dedicated deposit instrument that received the payin. Omitted for generic collections and historical payins.

Show child attributes

payer

object

Bank-reported payer identity for new credited pushes, when available.

Show child attributes

idempotency_key

string

Response

200

Return any 2xx to acknowledge the delivery.