@anypay/cli

anypay-cli

Anypay Enterprise Payments Platform CLI

• Usage
• Commands

Usage

$ npm install -g @anypay/cli
$ anypay-cli COMMAND
running command...
$ anypay-cli (--version)
@anypay/cli/0.3.5 darwin-arm64 node-v18.18.2
$ anypay-cli --help [COMMAND]
USAGE
  $ anypay-cli COMMAND
...

Commands

• anypay-cli help [COMMANDS]
• anypay-cli invoice create
• anypay-cli login
• anypay-cli logout
• anypay-cli request simple
• anypay-cli subscribe app
• anypay-cli subscribe invoice

anypay-cli help [COMMANDS]

Display help for anypay-cli.

USAGE
  $ anypay-cli help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for anypay-cli.

See code: @oclif/plugin-help

anypay-cli invoice create

Request Payment for a Specific Coin to a Single Address

USAGE
  $ anypay-cli invoice create -v <value> [-w <value>] [-r <value>] [-m <value>]

FLAGS
  -m, --memo=<value>          Memo to be displayed in supported wallets
  -r, --redirect_url=<value>  URL to redirect paying user in the web checkout
  -v, --value=<value>         (required) Amount to collect in terms of denomination
  -w, --webhook_url=<value>   URL to send invoice update webhook events

DESCRIPTION
  Request Payment for a Specific Coin to a Single Address

EXAMPLES
  $ anypay-cli request simple --chain MATIC --currency USDC --denomination=USD --amount=52.00 --address=0xA77547a3fB82a5Fa4DB408144870B69c70906989

See code: src/commands/invoice/create.ts

anypay-cli login

Authenticates with an anypay server and save your account access tokens

USAGE
  $ anypay-cli login [-e <value>] [-p <value>] [-a <value>]

FLAGS
  -a, --api=<value>       [default: https://api.anypayx.com] API Base URL
  -e, --email=<value>     Existing Anypay Account Email Address
  -p, --password=<value>  Anypay Account Password

DESCRIPTION
  Authenticates with an anypay server and save your account access tokens

EXAMPLES
  $ anypay-cli login --email=[e-mail]

See code: src/commands/login.ts

anypay-cli logout

Removes account access tokens from local config file

USAGE
  $ anypay-cli logout

DESCRIPTION
  Removes account access tokens from local config file

EXAMPLES
  $ anypay-cli logout

See code: src/commands/logout.ts

anypay-cli request simple

Request Payment for a Specific Coin to a Single Address

USAGE
  $ anypay-cli request simple -a <value> -c <value> -v <value> -t <value> [-d <value>] [-w <value>] [-r <value>] [-m
    <value>] [-u <value>] [-k <value>]

FLAGS
  -a, --asset=<value>         (required) BSV, DASH, USDC, etc
  -c, --chain=<value>         (required) BSV, MATIC, SOL, etc
  -d, --denomination=<value>  [default: USD] USD, EUR, JPY, CNY, etc
  -k, --apikey=<value>        Anypay API Key
  -m, --memo=<value>          Memo to be displayed in supported wallets
  -r, --redirect_url=<value>  URL to redirect paying user in the web checkout
  -t, --to=<value>            (required) Address or script to receive payment
  -u, --url=<value>           URL of Anypay API for Self-Hosting or Development
  -v, --value=<value>         (required) Amount to collect in terms of denomination
  -w, --webhook_url=<value>   URL to send invoice update webhook events

DESCRIPTION
  Request Payment for a Specific Coin to a Single Address

EXAMPLES
  $ anypay-cli request simple --chain MATIC --currency USDC --denomination=USD --amount=52.00 --address=0xA77547a3fB82a5Fa4DB408144870B69c70906989

See code: src/commands/request/simple.ts

anypay-cli subscribe app

Subscribe to Event Stream for a Specific Anypay App

USAGE
  $ anypay-cli subscribe app -t <value> [-w <value>]

FLAGS
  -t, --auth_token=<value>     (required) Auth token for your anypay app (such as wallet bot app, etc)
  -w, --websocket_url=<value>  [default: wss://wss.anypayx.com] URL of Anypay websocket server to connect

DESCRIPTION
  Subscribe to Event Stream for a Specific Anypay App

EXAMPLES
  $ anypay-cli subscribe app --auth_token=YOUR_AUTH_TOKEN | jq

See code: src/commands/subscribe/app.ts

anypay-cli subscribe invoice

Request Payment for a Specific Coin to a Single Address

USAGE
  $ anypay-cli subscribe invoice -v <value> [-w <value>] [-r <value>] [-m <value>]

FLAGS
  -m, --memo=<value>          Memo to be displayed in supported wallets
  -r, --redirect_url=<value>  URL to redirect paying user in the web checkout
  -v, --value=<value>         (required) Amount to collect in terms of denomination
  -w, --webhook_url=<value>   URL to send invoice update webhook events

DESCRIPTION
  Request Payment for a Specific Coin to a Single Address

EXAMPLES
  $ anypay-cli request simple --chain MATIC --currency USDC --denomination=USD --amount=52.00 --address=0xA77547a3fB82a5Fa4DB408144870B69c70906989

See code: src/commands/subscribe/invoice.ts