univapay-node v4.0.91
univapay-node
Node.jsがUnivaPayAPI を使用するための SDK ライブラリです。
インストール
# npm (推奨)
npm install --save univapay-node
# yarn
yarn add univapay-node
利用方法
準備
ストアアプリケーショントークンがない場合は、まず以下の手順で作成してください。
店舗
> 店舗を選択 >開発
>アプリトークン
ページに移動追加
をクリック- ドメインとモードを追加する
- 作成されたトークンから JWT をコピーする
- シークレットを保存することを忘れないでください
SDK のセットアップ
import SDK from "univapay-node";
// Node.JSなど、fetchが提供されない環境では
// import "cross-fetch/polyfill"
// import "isomorphic-form-data"
// を使ってください
const apiEndpoint = "https://api.univapay.com";
const storeJwt = jwt; // `準備`を参照
const storeJwtSecret = secret; // `準備`を参照
const sdk = new SDK({
endpoint: apiEndpoint,
jwt: storeJwt,
secret: storeJwtSecret,
});
課金を作成する
import SDK, { PaymentType, TransactionTokenType, ResponseError } from "univapay-node";
const sdk = new SDK({ endpoint, jwt, secret });
// 課金用のトークンを作成
let transactionToken;
try {
const transactionToken = await sdk.transactionTokens.create({
type: TransactionTokenType.ONE_TIME, // 1回のみ利用可
paymentType: PaymentType.CARD,
// データの型は決済方法によって異なります
data: { cardholder, cardNumber, expMonth, expYear, cvv }
});
} catch (tokenCreateError: ResponseError) {
handleError(tokenCreateError);
}
// 課金を作成
try {
const charge = await sdk.charges.create({
amount: 1000;
currency: "JPY",
transactionTokenId: transactionToken.id,
});
} catch (chargeCreateError: ResponseError) {
// 未使用のトークンをクリーンアップして、次の課金のために別のトークンを再作成します
await sdk.transactionTokens.delete(transactionToken.id);
handleError(chargeCreateError);
}
ポーリング
課金を作成した後、ステータスはpending
に初期化されます。 API が完全に処理し終わると、successful
またはfailed
になります。課金がfailed
またはsuccessful
になったタイミングを知る必要がある場合は、課金をポーリングすることができます。
import SDK, {
PaymentType,
TransactionTokenType,
ResponseError,
} from "univapay-node";
const sdk = new SDK({ endpoint, jwt, secret });
const transactionToken = await sdk.transactionTokens.create(/* */);
const createdCharge = await sdk.charges.create(/* */); // Pending ステータス
const charge = await sdk.charges.poll(
createdCharge.storeId,
createdCharge.id,
null,
null,
null,
// ポーリングが停止してnullを返す条件
// 任意: (charge:ResponseCharge) => boolean
cancelCondition,
// ポーリングが成功する条件。デフォルトは、statusがpendingではないこと
// 任意: (charge: ResponseCharge) => boolean
successCondition,
);
認証が必要な課金の作成
デフォルトでは、課金を作成するとそのままキャプチャされます。そうではなく、認証する必要がある場合は、capture
プロパティを false
に設定し、任意のcaptureAt
プロパティを指定して特定の日付で自動的にキャプチャするようにすることができます。
const charge = await sdk.charges.create({
amount: 1000;
currency: "JPY",
transactionTokenId: transactionToken.id,
capture: false, // 課金を直接はキャプチャしない
captureAt: "2020-08-12", // 任意
});
API リファレンス
イベント
Charges
やStores
などの、PaymentsSDK
およびResource
ベースのクラスはEventEmitterです。次のイベントをサブスクライブできます。
const sdk = new SDK();
sdk.on('request', (req: Request) => void)
sdk.on('response', (res: Response) => void)
Request
とResponse
はfetch
APIの型です。
ブラウザでの利用方法
このモジュールは主にNode.js用に設計されていますが、WebpackやRollupなどのバンドラによってトランスパイルされたときに、ブラウザで使用することができます。
コントリビュート
univapay-node
の開発に寄与するには、このリポジトリをローカルで clone し、コードを別のブランチとして commit します。その際、コードの単体テストを記述し、プルリクエストを作成する前に Lint を実行してください。
npm run lint -- --fix
npm run format
npm test
ライセンス
univapay-node
は、MITライセンスの下で配布されています。
Copyright © 2019, UnivaPay Team
9 months ago
9 months ago
9 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
11 months ago
11 months ago
11 months ago
10 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
11 months ago
11 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago