The compense CLI

compense --help              # Python and JavaScript
npx compense --version       # JavaScript only: prints the SDK version

export COMPENSE_API_KEY="cmp_..."                 # PowerShell: $env:COMPENSE_API_KEY = "cmp_..."
compense health                                   # sandbox by default
compense health --environment dev
compense health --base-url https://sandbox.dev.compense.co/gw

compense health

{
  "status": "ok",
  "tenant": "horizonte",
  "scopes": ["affiliates:read", "credits:submit", "webhooks:read", "webhooks:manage"]
}

# Catalog (everything or one category: credits, subsidies, monetary_allowance, affiliates,
# wallets, loans, health, admin, pqrs, general)
compense events --category loans

# Register an endpoint: repeat --event for each event. Save the "secret" it prints.
compense endpoint-create \
  --url https://erp.horizonte.example/compense/webhooks \
  --event payment.received \
  --event installment.overdue \
  --label "ERP Caja Horizonte"

compense endpoints

# Signed test. Without --endpoint it picks an active endpoint subscribed to the event
# (or, if there isn't one, the first active one).
compense trigger payment.received
compense trigger test.ping --endpoint 3f1a2b3c-0000-4a1b-9c2d-000000000001

# Failed deliveries for one event and a retry of one of them
compense deliveries --status failed --event-type payment.received
compense replay 8b7c6d5e-0000-4a1b-9c2d-000000000301

compense deliveries --status failed | jq -r '.results[].id' | while read -r ID; do
  compense replay "$ID"
done

compense clock create 2026-10-01T00:00:00Z           # or Unix seconds: 1790812800
compense clock advance tcl-… 2592000                 # 30 days; prints the clock with a NEW id
compense clock get tcl-…

# Chain advances with jq
ID=$(compense clock create 2026-07-15T00:00:00Z | jq -r .id)
ID=$(compense clock advance "$ID" 5443200 | jq -r .id)   # 63 days (maximum per call)
compense clock get "$ID" | jq -r .current_time

# Transfer: without --status it starts at PENDING. 22.22 → FAILED, 33.33 → RETURNED.
compense simulate transfer --amount 33.33
compense simulate transfer --status PROCESSING --amount 33.33
compense simulate transfer --status SETTLED --amount 33.33 --transaction-id NOVA-P2P-2026-000123

# Disbursement of a sandbox credit application
compense simulate credit sbx-E-… --status PENDING

{
  "object": "wallet_transfer",
  "previous_status": "SETTLED",
  "status": "RETURNED",
  "terminal": true,
  "amount": 33.33,
  "reference": "NOVA-P2P-2026-000123",
  "reason_code": "TRANSFER_RETURNED",
  "environment": "sandbox"
}

compense listen --forward-to http://localhost:8000/compense/webhooks --port 8787