取引オプション
NP API の特定パラメータに値を指定することにより、通常とは異なる取引の設定が可能です(別途契約が必要となります)。
このページでは、取引作成時に指定可能なオプション項目と、その利用シナリオを説明します。
| オプション名 | 値 | 内容 |
|---|---|---|
| 定期登録 | 1 |
定期購入のお客様の二回目以降の取引登録が API 経由で可能となるオプションです。 2 回目以降の取引登録については、取引更新 API を利用して登録を行います。 |
| アカウント連携 | 2 |
初回はユーザーの会員認証のみ(取引は未作成)。次回以降は保存したユーザートークンを用いて、取引更新・再作成 API で transaction_options: [2] を指定して取引登録します。 |
定期取引のフロー
定期登録オプションを使用した取引は、初回取引と次回以降取引の 2 つのフローに分かれます。
sequenceDiagram
autonumber
participant U as ユーザー
participant M as 加盟店(EC)
participant NP as NPシステム
alt 初回取引(定期登録)
M->>NP: 取引事前登録(取引オプション:1設定)
NP-->>M: url
M->>U: url へリダイレクトさせる
U->>NP: NP サービスユーザー認証/新規登録
NP-->>M: 認証Webhook(user_token含む)
U->>NP: 同意/購入確定
NP->>NP: 与信
NP-->>M: 決済Webhook(user_token含む)
else 次回以降取引(定期課金)
M->>NP: 取引更新API(user_token + 取引オプション:1)
NP-->>M: 取引更新結果
NP->>NP: 与信・課金処理
NP-->>M: 決済結果Webhook
end
利用例
- 定期購入のサービスで、初回取引後に継続課金を行う場合
実装のポイント
初回取引時
transaction_optionsフィールドに[1]を設定して 取引情報の事前登録 API を呼び出す。- 次回以降の取引で使用するため、 Webhook で受信した
user_tokenを取引に紐づけて保存する。
次回以降取引時
- 保存した
user_tokenとtransaction_options: [1]を transaction オブジェクト に設定する。 - 取引更新(登録)API を使用して、API 経由での新規取引登録を実施する。
アカウント連携
詳細については、チェックアウトフロー - B方式(ユーザートークンでの API 取引登録方式)を参照してください。
利用例
- EC サイトで NP サービスをユーザーの支払い手段として事前登録させたい場合
- 同種かつ少額の取引が頻繁に発生する場合
- 1 取引あたりのユーザー接点が限られるサービス設計の場合