JavaScript SDK

elepay JavaScript SDK は elepay をウェブアプリに導入するための SDK です。
このガイドでは、elepay の JavaScript SDK をウェブアプリと連携する方法について詳しく説明します。

対応バージョン

  • elepay JavaScript SDK は、Safari, Chrome, Firefox 及び以降と互換性があります。
  • 開発環境:Safari, Chrome, Firefox 及び以降をご使用ください。

インストール方法

elepay JavaScript SDK は、https://js.elepay.io/v1/ にホストされおり、同ドメインを読み込んで使用します。

<script src="https://js.elepay.io/v1/elepay.js"></script>

moduleでelepay-js-sdkを利用する場合、npm package インストールしてください。

npm install --save elepay-js-sdk

実装

初期化

var elepay = new Elepay('YOUR_PUBLISHABLE_KEY');

npm packageでインストールした場合

import { loadElepay } from 'elepay-js-sdk';

const elepay = await loadElepay('YOUR_PUBLISHABLE_KEY');

Elepay(publishableKey, options?)

パラメータ

必須

説明

publishableKey

string

true

公開鍵

options

object

false

初期化オプション

options.locale

string

false
デフォルト: auto

ja:日本語
en:英語
zh-CN:簡体字中国語
zh-TW:繁体字中国語
auto:ブラウザのロケールに応じて自動設定

支払い処理

elepay Charge オブジェクトを取得した後、下記の js を呼び出して支払い処理を行います。

elepay.handleCharge(chargeObject).then(function(result) {
  // ① 正常処理
  if (result.type === 'cancel') {
    // 支払いキャンセル
  } else if (result.type === 'success') {
    // 支払い成功
  }
}).catch(function(err) {
    // ② エラー処理
});

下記の決済方法が ①正常処理関数 を呼び出さず、charge extra 情報中の frontUrl への遷移を行います。

  • LinePay
  • Alipay
  • UnionPay
  • PayPay

elepay.handleCharge(chargeObject)

パラメータ

必須

説明

chargeObject

object

true

elepayサーバーから作成したChargeオブジェクト