メインコンテンツへスキップ
見出し画像

外部のRESTAPIを活用してみよう(PayPayのOpenPaymentAPIの使い方について)

    中山テックです。

    過去2回に分けてやってきた外部APIを使おうの巻。
    今回はPayPayを試してみたいと思います。

    APIキーを発行

    画像

    PayPay側のAPIを使うためにAPIキーとシークレットのトークンが必要です。

    アカウント作成

    画像

    質問①は1つ目
    質問②は動的ウェブペイメントで試してみようと思います
    念のため用語の説明も載せときます

    ウェブペイメント(Web Cashier)

    PCではブラウザに表示したQRコードの読み取り、またはブラウザ上でPayPayにログインして支払います。
    スマホではPayPayアプリが起動して支払います。

    動的ユーザースキャン(Dynamic QR)

    加盟店がQRコードを作成してユーザーに見せ、ユーザーがPayPayアプリで読み取って支払います。

    アプリコール(App Invoke)

    ディープリンク(アプリを直接開くリンク)でPayPayアプリを立ち上げ、決済します。

    ネイティブペイメント(Direct Debit)

    事前に連携したPayPayアカウントで支払います。ユーザーの認可取得が必要です。

    ただしこれをやらなくても、後述する「サンドボックスモード」で検証は可能です。

    開発者モードでPayPayログイン

    画像

    PayPayロゴの上を7回タップします。

    画像

    開発者モードでログインします。
    ログインアカウントは次項のサンドボックス(テスト)で試してみるのテストユーザについての画像を参照。

    サンドボックス(テスト)で試してみる

    サンドボックス(お試し)でやりましょう。
    ダッシュボードをテスト環境に変更します。

    画像

    環境変数設定(後述のプログラムの項を先に作ること)

    setx DB_PASSWORD "(DBのパスワード)"
    setx PAYPAY_API_KEY "(テストモードのAPIキー)"
    setx PAYPAY_API_SECRET "(テストモードのシークレット)"
    setx PAYPAY_MERCHANT_ID "(テストモードの加盟店ID)"

    API実行

    (Invoke-RestMethod -Method Post -Uri http://localhost:8080/api/payments -ContentType "application/json" -Body '{"amount":100}').data | Format-List

    結果

    amount              : @{amount=100; currency=JPY}
    authorizationExpiry :
    codeId              : 04-OATyAzqawfy1tLx6
    codeType            : ORDER_QR
    deeplink            : paypay://payment?link_key=https%3A%2F%2Fqr-stg.sandbox.paypay.ne.jp%[token]
    expiryDate          : 1794654451
    isAuthorization     : False
    merchantPaymentId   : [PaymentId]
    metadata            :
    orderDescription    : sample order
    orderItems          :
    redirectType        : WEB_LINK
    redirectUrl         : http://localhost:8080/
    requestedAt         : 1794654150
    storeId             :
    storeInfo           :
    terminalId          :
    url                 : https://qr-stg.sandbox.paypay.ne.jp/[token]
    userAgent           :

    このURLがQRコードのURLになります。

    では続いてPayPayをダウンロードし、テストユーザで決済してみましょう
    テストユーザは下記の通り表示されます。

    画像

    URLをブラウザに貼ります

    画像

    スマホのPayPayから「スキャンして支払う」よりQRコードを読み込んでください。

    画像

    OK無事できました

    取引履歴を見ると

    acceptedAt          : 1794657418
    amount              : @{amount=100; currency=JPY}
    amountDescription   :
    authorizedAt        :
    canceledAt          :
    captures            :
    expiresAt           :
    merchantPaymentId   : [加盟店支払いid]
    metadata            :
    orderDescription    : sample order
    orderItems          : {}
    orderReceiptNumber  :
    paymentId           : [支払いid]
    paymentMethodId     :
    paymentMethodType   :
    refunds             : @{data=System.Object[]}
    requestedAt         : 1794657418
    revert              :
    status              : COMPLETED
    storeId             :
    terminalId          :
    userAuthorizationId :
    画像

    無事決済されていました!

    フロント画面を作る

    画像

    決済を作るボタンを押します

    画像

    決済QRが出てくるので前項と同じようにスマホからスキャンし、支払います。

    画像

    キャンセルも可能です。

    決済を作るためのプログラム

    いつものごとくJavaで制御します。

    環境

    Java→21
    SpringBoot→4.1.2
    PayPayOPA→1.0.8

    controller

     
     
    Webアプリケーションエンジニア。 Java/Vue/Python/PostgreSQL/Node.jsなどで開発。 趣味でゲームやローカルサーバのツールも作成。 競馬場やラーメン屋めぐりも好きです。 月500円のメンバーシップ:Java・Vueの学習、サーバ構築。

    あなたへのおすすめ