CLI Command Reference

This page lists every command in @koyweforest/cli v0.14.1 (142 commands total). It is generated from the CLI’s own --commands output, so it cannot drift from the shipped tool.

Tip for agents: The same JSON that generates this page is published at /cli-commands.json. It includes the underlying API method and path for every command — useful when translating between CLI invocations and direct REST calls.

Commands marked with a 📐 accept --schema to print the full JSON schema for their request body. Run the command with --schema before constructing a payload:


npx @koyweforest/cli orders create --schema

See also: CLI overview & installation, API ↔ CLI Cross-Reference (same data indexed by REST endpoint), Error codes.

Setup & Init

`koywe init`

Set up CLI credentials: log in via browser, then create API keys via the API

Flag	Description
`--env <env>`	Environment (sandbox\|production)
`--port <port>`	Local port for the callback server (default: random)
`--timeout <seconds>`	Timeout in seconds waiting for browser auth (default: 120)
`--org-id <orgId>`	Organization ID (skip auto-selection)
`--merchant-id <merchantId>`	Merchant ID (create merchant-scoped credentials instead of org-scoped)
`--name <name>`	Credential name (default: “CLI”)
`--roles <roles...>`	Roles to assign (default: k3r_operator)

`koywe setup`

New user setup: sign up via browser, then submit a pre-onboarding registration

Flag	Description
`--env <env>`	Environment (sandbox\|production)
`--port <port>`	Local port for the callback server (default: random)
`--timeout <seconds>`	Timeout in seconds waiting for browser auth (default: 120)
`--data <json>`	Pre-onboarding draft JSON body (applicant + company)
`--file <path>`	JSON file with pre-onboarding draft body
`--skip-onboarding`	Only authenticate, skip draft creation
`--schema`	Print expected JSON schema for the pre-onboarding draft body

Guided Flows

`koywe flow deal`

Create a crypto deal: get quote → create deal → optionally transfer

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--type <type>`	Deal type (ONRAMP\|OFFRAMP)
`--origin <currency>`	Origin currency symbol (e.g. CLP, USDC)
`--destination <currency>`	Destination currency symbol (e.g. USDC, CLP)
`--network <network>`	Blockchain network (ETHEREUM\|POLYGON\|SOLANA\|TRON\|BSC\|BITCOIN\|BASE\|ALGORAND)
`--destination-account-id <id>`	Destination crypto account ID
`--amount-in <amount>`	Amount in origin currency
`--amount-out <amount>`	Amount in destination currency
`--contact-id <id>`	Contact ID
`--payment-method <method>`	Payment method for the quote
`--mfa-token <token>`	MFA token for deal creation
`--transfer`	Immediately trigger the transfer after deal creation
`--destination-email <email>`	Recipient email (required with —transfer)
`--destination-address <address>`	Destination address (required with —transfer)
`--document-number <number>`	Recipient document number (optional with —transfer)

`koywe flow order`

Create an order: get quote → create order → wait for approval if needed

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--type <type>`	Order type (PAYIN\|PAYOUT\|BALANCE_TRANSFER\|PAYMENT_LINK\|INTER_MERCHANT_TRANSFER)
`--origin <currency>`	Origin currency symbol (e.g. CLP, USD)
`--destination <currency>`	Destination currency symbol (e.g. USDC, CLP)
`--amount-in <amount>`	Amount in origin currency
`--amount-out <amount>`	Amount in destination currency
`--destination-account-id <id>`	Destination account ID (required for PAYOUT)
`--contact-id <id>`	Contact ID
`--payment-method <method>`	Payment method (e.g. KHIPU, PSE, PIX)
`--external-id <id>`	Idempotent external identifier
`--description <text>`	Order description
`--mfa-token <token>`	MFA token (skip waiting, confirm immediately)
`--wait`	Poll until order leaves ON_HOLD status (default: false)
`--poll-interval <seconds>`	Seconds between status polls (default: 5)
`--poll-timeout <seconds>`	Max seconds to wait for approval (default: 300)

Authentication

`koywe auth browser-login`

Authenticate via browser-based login

Flag	Description
`--env <env>`	Environment (sandbox\|production)
`--port <port>`	Local port for the callback server (default: random)
`--timeout <seconds>`	Timeout in seconds waiting for browser auth (default: 120)

`koywe auth credentials create`

Create API credentials for a merchant

Endpoint: POST /auth/organizations/{orgId}/merchants/{merchantId}/credentials · context: merchant · auth: mfa-optional

Flag	Description
`--name <name>`	Credential name
`--roles <roles...>`	Merchant role IDs to assign
`--org-id <orgId>`	Organization ID (overrides context)
`--merchant-id <merchantId>`	Merchant ID (overrides context)
`--mfa-token <token>`	MFA token for policy-protected operations

`koywe auth credentials create-org`

Create API credentials for an organization

Endpoint: POST /auth/organizations/{orgId}/credentials · context: org · auth: mfa-optional

Flag	Description
`--name <name>`	Credential name
`--roles <roles...>`	Organization role IDs to assign
`--org-id <orgId>`	Organization ID (overrides context)
`--mfa-token <token>`	MFA token for policy-protected operations

`koywe auth credentials create-pos` 📐

Create POS credentials for a merchant

Endpoint: POST /auth/organizations/{orgId}/merchants/{merchantId}/pos/credentials/create · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID (overrides context)
`--merchant-id <merchantId>`	Merchant ID (overrides context)
`--data <json>`	POS credentials JSON body (alias, password)
`--file <path>`	JSON file with POS credentials body
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

`koywe auth login`

Authenticate with API key and secret

Endpoint: POST /auth/sign-in · auth: none

Flag	Description
`--api-key <key>`	API key (required)
`--secret <secret>`	API secret (required)
`--env <env>`	Environment (sandbox\|production)

`koywe auth me`

Get current user information

Endpoint: GET /auth/me

No options

`koywe auth mfa challenge`

Request an MFA challenge nonce

Endpoint: POST /organizations/{orgId}/webauthn/challenge · context: org

Flag	Description
`--org-id <orgId>`	Organization ID

`koywe auth mfa challenge-sign`

Full MFA flow: challenge → sign → verify → return mfaToken

Endpoint: POST /organizations/{orgId}/webauthn/challenge + /verify · context: org

Flag	Description
`--private-key-file <path>`	Path to PEM private key file
`--public-key-file <path>`	Path to PEM public key file
`--org-id <orgId>`	Organization ID

`koywe auth mfa keygen`

Generate a P-256 keypair for delegated signing

Flag	Description
`--private-key-file <path>`	Private key output path
`--public-key-file <path>`	Public key output path

`koywe auth mfa prepare`

Start delegated MFA enrollment by sending your public key

Endpoint: POST /auth/organizations/{orgId}/api-users/mfa/prepare · context: org

Flag	Description
`--public-key-file <path>`	Path to PEM public key file
`--org-id <orgId>`	Organization ID

`koywe auth mfa sign`

Sign a body with your delegated P-256 key (local operation, no API call)

Flag	Description
`--private-key-file <path>`	Path to PEM private key file
`--public-key-file <path>`	Path to PEM public key file

`koywe auth mfa verify`

Submit a signed stamp to verify MFA and receive an mfaToken

Endpoint: POST /organizations/{orgId}/webauthn/verify · context: org

Flag	Description
`--challenge <challenge>`	Challenge nonce from the challenge command
`--stamp-header-name <name>`	Stamp header name (e.g. X-Stamp-Api-Key)
`--stamp-header-value <value>`	Base64url-encoded stamp value
`--org-id <orgId>`	Organization ID

`koywe auth rotate-secret`

Rotate API secret for the current API user

Endpoint: POST /auth/credentials/rotate-secret

No options

Config & Profiles

`koywe config profile add`

Create a new profile

Flag	Description
`--env <env>`	Environment (sandbox\|production)
`--api-key <key>`	API key
`--secret <secret>`	API secret
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--copy-from <profile>`	Copy settings from an existing profile

`koywe config profile list`

List all profiles

No options

`koywe config profile remove`

Remove a profile (cannot remove the active profile)

No options

`koywe config profile use`

Switch to a named profile

No options

`koywe config reset`

Reset all configuration and cached tokens

No options

`koywe config set`

Set a configuration value in the active profile

No options

`koywe config show`

Display current configuration (active profile)

No options

Organizations

`koywe org balances`

Get organization balances

Endpoint: GET /organizations/{orgId}/balances · context: org

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-ids <ids>`	Comma-separated merchant IDs
`--date <date>`	Date (ISO 8601)
`--base-currency <currency>`	Base currency
`--period <period>`	Period
`--interval <interval>`	Interval
`--include-merchant-breakdown`	Include merchant breakdown
`--exclude-today`	Exclude today

`koywe org feature-flags`

Get organization feature flags

Endpoint: GET /organizations/{orgId}/feature-flags · context: org

Flag	Description
`--org-id <orgId>`	Organization ID

`koywe org list`

List all organizations

Endpoint: GET /organizations

No options

`koywe org select`

Set the active organization context

No options

Merchants

`koywe merchant create` 📐

Create a new merchant

Endpoint: POST /organizations/{orgId}/merchants · context: org

Flag	Description
`--org-id <orgId>`	Organization ID (overrides context)
`--data <json>`	Merchant JSON body
`--file <path>`	JSON file with merchant body
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

`koywe merchant delete`

Delete a merchant

Endpoint: DELETE /organizations/{orgId}/merchants/{merchantId} · context: org

Flag	Description
`--org-id <orgId>`	Organization ID (overrides context)

`koywe merchant features`

List features for the current merchant

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/features · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID (overrides context)
`--merchant-id <merchantId>`	Merchant ID (overrides context)

`koywe merchant info`

Get current merchant details

Endpoint: GET /organizations/{orgId}/merchants/{merchantId} · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID (overrides context)
`--merchant-id <merchantId>`	Merchant ID (overrides context)

`koywe merchant list`

List merchants in the current organization

Endpoint: GET /organizations/{orgId}/merchants · context: org

Flag	Description
`--org-id <orgId>`	Organization ID (overrides context)

`koywe merchant select`

Set the active merchant context

No options

`koywe merchant update` 📐

Update merchant details

Endpoint: PUT /organizations/{orgId}/merchants/{merchantId} · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID (overrides context)
`--merchant-id <merchantId>`	Merchant ID (overrides context)
`--data <json>`	JSON body
`--file <path>`	JSON file path
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

Orders

`koywe orders confirm`

Confirm an ON_HOLD order via MFA

Endpoint: POST /organizations/{orgId}/merchants/{merchantId}/orders/{orderId}/confirm · context: merchant · auth: mfa-optional

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--mfa-token <token>`	MFA token
`--pending-approval-id <id>`	Pending approval ID

`koywe orders create` 📐

Create a new order (PAYIN, PAYOUT, ONRAMP, OFFRAMP, BALANCE_TRANSFER, PAYMENT_LINK, INTER_MERCHANT_TRANSFER)

Endpoint: POST /organizations/{orgId}/merchants/{merchantId}/orders · context: merchant · auth: mfa-optional

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--data <json>`	Order JSON body
`--file <path>`	JSON file with order body
`--mfa-token <token>`	MFA token for policy-protected operations
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

`koywe orders get-by-external-id`

Get order by external (merchant-provided) ID

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/orders/external/{externalId} · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID

`koywe orders info`

Get order details by ID

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/orders/{orderId} · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID

`koywe orders list`

List orders for the current merchant

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/orders · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--status <status>`	Filter by status (PENDING\|PROCESSING\|COMPLETED\|FAILED\|CANCELLED)
`--type <type>`	Filter by type (PAYIN\|PAYOUT\|ONRAMP\|OFFRAMP\|BALANCE_TRANSFER\|PAYMENT_LINK\|INTER_MERCHANT_TRANSFER)
`--start-date <date>`	Filter from date (ISO 8601)
`--end-date <date>`	Filter to date (ISO 8601)
`--currency-id <id>`	Filter by currency ID
`--account-id <id>`	Filter by account ID (origin or destination)
`--origin-account-id <id>`	Filter by origin account ID
`--destination-account-id <id>`	Filter by destination account ID
`--page <n>`	Page number
`--page-size <n>`	Page size
`--limit <n>`	Alias for —page-size
`--sort <sort>`	Sort order (e.g. createdAt:desc)

`koywe orders notify`

Send a notification for an order

Endpoint: POST /organizations/{orgId}/merchants/{merchantId}/orders/{orderId}/notification · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--type <type>`	Notification type

`koywe orders sign confirm`

Submit a stamped signature for an order

Endpoint: POST /organizations/{orgId}/merchants/{merchantId}/orders/{orderId}/sign/confirm · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--stamped-body <body>`	Exact body from sign prepare
`--stamp-header-name <name>`	Stamp header name (e.g. X-Stamp-Api-Key)
`--stamp-header-value <value>`	Base64url-encoded stamp value
`--private-key-file <path>`	Auto-sign: path to PEM private key (replaces —stamp-* flags)
`--public-key-file <path>`	Auto-sign: path to PEM public key (replaces —stamp-* flags)

`koywe orders sign prepare`

Get the signing payload for an ON_HOLD order

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/orders/{orderId}/sign · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID

`koywe orders update` 📐

Update an order (e.g. associate a blockchain tx hash)

Endpoint: PATCH /organizations/{orgId}/merchants/{merchantId}/orders/{orderId} · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--tx-hash <hash>`	Blockchain transaction hash
`--data <json>`	Order update JSON body
`--file <path>`	JSON file with update body
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

Quotes

`koywe quotes create` 📐

Create a new quote

Endpoint: POST /organizations/{orgId}/merchants/{merchantId}/quotes · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--data <json>`	Quote JSON body
`--file <path>`	JSON file with quote body
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

`koywe quotes info`

Get quote details

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/quotes/{quoteId} · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID

Deals

`koywe deals confirm`

Confirm MFA for a pending deal approval

Endpoint: POST /organizations/{orgId}/merchants/{merchantId}/deals/{dealId}/confirm · context: merchant · auth: mfa-required

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--pending-approval-id <id>`	Pending approval ID
`--mfa-token <token>`	MFA token

`koywe deals create` 📐

Create a new deal

Endpoint: POST /organizations/{orgId}/merchants/{merchantId}/deals · context: merchant · auth: mfa-optional

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--data <json>`	Deal JSON body
`--file <path>`	JSON file with deal body
`--mfa-token <token>`	MFA token
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

`koywe deals info`

Get deal details by ID

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/deals/{dealId} · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID

`koywe deals list`

List deals for the current merchant

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/deals · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--page <n>`	Page number
`--page-size <n>`	Page size
`--limit <n>`	Alias for —page-size
`--status <status>`	Filter by status

`koywe deals transfer` 📐

Transfer a scheduled deal

Endpoint: POST /organizations/{orgId}/merchants/{merchantId}/deals/{dealId}/transfer · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--data <json>`	Transfer body JSON
`--file <path>`	JSON file with transfer body
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

Contacts

`koywe contacts accounts confirm-mfa`

Confirm MFA for a pending contact account approval

Endpoint: POST /organizations/{orgId}/merchants/{merchantId}/contacts/{contactId}/accounts/confirm-mfa · context: merchant · auth: mfa-required

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--pending-approval-id <id>`	Pending approval ID
`--mfa-token <token>`	MFA token

`koywe contacts accounts create` 📐

Create an account for a contact

Endpoint: POST /organizations/{orgId}/merchants/{merchantId}/contacts/{contactId}/accounts · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--data <json>`	Account JSON body
`--file <path>`	JSON file with account body
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

`koywe contacts accounts delete`

Delete an account for a contact

Endpoint: DELETE /organizations/{orgId}/merchants/{merchantId}/contacts/{contactId}/accounts/{accountId} · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID

`koywe contacts accounts info`

Get account details for a contact

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/contacts/{contactId}/accounts/{accountId} · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID

`koywe contacts accounts list`

List accounts for a contact

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/contacts/{contactId}/accounts · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID

`koywe contacts accounts update` 📐

Update an account for a contact

Endpoint: PUT /organizations/{orgId}/merchants/{merchantId}/contacts/{contactId}/accounts/{accountId} · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--data <json>`	Account JSON body
`--file <path>`	JSON file with account body
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

`koywe contacts create` 📐

Create a new contact

Endpoint: POST /organizations/{orgId}/merchants/{merchantId}/contacts · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--data <json>`	Contact JSON body
`--file <path>`	JSON file with contact body
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

`koywe contacts delete`

Delete a contact

Endpoint: DELETE /organizations/{orgId}/merchants/{merchantId}/contacts/{contactId} · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID

`koywe contacts documents delete` 📐

Delete documents for a contact

Endpoint: DELETE /organizations/{orgId}/merchants/{merchantId}/contacts/{contactId}/documents · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--data <json>`	Document IDs JSON body
`--file <path>`	JSON file with document IDs
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

`koywe contacts info`

Get contact details

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/contacts/{contactId} · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID

`koywe contacts list`

List contacts for the current merchant

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/contacts · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--search <query>`	Search by name or identifier
`--page <n>`	Page number
`--page-size <n>`	Page size
`--limit <n>`	Alias for —page-size

`koywe contacts update` 📐

Update an existing contact

Endpoint: PUT /organizations/{orgId}/merchants/{merchantId}/contacts/{contactId} · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--data <json>`	Contact JSON body
`--file <path>`	JSON file with contact body
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

Bank Accounts

`koywe bank-accounts balance`

Get balance for a specific account

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/accounts/{accountId}/balance · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--date <date>`	Date (ISO 8601)

`koywe bank-accounts balances`

Get balances for all accounts

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/accounts/balances · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--currency <currency>`	Filter by currency
`--date <date>`	Date (ISO 8601)

`koywe bank-accounts confirm-mfa`

Confirm MFA for a pending account approval

Endpoint: POST /organizations/{orgId}/merchants/{merchantId}/accounts/confirm-mfa · context: merchant · auth: mfa-required

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--pending-approval-id <id>`	Pending approval ID
`--mfa-token <token>`	MFA token

`koywe bank-accounts create` 📐

Create an external bank account

Endpoint: POST /organizations/{orgId}/merchants/{merchantId}/accounts · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--data <json>`	Bank account JSON body
`--file <path>`	JSON file
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

`koywe bank-accounts delete`

Delete a bank account

Endpoint: DELETE /organizations/{orgId}/merchants/{merchantId}/accounts/{accountId} · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID

`koywe bank-accounts deposit-info`

Get deposit account information (bank income)

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/bankIncome/accounts · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID

`koywe bank-accounts info`

Get bank account details

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/accounts/{accountId} · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID

`koywe bank-accounts list`

List external bank accounts

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/accounts · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID

`koywe bank-accounts search`

Search bank accounts

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/accounts/search · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--name <name>`	Filter by account name
`--entity <entity>`	Filter by entity
`--kind <kind>`	Filter by account kind
`--country-symbol <symbol>`	Filter by country symbol

`koywe bank-accounts update` 📐

Update a bank account

Endpoint: PUT /organizations/{orgId}/merchants/{merchantId}/accounts/{accountId} · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--data <json>`	Account JSON body
`--file <path>`	JSON file with account body
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

`koywe bank-accounts virtual create` 📐

Create a virtual bank account

Endpoint: POST /organizations/{orgId}/merchants/{merchantId}/virtual-accounts · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--data <json>`	Virtual account JSON body
`--file <path>`	JSON file
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

`koywe bank-accounts virtual list`

List virtual bank accounts

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/virtual-accounts · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID

`koywe bank-accounts virtual update-alias` 📐

Update virtual account alias

Endpoint: PATCH /organizations/{orgId}/merchants/{merchantId}/virtual-accounts/{accountId}/alias · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--data <json>`	Alias JSON body
`--file <path>`	JSON file
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

Policy (MFA & Approvals)

`koywe policy approvals approve`

Approve a pending approval (requires MFA)

Endpoint: POST /organizations/{orgId}/policy/approvals/{approvalId}/approve · context: org · auth: mfa-required

Flag	Description
`--org-id <orgId>`	Organization ID
`--mfa-token <token>`	MFA token
`--data <json>`	Approval JSON body
`--file <path>`	JSON file with approval body

`koywe policy approvals info`

Get approval details

Endpoint: GET /organizations/{orgId}/policy/approvals/{approvalId} · context: org

Flag	Description
`--org-id <orgId>`	Organization ID

`koywe policy approvals list`

List pending policy approvals

Endpoint: GET /organizations/{orgId}/policy/approvals · context: org

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Filter by merchant ID
`--scope <scope>`	Filter by role: mine (approvals awaiting my vote, default), requested (approvals I submitted), all (all org approvals)
`--operation-type <type>`	Filter by operation type (e.g. PAYOUT_FIAT, DESTINATION_EDIT)

`koywe policy approvals reject`

Reject a pending approval (requires MFA)

Endpoint: POST /organizations/{orgId}/policy/approvals/{approvalId}/reject · context: org · auth: mfa-required

Flag	Description
`--org-id <orgId>`	Organization ID
`--mfa-token <token>`	MFA token

`koywe policy audit`

View policy audit log

Endpoint: GET /organizations/{orgId}/policy/audit · context: org

Flag	Description
`--org-id <orgId>`	Organization ID

`koywe policy create` 📐

Create a new policy

Endpoint: POST /organizations/{orgId}/policy · context: org

Flag	Description
`--org-id <orgId>`	Organization ID
`--data <json>`	Policy JSON body
`--file <path>`	JSON file
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

`koywe policy delete`

Delete the current policy

Endpoint: DELETE /organizations/{orgId}/policy · context: org

Flag	Description
`--org-id <orgId>`	Organization ID

`koywe policy info`

Get current policy configuration

Endpoint: GET /organizations/{orgId}/policy · context: org

Flag	Description
`--org-id <orgId>`	Organization ID

`koywe policy rules create` 📐

Add a rule to the policy

Endpoint: POST /organizations/{orgId}/policy/rules · context: org

Flag	Description
`--org-id <orgId>`	Organization ID
`--data <json>`	Rule JSON body
`--file <path>`	JSON file
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

`koywe policy rules delete`

Delete a policy rule

Endpoint: DELETE /organizations/{orgId}/policy/rules/{ruleId} · context: org

Flag	Description
`--org-id <orgId>`	Organization ID

`koywe policy rules reorder` 📐

Reorder policy rules

Endpoint: PUT /organizations/{orgId}/policy/rules/reorder · context: org

Flag	Description
`--org-id <orgId>`	Organization ID
`--data <json>`	Reorder JSON body
`--file <path>`	JSON file
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

`koywe policy rules update` 📐

Update a policy rule

Endpoint: PUT /organizations/{orgId}/policy/rules/{ruleId} · context: org

Flag	Description
`--org-id <orgId>`	Organization ID
`--data <json>`	Rule JSON body
`--file <path>`	JSON file
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

Webhooks

`koywe webhooks create` 📐

Create a new webhook

Endpoint: POST /organizations/{orgId}/webhooks · context: org

Flag	Description
`--org-id <orgId>`	Organization ID
`--data <json>`	Webhook JSON body
`--file <path>`	JSON file with webhook body
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

`koywe webhooks delete`

Delete a webhook

Endpoint: DELETE /organizations/{orgId}/webhooks/{webhookId} · context: org

Flag	Description
`--org-id <orgId>`	Organization ID

`koywe webhooks event-types`

List available webhook event types, grouped by category

Endpoint: GET /organizations/{orgId}/webhook-event-types · context: org

Flag	Description
`--org-id <orgId>`	Organization ID

`koywe webhooks events deliveries`

Get deliveries for a webhook event

Endpoint: GET /organizations/{orgId}/webhook-events/{eventId}/deliveries · context: org

Flag	Description
`--org-id <orgId>`	Organization ID

`koywe webhooks events info`

Get webhook event details

Endpoint: GET /organizations/{orgId}/webhook-events/{eventId} · context: org

Flag	Description
`--org-id <orgId>`	Organization ID

`koywe webhooks events list`

List webhook events

Endpoint: GET /organizations/{orgId}/webhook-events · context: org

Flag	Description
`--org-id <orgId>`	Organization ID
`--page <n>`	Page number
`--limit <n>`	Page size
`--type <type>`	Filter by event type (e.g. order.created)
`--from <date>`	From date (ISO 8601, inclusive)
`--to <date>`	To date (ISO 8601, inclusive)
`--merchant-id <id>`	Filter by merchant ID
`--resource-type <type>`	Filter by resource type (e.g. order, contact)
`--resource-id <id>`	Filter by resource ID (e.g. ord_…, con_…)

`koywe webhooks events replay`

Replay a webhook event delivery

Endpoint: POST /organizations/{orgId}/webhook-events/{eventId}/replay · context: org

Flag	Description
`--org-id <orgId>`	Organization ID

`koywe webhooks info`

Get webhook details

Endpoint: GET /organizations/{orgId}/webhooks/{webhookId} · context: org

Flag	Description
`--org-id <orgId>`	Organization ID

`koywe webhooks list`

List webhooks for the current organization

Endpoint: GET /organizations/{orgId}/webhooks · context: org

Flag	Description
`--org-id <orgId>`	Organization ID

`koywe webhooks pause`

Pause a webhook

Endpoint: POST /organizations/{orgId}/webhooks/{webhookId}/pause · context: org

Flag	Description
`--org-id <orgId>`	Organization ID

`koywe webhooks ping`

Send a test ping to a webhook

Endpoint: POST /organizations/{orgId}/webhooks/{webhookId}/ping · context: org

Flag	Description
`--org-id <orgId>`	Organization ID

`koywe webhooks resume`

Resume a paused webhook

Endpoint: POST /organizations/{orgId}/webhooks/{webhookId}/resume · context: org

Flag	Description
`--org-id <orgId>`	Organization ID

`koywe webhooks rotate-secret`

Rotate webhook secret

Endpoint: POST /organizations/{orgId}/webhooks/{webhookId}/rotate-secret · context: org

Flag	Description
`--org-id <orgId>`	Organization ID

`koywe webhooks subscriptions update` 📐

Update the event types a webhook endpoint is subscribed to

Endpoint: PATCH /organizations/{orgId}/webhooks/{webhookId}/subscriptions · context: org

Flag	Description
`--org-id <orgId>`	Organization ID
`--events [events...]`	Event types to subscribe to (space-separated). Pass —events with no values to subscribe to all events.
`--data <json>`	Subscription JSON body
`--file <path>`	JSON file with subscription body
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

Reports

`koywe reports ledger`

Get ledger statement for an account

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/accounts/{accountId}/reports/ledger-statement · context: merchant

Flag	Description
`--account-id <id>`	(required) Account ID
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--from <date>`	Start date (ISO 8601)
`--to <date>`	End date (ISO 8601)
`--cursor <cursor>`	Pagination cursor from the previous response
`--limit <n>`	Page size limit

`koywe reports ledger-entry`

Get a specific ledger entry

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/accounts/{accountId}/reports/ledger-entry/{entryId} · context: merchant

Flag	Description
`--account-id <id>`	(required) Account ID
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID

`koywe reports orders`

Get orders report for an account

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/accounts/{accountId}/reports/orders · context: merchant

Flag	Description
`--account-id <id>`	(required) Account ID
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--from <date>`	Start date (ISO 8601)
`--to <date>`	End date (ISO 8601)

Users & Invitations

`koywe users invitations create`

Invite a user to the merchant

Endpoint: POST /users/organizations/{orgId}/merchants/{merchantId}/invitations · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--data <json>`	Invitation JSON body (email, roles)
`--file <path>`	JSON file with invitation body

`koywe users invitations list`

List invitations for the current merchant

Endpoint: GET /users/organizations/{orgId}/merchants/{merchantId}/invitations · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--page <n>`	Page number
`--page-size <n>`	Page size
`--limit <n>`	Alias for —page-size

`koywe users list`

List users for the current merchant

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/users · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--page <n>`	Page number
`--page-size <n>`	Page size
`--limit <n>`	Alias for —page-size

`koywe users me`

Get the authenticated user profile

Endpoint: GET /users/me

No options

`koywe users org-invitations create`

Invite a user at the organization level

Endpoint: POST /users/organizations/{orgId}/invitations · context: org

Flag	Description
`--org-id <orgId>`	Organization ID
`--data <json>`	Invitation JSON body (email, roles)
`--file <path>`	JSON file with invitation body

`koywe users org-invitations list`

List invitations at the organization level

Endpoint: GET /users/organizations/{orgId}/invitations · context: org

Flag	Description
`--org-id <orgId>`	Organization ID
`--page <n>`	Page number
`--page-size <n>`	Page size
`--limit <n>`	Alias for —page-size
`--sort <sort>`	Sort order

`koywe users org-list`

List users at the organization level

Endpoint: GET /organizations/{orgId}/users · context: org

Flag	Description
`--org-id <orgId>`	Organization ID
`--page <n>`	Page number
`--page-size <n>`	Page size
`--limit <n>`	Alias for —page-size

`koywe users org-update-roles`

Update roles for a user at the organization level

Endpoint: PUT /organizations/{orgId}/users · context: org

Flag	Description
`--org-id <orgId>`	Organization ID
`--user-id <userId>`	User ID
`--roles <roles...>`	Role names to assign

`koywe users update-roles`

Update roles for a user at the merchant level

Endpoint: PUT /organizations/{orgId}/merchants/{merchantId}/users · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--user-id <userId>`	User ID
`--roles <roles...>`	Role names to assign

Notifications

`koywe notifications send`

Send a notification for a merchant

Endpoint: POST /organizations/{orgId}/merchants/{merchantId}/notifications · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--data <json>`	Notification JSON body
`--file <path>`	JSON file

`koywe notifications send-personal`

Send a personal notification

Endpoint: POST /me/notifications

Flag	Description
`--data <json>`	Notification JSON body
`--file <path>`	JSON file

Pre-Onboarding

`koywe pre-onboarding drafts create` 📐

Create a new registration draft

Endpoint: POST /pre-onboarding/registration-draft

Flag	Description
`--data <json>`	Draft JSON body
`--file <path>`	JSON file with draft body
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

`koywe pre-onboarding drafts info`

Get a registration draft by ID

Endpoint: GET /pre-onboarding/registration-draft/{draftId}

No options

`koywe pre-onboarding drafts submit`

Submit a registration draft for review

Endpoint: POST /pre-onboarding/registration-form/{draftId}

No options

`koywe pre-onboarding drafts update` 📐

Update an existing registration draft (auto-merges with existing data)

Endpoint: PUT /pre-onboarding/registration-draft/{draftId}

Flag	Description
`--data <json>`	Draft JSON body
`--file <path>`	JSON file with draft body
`--replace`	Replace entire draft instead of merging with existing data
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

`koywe pre-onboarding registrations list`

List all registrations

Endpoint: GET /pre-onboarding/registrations

No options

`koywe pre-onboarding registrations status`

Get registration status

Endpoint: GET /pre-onboarding/registrations/{registrationId}/status

No options

Onboarding

`koywe onboarding kyb list`

List KYB processes for a merchant

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/onboarding/kyb · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID

`koywe onboarding kyb status`

Get KYB process status

Endpoint: GET /organizations/{orgId}/merchants/{merchantId}/onboarding/kyb/{kybId} · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID

`koywe onboarding kyb trigger` 📐

Trigger a KYB process for a merchant

Endpoint: POST /organizations/{orgId}/merchants/{merchantId}/onboarding/kyb · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID
`--force-retrigger`	Force re-trigger of KYB process
`--data <json>`	Request JSON body
`--file <path>`	JSON file with request body
`--schema`	Print expected JSON schema for the request body

Run with --schema to print the request-body JSON schema.

`koywe onboarding me`

Get your onboarding status

Endpoint: GET /onboarding/me

Flag	Description
`--evaluation-status <status>`	Filter by evaluation status
`--setup-status <status>`	Filter by setup status

Documents

`koywe documents list`

List available document types

Endpoint: GET /documents

Flag	Description
`--entity-type <type>`	Filter by entity type
`--country <country>`	Filter by country code
`--scope <scope>`	Filter by scope

Payment Methods

`koywe payment-methods list`

List available payment methods

Endpoint: GET /payment-method

Flag	Description
`--country-symbol <code>`	Filter by country code (e.g. CL, BR, MX)
`--currency-symbol <symbol>`	Filter by currency symbol (e.g. CLP, BRL, USDC)
`--payment-type <type>`	Filter by payment type (QR, PAYMENT_LINK, PUSH_NOTIFICATION, BANK_TRANSFER)

`koywe payment-methods verify-card`

Verify card payment method for a merchant

Endpoint: GET /payment-method/card/merchants/{merchantId}/verify · context: merchant

Flag	Description
`--org-id <orgId>`	Organization ID
`--merchant-id <merchantId>`	Merchant ID

Banks

`koywe banks list`

List available banks

Endpoint: GET /banks

Flag	Description
`--country <country>`	Filter by country

Countries

`koywe countries counties`

List counties for a state

Endpoint: GET /countries/{countrySymbol}/states/{stateId}/counties

No options

`koywe countries county-info`

Get county details

Endpoint: GET /countries/{countrySymbol}/states/{stateId}/counties/{countyId}

No options

`koywe countries economic-activities`

List economic activities for a country

Endpoint: GET /countries/{countrySymbol}/economic-activities

No options

`koywe countries economic-activities-all`

List all economic activities (global, not country-specific)

Endpoint: GET /economic-activities

No options

`koywe countries list`

List available countries

Endpoint: GET /countries

Flag	Description
`--operational-status <status>`	Filter by operational status
`--scope <scope>`	Filter by scope

`koywe countries state-info`

Get state details

Endpoint: GET /countries/{countrySymbol}/states/{stateId}

No options

`koywe countries states`

List states for a country

Endpoint: GET /countries/{countrySymbol}/states

No options

Currencies

`koywe currencies by-symbol`

Get currency by symbol

Endpoint: GET /currencies/symbol/{symbol}

No options

`koywe currencies info`

Get currency details by ID

Endpoint: GET /currencies/{id}

No options

`koywe currencies list`

List available currencies

Endpoint: GET /currencies

Flag	Description
`--is-fiat <boolean>`	Filter by fiat (true/false)
`--country <country>`	Filter by country
`--scope <scope>`	Filter by scope

Reference Data

`koywe reference company-roles`

List applicant company roles

Endpoint: GET /applicant-company-roles

No options

`koywe reference feature-flags`

List global feature flags

Endpoint: GET /global-feature-flags

No options

CLI Command Reference

Setup & Init

koywe init

koywe setup

Guided Flows

koywe flow deal

koywe flow order

Authentication

koywe auth browser-login

koywe auth credentials create

koywe auth credentials create-org

koywe auth credentials create-pos 📐

koywe auth login

koywe auth me

koywe auth mfa challenge

koywe auth mfa challenge-sign

koywe auth mfa keygen

koywe auth mfa prepare

koywe auth mfa sign

koywe auth mfa verify

koywe auth rotate-secret

Config & Profiles

koywe config profile add

koywe config profile list

koywe config profile remove

koywe config profile use

koywe config reset

koywe config set

koywe config show

Organizations

koywe org balances

koywe org feature-flags

koywe org list

koywe org select

Merchants

koywe merchant create 📐

koywe merchant delete

koywe merchant features

koywe merchant info

koywe merchant list

koywe merchant select

koywe merchant update 📐

Orders

koywe orders confirm

koywe orders create 📐

koywe orders get-by-external-id

koywe orders info

koywe orders list

koywe orders notify

koywe orders sign confirm

koywe orders sign prepare

koywe orders update 📐

Quotes

koywe quotes create 📐

koywe quotes info

Deals

koywe deals confirm

koywe deals create 📐

koywe deals info

koywe deals list

koywe deals transfer 📐

Contacts

koywe contacts accounts confirm-mfa

koywe contacts accounts create 📐

koywe contacts accounts delete

koywe contacts accounts info

koywe contacts accounts list

koywe contacts accounts update 📐

koywe contacts create 📐

koywe contacts delete

koywe contacts documents delete 📐

koywe contacts info

koywe contacts list

koywe contacts update 📐

Bank Accounts

koywe bank-accounts balance

koywe bank-accounts balances

koywe bank-accounts confirm-mfa

koywe bank-accounts create 📐

koywe bank-accounts delete

`koywe init`

`koywe setup`

`koywe flow deal`

`koywe flow order`

`koywe auth browser-login`

`koywe auth credentials create`

`koywe auth credentials create-org`

`koywe auth credentials create-pos` 📐

`koywe auth login`

`koywe auth me`

`koywe auth mfa challenge`

`koywe auth mfa challenge-sign`

`koywe auth mfa keygen`

`koywe auth mfa prepare`

`koywe auth mfa sign`

`koywe auth mfa verify`

`koywe auth rotate-secret`

`koywe config profile add`

`koywe config profile list`

`koywe config profile remove`

`koywe config profile use`

`koywe config reset`

`koywe config set`

`koywe config show`

`koywe org balances`

`koywe org feature-flags`

`koywe org list`

`koywe org select`

`koywe merchant create` 📐

`koywe merchant delete`

`koywe merchant features`

`koywe merchant info`

`koywe merchant list`

`koywe merchant select`

`koywe merchant update` 📐

`koywe orders confirm`

`koywe orders create` 📐

`koywe orders get-by-external-id`

`koywe orders info`

`koywe orders list`

`koywe orders notify`

`koywe orders sign confirm`

`koywe orders sign prepare`

`koywe orders update` 📐

`koywe quotes create` 📐

`koywe quotes info`

`koywe deals confirm`

`koywe deals create` 📐

`koywe deals info`

`koywe deals list`

`koywe deals transfer` 📐

`koywe contacts accounts confirm-mfa`

`koywe contacts accounts create` 📐

`koywe contacts accounts delete`

`koywe contacts accounts info`

`koywe contacts accounts list`

`koywe contacts accounts update` 📐

`koywe contacts create` 📐

`koywe contacts delete`

`koywe contacts documents delete` 📐

`koywe contacts info`

`koywe contacts list`

`koywe contacts update` 📐

`koywe bank-accounts balance`

`koywe bank-accounts balances`

`koywe bank-accounts confirm-mfa`

`koywe bank-accounts create` 📐

`koywe bank-accounts delete`

`koywe bank-accounts deposit-info`

`koywe bank-accounts info`

`koywe bank-accounts list`

`koywe bank-accounts search`

`koywe bank-accounts update` 📐

`koywe bank-accounts virtual create` 📐

`koywe bank-accounts virtual list`

`koywe bank-accounts virtual update-alias` 📐

`koywe policy approvals approve`

`koywe policy approvals info`

`koywe policy approvals list`

`koywe policy approvals reject`