Skip to main content

octopus payment order capture

octopus payment order capture​

Capture a payment order (PSP callback)

Synopsis​

Notify Octopus of the PSP outcome for a confirmed payment order.

Pass --succeeded=false to simulate a PSP decline/failure.

octopus payment order capture <psp-reference-id> [flags]

Examples​

octopus payment order capture PSP-REF-001 --succeeded --tenant acme-bank
octopus pay order capture PSP-REF-001 --succeeded=false --reason "Insufficient funds" --tenant acme-bank
octopus pay order capture PSP-REF-001 --succeeded -o json --tenant acme-bank

Options​

  -h, --help            help for capture
      --reason string   Reason for the capture outcome (optional)
      --succeeded       Whether the PSP confirmed the payment (default: true) (default true)

Options inherited from parent commands​

  -c, --correlation string       Correlation ID for request tracing (UUID, auto-generated if omitted)
  -g, --global                   Shorthand for --tenant global
  -i, --idempotency-key string   Idempotency key for exactly-once execution (UUID, auto-generated per operation if omitted)
  -o, --output string            Output format: human, json (default "human")
  -p, --profile string           Override active config profile for this command.
  -t, --tenant string            Tenant code. Overrides default_tenant from config.
  -v, --verbose                  Enable verbose output

SEE ALSO​