Payments commands
Reference for the `revenexx payments` commands — every subcommand with a runnable example.
Auto-generated. This page is generated from the revenexx CLI by
tools/sync-cli-reference.mjs. Don't edit it by hand — your changes will be overwritten.
Every revenexx payments subcommand. The example shows the required arguments; the options table lists every flag the command accepts, with a ✓ marking required flags. Some flag names carry a -_ (e.g. --attribute-_values) — that is the exact token the CLI accepts, so copy them verbatim. Run revenexx payments <command> --help for the live options.
cancel
Bash
revenexx payments cancel \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — | |
--reason <reason> | The operator's own words, kept in metadata (cancel_reason / refund_reason) and passed to the provider. |
capture
Bash
revenexx payments capture \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
confirm
Bash
revenexx payments confirm \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
create
Bash
revenexx payments create \
--amount 9.99 \
--method-code sample method code
| Flag | Required | Description |
|---|---|---|
--amount <amount> | Order amount — 0 is legal (free orders), negative is not. | |
--method-code <method-code> | Code of a configured payment method. | |
--cart-id <cart-id> | The cart this payment pays for. | |
--contact-id <contact-id> | Paying customer contact. | |
--country <country> | Buyer ISO country code for the eligibility check. | |
--currency <currency> | ISO 4217 code (default EUR). | |
--idempotency-key <idempotency-key> | Same key answers the same payment instead of a duplicate. | |
--metadata <metadata> | Free-form metadata. | |
--order-ref <order-ref> | External order reference — also the webhook fallback key. | |
--return-url <return-url> | Where the PSP redirect flow returns the buyer to. |
dunning-scan
Bash
revenexx payments dunning-scan
errors-redact
Bash
revenexx payments errors-redact
| Flag | Required | Description |
|---|---|---|
--apply [value] | Write the reclassified values (default false = dry run). | |
--limit <limit> | How many payments to scan, oldest first (default 500, max 5000). |
get
Bash
revenexx payments get \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
list
Bash
revenexx payments list
| Flag | Required | Description |
|---|---|---|
--limit <limit> | Page size (default 50, max 200). | |
--offset <offset> | Row offset for pagination (default 0). | |
--order <order> | Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'. | |
--filter <column=value> | Filter rows by column equality (repeatable). |
logos-get
Bash
revenexx payments logos-get \
--slug sample slug
| Flag | Required | Description |
|---|---|---|
--slug <slug> | — |
methods-create
Bash
revenexx payments methods-create \
--code sample code \
--name Sample name
| Flag | Required | Description |
|---|---|---|
--code <code> | Stable method code (unique per tenant, e.g. 'invoice', 'card'). | |
--name <name> | Display name. | |
--countries [countries...] | Allowed ISO country codes — empty/omitted = unrestricted. | |
--description <description> | — | |
--enabled [value] | Disabled methods are never eligible (default false). | |
--fee-amount <fee-amount> | Fixed amount or percent value, per fee_type (default 0). | |
--fee-currency <fee-currency> | ISO 4217 code (default EUR). | |
--fee-type <fee-type> | How 'fee_amount' applies (default 'none'). | |
--kind <kind> | Self-managed (merchant fulfils, default) or PSP-backed ('provider' required to transact). | |
--labels <labels> | Localized display names ({ de, en, … }). | |
--max-order-value <max-order-value> | Maximum order amount — omitted = no upper bound. | |
--metadata <metadata> | Free-form metadata. | |
--min-order-value <min-order-value> | Minimum order amount — omitted = no lower bound. | |
--position <position> | Sort position in the checkout (default 0). | |
--provider <provider> | PSP code from the catalog — only for kind 'psp'. | |
--provider-method <provider-method> | The provider's payment method id (e.g. 'card', 'paypal'). |
methods-defaults
Bash
revenexx payments methods-defaults
methods-delete
Bash
revenexx payments methods-delete \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
methods-eligible
Bash
revenexx payments methods-eligible
| Flag | Required | Description |
|---|---|---|
--amount <amount> | Order amount the fees are computed against (default 0). | |
--country <country> | Buyer ISO country code — methods with country restrictions need it. | |
--currency <currency> | ISO 4217 code (default EUR). |
methods-get
Bash
revenexx payments methods-get \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
methods-list
Bash
revenexx payments methods-list
| Flag | Required | Description |
|---|---|---|
--limit <limit> | Page size (default 50, max 200). | |
--offset <offset> | Row offset for pagination (default 0). | |
--order <order> | Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'. | |
--filter <column=value> | Filter rows by column equality (repeatable). |
methods-update
Bash
revenexx payments methods-update \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — | |
--code <code> | Stable method code (unique per tenant, e.g. 'invoice', 'card'). | |
--countries [countries...] | Allowed ISO country codes — empty/omitted = unrestricted. | |
--description <description> | — | |
--enabled [value] | Disabled methods are never eligible (default false). | |
--fee-amount <fee-amount> | Fixed amount or percent value, per fee_type (default 0). | |
--fee-currency <fee-currency> | ISO 4217 code (default EUR). | |
--fee-type <fee-type> | How 'fee_amount' applies (default 'none'). | |
--kind <kind> | Self-managed (merchant fulfils, default) or PSP-backed ('provider' required to transact). | |
--labels <labels> | Localized display names ({ de, en, … }). | |
--max-order-value <max-order-value> | Maximum order amount — omitted = no upper bound. | |
--metadata <metadata> | Free-form metadata. | |
--min-order-value <min-order-value> | Minimum order amount — omitted = no lower bound. | |
--name <name> | Display name. | |
--position <position> | Sort position in the checkout (default 0). | |
--provider <provider> | PSP code from the catalog — only for kind 'psp'. | |
--provider-method <provider-method> | The provider's payment method id (e.g. 'card', 'paypal'). |
orders-capture
Bash
revenexx payments orders-capture \
--order-ref sample order ref
| Flag | Required | Description |
|---|---|---|
--order-ref <order-ref> | — |
providers-catalog
Bash
revenexx payments providers-catalog
providers-create
Bash
revenexx payments providers-create \
--provider sample provider
| Flag | Required | Description |
|---|---|---|
--provider <provider> | Provider code — must exist in the catalog (GET /payments/providers/catalog). | |
--credentials <credentials> | PSP credentials — the catalog's credential_fields say which keys the auth scheme expects. | |
--enabled [value] | Only enabled providers transact (default false). | |
--name <name> | Display name — defaults to the catalog label. | |
--options <options> | Free-form provider options. | |
--test-mode [value] | Sandbox/test credentials (default true). | |
--webhook-secret <webhook-secret> | Shared secret for PSP callback verification. |
providers-delete
Bash
revenexx payments providers-delete \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
providers-get
Bash
revenexx payments providers-get \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
providers-list
Bash
revenexx payments providers-list
| Flag | Required | Description |
|---|---|---|
--limit <limit> | Page size (default 50, max 200). | |
--offset <offset> | Row offset for pagination (default 0). | |
--order <order> | Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'. | |
--filter <column=value> | Filter rows by column equality (repeatable). |
providers-update
Bash
revenexx payments providers-update \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — | |
--credentials <credentials> | PSP credentials — the catalog's credential_fields say which keys the auth scheme expects. | |
--enabled [value] | Only enabled providers transact (default false). | |
--name <name> | Display name — defaults to the catalog label. | |
--options <options> | Free-form provider options. | |
--provider <provider> | Provider code — must exist in the catalog (GET /payments/providers/catalog). | |
--test-mode [value] | Sandbox/test credentials (default true). | |
--webhook-secret <webhook-secret> | Shared secret for PSP callback verification. |
refund
Bash
revenexx payments refund \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — | |
--reason <reason> | The operator's own words, kept in metadata (cancel_reason / refund_reason) and passed to the provider. |
vocabularies-get
Bash
revenexx payments vocabularies-get \
--name dunning-stages
| Flag | Required | Description |
|---|---|---|
--name <name> | Vocabulary name. |
vocabularies-list
Bash
revenexx payments vocabularies-list
| Flag | Required | Description |
|---|---|---|
--filter <column=value> | Filter rows by column equality (repeatable). |
webhooks-ingest
Bash
revenexx payments webhooks-ingest \
--provider sample provider \
--data '{ "key": "value" }'
| Flag | Required | Description |
|---|---|---|
--provider <provider> | — | |
--data <data> | Request body |