payjpのカード登録や支払処理の定義に使うオブジェクトについて

Question

開発言語：rails

payjpを使って、クレジットカード登録や支払処理の機能の実装を行いました。
参考記事：https://qiita.com/takachan_coding/items/f7e70794b9ca03b559dd

コードの記述の部分で意味がわからない箇所があります。

[payjpjsの全体]

$(function(){

  var submit = document.getElementById("token_submit");
  console.log(submit)
  
  if ( submit != null) {
    submit.addEventListener('click', function(e){  // 追加するボタンが押されたらイベント発火
      e.preventDefault();  // ボタンを一旦無効化
      Payjp.setPublicKey("pk_test_***********************"); //パブリックキーを直書き
      var card = {  // 入力されたカード情報を取得
        number: document.getElementById("card_number").value,
        exp_month: document.getElementById("exp_month").value,
        exp_year: document.getElementById("exp_year").value,
        cvc: document.getElementById("cvc").value
      };
      if (card.number == "", card.exp_month == "1", card.exp_year == "2019", card.cvc == "") {
        alert("カード情報が入力されていません。"); // 送られた値がデフォルト値だった場合
      } else { // デフォルト値以外の値が送られてきた場合
        Payjp.createToken(card, function(status, response) {  // トークンを生成
          if (status === 200) {
            $("#card_number").removeAttr("name");
            $("#exp_month").removeAttr("name");
            $("#exp_year").removeAttr("name"); 
            $("#cvc").removeAttr("name");
            $("#card_token").append(
              $('<input type="hidden" name="payjp-token">').val(response.id)
            ); 
            document.inputForm.submit();  // 生成したトークンを送信する準備を整える
            alert("登録が完了しました");
          } else {
            alert("正しいカード情報を入力してください。");
          }
        });
      }
      false
    });
  }
});

       Payjp.createToken(card, function(status, response) {  // トークンを生成
          if (status === 200) {
            $("#card_number").removeAttr("name");
            $("#exp_month").removeAttr("name");
            $("#exp_year").removeAttr("name"); 
            $("#cvc").removeAttr("name");
            $("#card_token").append(
              $('<input type="hidden" name="payjp-token">').val(response.id)

responseがここでどういう働きをしているのかがわかりません。
response.idというのも出てきます。
またif (status === 200) {の部分はレスポンスステータスコードが200（成功）ならという意味だと思っているんですが、合ってますでしょか。

[makeの全体]

 def make #payjpとCardのデータベース作成を実施します。
    Payjp.api_key = ENV["PAYJP_SECRET_KEY"]
    if params['payjp-token'].blank?
       redirect_to action: "new"
    else
      customer = Payjp::Customer.create(
      description: '登録テスト', #なくてもOK
      card: params['payjp-token'],
      metadata: {user_id: current_user.id}
      ) #念の為metadataにuser_idを入れましたがなくてもOK
      @card = Card.new(user_id: current_user.id, customer_id: customer.id, card_id: customer.default_card)
      @card.save #保存
    end
  end

customer = Payjp::Customer.create(

payjpのcustomerオブジェクトが使用されているのはわかりますが、なぜこのような書き方になっているのかがわかりません。
payjpのオブジェクトについて

[showの全体]

def show #Cardのデータをpayjpに送り情報を取り出します
    @card = Card.where(user_id: current_user.id).first #テーブルからpayjpの顧客ID(アクセスキー)を検索
    if @card.blank?
      redirect_to action: "new" 
    else
      Payjp.api_key = ENV["PAYJP_SECRET_KEY"]
      customer = Payjp::Customer.retrieve(@card.customer_id) #保管した顧客ID（アクセスキー）でpayjpから情報取得
      @default_card_information = customer.cards.retrieve(@card.card_id) #保管したカードIDでpayjpからカード情報取得、カード情報表示のためインスタンス変数に代入
    end
  end

customer = Payjp::Customer.retrieve(@card.customer_id)

.retrieveというメソッド？は初めて見て調べてみましたが、それらしき記事が見つかりませんでした。
和訳すると「取り戻す」「検索する」という意味なので、DBにある@cardのcustomer_idを検索するという意味でしょうか？

どなたかご教授頂けますと幸いです。

Answer 1

質問が3点あると思うので、順番に回答します。

response.id

Pay.jpの公式ドキュメント にありますが、Payjp.createTokenメソッドは第一引数でわたされたカード情報を受け取って、コールバック関数の第２引数（今のコードだとresponseという変数）にトークン情報をを返します。

トークンについてはこちらのドキュメントにある通り、以下のようなオブジェクトです。

{
  "card": {
    "address_city": null,
    "address_line1": null,
    "address_line2": null,
    "address_state": null,
    "address_zip": null,
    "address_zip_check": "unchecked",
    "brand": "Visa",
    "country": null,
    "created": 1442290383,
    "customer": null,
    "cvc_check": "passed",
    "exp_month": 2,
    "exp_year": 2020,
    "fingerprint": "e1d8225886e3a7211127df751c86787f",
    "id": "car_e3ccd4e0959f45e7c75bacc4be90",
    "livemode": false,
    "metadata": {},
    "last4": "4242",
    "name": null,
    "object": "card"
  },
  "created": 1442290383,
  "id": "tok_5ca06b51685e001723a2c3b4aeb4",
  "livemode": false,
  "object": "token",
  "used": false
}

つまり、response.idというのは、このトークンオブジェクトのidを参照していることになります。

また、if (status === 200)の部分は。おっしゃるようにレスポンスステータスコードが200（成功）という理解でいいと思います。

Payjp::Customer.create

おそらく、RubyでPayjpのAPIを叩く際にこちらのGemを使っていると思うですが、それを前提に回答します。
https://github.com/payjp/payjp-ruby

Payjp::Customer.createというメソッドは、このGemに定義されています。
ドキュメントにもありますが、「メールアドレスやIDなどを指定して顧客を作成」するメソッドです。
このように書くことでPayJPに顧客データを作成しています。

.retrieveというメソッド

こちらも上記回答と同様に、PayJPに定義されている顧客情報を取得するメソッドです。
ドキュメントにありますが、引数に指定したidで顧客情報を取得してくれるようです。
つまり、以下のように書くと、PayJPのデータベースからカードの顧客IDで顧客を検索しているものだと思います。

Payjp::Customer.retrieve(@card.customer_id)

Comments

[ringo_000]

大変わかりやすかったです、勉強になりました！
公式ドキュメントに記載あったんですね、読み込みが甘かったです。
ありがとうございました。