payjp.js

payjp.jsはカード情報のトークン化のみに特化したライブラリです。

payjp.jsライブラリは、 https://js.pay.jp にホストされているので、このドメインを読み込んで使います:

<script type="text/javascript" src="https://js.pay.jp/">

setPublicKey(key)

認証のためのパブリックキーをセットします。

パラメータ名 説明
key 必須 あなたのパブリックキー

例:

Payjp.setPublicKey("pk_test_0383a1b8f91e8a6e3ea0e2a9");

getPublicKey()

セットされたパブリックキーを取得します。

例:

Payjp.getPublicKey();

createToken(card, calback)

PAY.JPのサーバーと通信し、カード情報の認証を行い、トークンを作成します。

パラメータ名 説明
card 必須 number exp_year exp_month` を 必須 としたカードパラメータ(詳細)
callback 必須 リクエストが終わった後に呼ばれるコールバック関数。第一引数にステータスコード、第二引数にエラーオブジェクトが入ります。

例:

var card = {
  number: document.querySelector('input[name="number"]').value,
  cvc: document.querySelector('input[name="cvc"]').value,
  exp_month: document.querySelector('select[name="exp_month"]').value,
  exp_year: document.querySelector('input[name="exp_year"]').value
};

Payjp.createToken(card, function(status, response) {
  if (status == 200) {
    // handle token object and send back to your server. You can get token id from "response.id".
  } else {
    // handle error like displaying error message.
  };
});

getToken(tokenId, calback)

PAY.JPのサーバーと通信し、トークン情報を取得します。

パラメータ名 説明
tokenId 必須 トークンID
callback 必須 リクエストが終わった後に呼ばれるコールバック関数。第一引数にステータスコード、第二引数にレスポンスオブジェクトが入ります。

例:

Payjp.getToken('tok_4c3a7a9200b86bd5351c40efb8c0', function(status, response) {
  if (status == 200) {
    // handle token object
  } else {
    // handle error like displaying error message.
  };
});

retrieveAvailability(callback)

PAY.JPのサーバーと通信し、利用可能なカードブランドを取得します。

パラメータ名 説明
callback 必須 リクエストが終わった後に呼ばれるコールバック関数。第一引数にステータスコード、第二引数にレスポンスオブジェクトが入ります。

例:

Payjp.retrieveAvailability(function(status, response) {
  if (status == 200) {
    // handle accepted card brand list
  } else {
    // handle error like displaying error message.
  };
});