Payments: ledger commands

Reference for the `revenexx payments-ledger` 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-ledger subcommand, with a runnable example and the flags it accepts. Each flag is an API field: its type, allowed values and meaning are in the API reference. Some flag names carry a -_ (e.g. --attribute-_values) — that is the exact token the CLI accepts, so copy them verbatim. Run revenexx payments-ledger <command> --help for the live options.

payments-cancel

Bash

revenexx payments-ledger payments-cancel \
    --id ''

Flags: --id <id> --reason <reason>

payments-capture

Bash

revenexx payments-ledger payments-capture \
    --id ''

Flags: --id <id>

payments-confirm

Bash

revenexx payments-ledger payments-confirm \
    --id ''

Flags: --id <id>

payments-create

Bash

revenexx payments-ledger payments-create \
    --amount 49.9 \
    --method-code invoice

Flags: --amount <amount> --method-code <method-code> --cart-id <cart-id> --contact-id <contact-id> --country <country> --currency <currency> --external-id <external-id> --external-refs <external-refs> --idempotency-key <idempotency-key> --metadata <metadata> --order-id <order-id> --order-ref <order-ref> --return-url <return-url> --source-data <source-data> --source-synced-at <source-synced-at>

payments-dunning-scan

Bash

revenexx payments-ledger payments-dunning-scan

payments-errors-redact

Bash

revenexx payments-ledger payments-errors-redact

Flags: --apply [value] --limit <limit>

payments-get

Bash

revenexx payments-ledger payments-get \
    --id ''

Flags: --id <id>

payments-list

Bash

revenexx payments-ledger payments-list

Flags: --limit <limit> --offset <offset> --order <order> --cart-id <cart-id> --contact-id <contact-id> --order-id <order-id> --organization-id <organization-id> --status <status> --order-ref <order-ref> --method-code <method-code> --kind <kind> --provider <provider> --dunning-stage <dunning-stage> --idempotency-key <idempotency-key> --external-id <external-id> --reference <reference> --source-synced-at <source-synced-at> --filter <column=value>

payments-orders-capture

Bash

revenexx payments-ledger payments-orders-capture \
    --order-ref ORD-10042

Flags: --order-ref <order-ref>

payments-orders-relink

Bash

revenexx payments-ledger payments-orders-relink

Flags: --after <after> --apply [value] --limit <limit>

payments-refund

Bash

revenexx payments-ledger payments-refund \
    --id ''

Flags: --id <id> --reason <reason>

payments-vocabularies-get

Bash

revenexx payments-ledger payments-vocabularies-get \
    --name connection-states

Flags: --name <name>

payments-vocabularies-list

Bash

revenexx payments-ledger payments-vocabularies-list

Flags: --filter <column=value>

payments-webhooks-ingest

Bash

revenexx payments-ledger payments-webhooks-ingest \
    --provider stripe

Flags: --provider <provider> --id <id> --request <request> --verified <verified>

Was this page helpful?