payjp-cli

payjp-cli はPAY.JPと連携するシステムの開発を支援するコマンドラインツールです。

現在は、ローカル開発環境において PAY.JP のテストモードのイベント Webhook を受信・確認するための機能を提供しています。

インストール方法

macOS で Homebrew を利用する方法

以下のコマンドを実行してインストールします。

brew install payjp/tap/payjp-cli

Windows で Scoop を利用する方法

以下のコマンドを実行してインストールします。

scoop bucket add payjp https://github.com/payjp/scoop-bucket.git

scoop install payjp-cli

その他の方法

以下の GitHub のリリースページから実行環境に応じたファイルをダウンロードしてください。

https://github.com/payjp/payjp-cli/releases

ログイン

payjp-cli を利用するには PAY.JP アカウントでの認証が必要です。 以下のコマンドを実行してログインを開始します。

payjp-cli login

実行するとペアリングコードと認証用の URL が表示されるので、表示された URL にアクセスし認証を行ってください。

Your pairing code is: ocean-fancy-smile-glow
To authenticate with PAY.JP, please access to: https://console.pay.jp/payjpcli/auth/confirm?token=payjpcli_auth_XXXXXXXXXXXXXXXXXXXXXXXXX
Waiting for confirmation...

ブラウザで PAY.JP アカウントでログインすると payjp-cli の認証画面が表示されるので、先ほどターミナルに表示されたペアリングコードと同じコードが表示されていることを確認した後に、認証するボタンを押してください。

Webhook の受信

以下のコマンドを実行すると、テストモードのイベント Webhook を受信し指定した URL に転送します。 --forward-to オプションにはそれぞれの環境における Webhook 受信用の URL を指定してください。

payjp-cli listen --forward-to http://localhost:3000/webhooks/payjp

--forward-to オプションを指定しなかった場合は、イベントの転送は行わず受信したイベントをターミナル上に表示します。

また --events オプションを利用して受信したいイベントの種類を指定することもできます。複数の種類のイベントを受信する場合はカンマ区切りで指定してください。

payjp-cli listen --events payment_flow.succeeded,setup_flow.succeeded

複数の PAY.JP アカウントの切り替え

--profile オプションを利用して複数のプロファイル名を使い分けることで、1つの端末上で複数の PAY.JP アカウントを切り替えて利用することができます。

ログイン時に --profile オプションを指定しプロファイル名を設定します。

payjp-cli login --profile your-profile-name

Webhook の受信時にも --profile オプションを指定することで該当のプロファイル名でログインした PAY.JP アカウントの Webhook を受信できます。

payjp-cli listen --profile your-profile-name --forward-to http://localhost:3000/webhooks/payjp