description














システム接続サービス　V2.04
サービス導入マニュアル(REST方式)



Ver. 2.04 | Net Protections,INC.












Copyright（C）Net Protections,Inc. All Rights Reserved. description













改版履歴

　

版数 日付 改版内容
1.00 2018年1月12日 初版
1.01 2018年3月8日 インターフェース仕様箇所一部変更のため改版
1.02 2018年3月29日 インターフェース仕様箇所一部変更のため改版
1.03 2018年4月6日 インターフェース仕様箇所一部変更
購入企業審査結果取得　リクエスト
No2
［変更前］ 物理名　buyerAuthoriResultParameter
［変更後］ 物理名　buyerAuthorizationResultParameter
購入企業審査結果取得　チェック仕様
No2
［変更前］ 物理名　buyerAuthoriResultParameter
［変更後］ 物理名　buyerAuthorizationResultParameter
1.04 2018年5月28日 インターフェース仕様の誤植修正
購入企業登録結果　レスポンスフォーマット
項番18
［変更前］ "errorNo": "B6221",
［変更後］ "errorNo": "C21101",
項番19
［変更前］ "errorLevel": "B6221",
［変更後］ "errorLevel": "E",
項番29
［変更前］ "errorNo": "B6221",
［変更後］ "errorNo": "C20301",
項番30
［変更前］ "errorLevel": "B6221",
［変更後］ "errorLevel": "E",
購入企業審査結果取得　正常レスポンス
No3
［変更前］ タグ　単
［変更後］ タグ　複
No5
［変更前］ 型　半角英数　桁数　25以下
［変更後］ 型　半角数値　桁数　2
与信ステータス取得　　チェック仕様
No3
［変更前］ 条件チェック　下限が上限より過去の日付であること
［変更後］ 条件チェック　下限は上限と同日または過去の日付であること
1.05 2018年6月25日 取引登録・修正で商品単価・数量を入力しない場合のルールを追記
取引登録依頼　チェック仕様　★８
取引修正（全モデル共通）　チェック仕様　★８
1.06 2018年12月25日 インターフェース仕様の誤植を修正
購入企業審査結果取得　正常レスポンス
No4
［変更前］ 桁数 11以下
［変更後］ 桁数 25以下
No6
［変更前］ 型 全角　桁数 30以下
［変更後］ 型 半角数値　桁数 22以下
No7
［変更前］型 全角　桁数 30以下
［変更後］型 日付　桁数 8
No8
［変更前］ 型 全角　桁数 15以下
［変更後］ 型 日付　桁数 8
1.07 2018年12月26日 インターフェース仕様の誤植を修正
審査結果取得　正常レスポンス
［変更前］
設定内容 NG001：金額超過によるNG
　　　　 NG999：金額超過以外のNG
［変更後］ 設定内容 NG999
1.08 2019年7月4日 インターフェース仕様の誤植を修正
購入企業審査結果取得　正常レスポンス
No6から10の必須入力を削除
1.09 2019年12月11日 軽減税率対応に伴い取引登録依頼、取引修正依頼のリクエストに項目を追加
1.10 2020年8月1日 試験環境の稼働時間に関する記載を追加
導入試験
1.11 2020年8月27日 マイナス金額での取引登録が可能になったことに伴い、取引金額の桁数および入力可能範囲を変更
2.00 2020年10月22日 モデル名の変更に伴い、該当箇所の記載を変更
[変更前] → [変更後]
NP掛け払い基本モデル（請求依頼あり）→ 通販モデル
NP掛け払い月額課金モデル（請求依頼なし）→ 月額サービスモデル（事前審査なし）
NP掛け払い事前審査モデル（請求依頼あり）→ 営業販売モデル
NP掛け払い事前審査モデル（請求依頼なし）→ 月額サービスモデル
2.01 2022年7月13日 コンビニ払い設定の追加に伴い、下記リクエストに項目を追加
購入企業登録依頼
購入企業情報修正依頼
取引登録依頼
取引修正依頼
2.02 2022年11月30日 インボイス制度への対応に伴い取引登録・修正のIF項目を修正
2.03 2024年7月10日 購入企業IDの許容桁数が25桁から50桁となることに伴い、各種IFのリクエスト・レスポンスの桁数を変更
2.04 2024年9月30日 振込明細IF廃止に伴い、該当項目を削除













目次

　













システム接続サービス


本書は、株式会社ネットプロテクションズ（以降、ＮＰ）が提供するシステム接続サービスをご利用頂く企業様（以降、加盟店）を対象とした説明書です。 NPが提供する決済サービスの内容につきましては、サービスご案内資料をご参照ください。

システム接続サービス概要

システム接続サービスは、NP掛け払いを行う為のWebサービスを提供します。
NP掛け払いを行うためのインターフェースとして、取引情報の登録・更新・請求依頼などを行う為の
「データ送信用インターフェース」とNP決済システムが生成する結果情報を取得する為の「データ取得用インターフェース」を提供しています。


処理概要イメージ

データ送信

  1. NP決済システムへデータを送信します。

  2. 送信されたデータがストレージに格納されます。

  3. 受付番号を返却します。

    以下の異常が返却される場合があります。

    • 認証エラー
    • システムエラー

データ取得

  1. バッチ処理により処理結果データが作成されます。

  2. 結果データの取得を行います。

  3. 処理結果データの有無を確認します。

  4. 結果データが返却されます。

    以下の異常が返却される場合があります。

    • 認証エラー
    • データ取得エラー
    • データチェックエラー
    • システムエラー

サービス利用時の認証情報


端末ID

加盟店様のシステムを一意に識別する為のIDです。 システム接続サービスをご導入頂く加盟店様へNPより端末IDをお知らせしています。

SPコード

システム接続サービスが加盟店様を一意に識別する為のコードです。 システム接続サービスをご導入頂く加盟店様へNPよりSPコードをお知らせしています。













インターフェース詳細



インターフェース方式

インターフェース一覧


以下にシステム接続サービスの全IFを示します。

各記号の意味は以下のとおりです。

○…開発必須

×…開発不要

インターフェース スキーム
通販 営業販売 月額サービス
事前審査あり 事前審査なし
購入企業登録 購入企業登録依頼 × ○ ○ ×
購入企業登録結果
購入企業審査結果 購入企業審査結果取得 × ○ ○ ×
購入企業情報修正 購入企業情報修正依頼 × ○ ○ ×
購入企業情報修正結果
取引登録 取引登録依頼 ○ ○ ○ ○
取引登録結果
審査結果 審査結果取得 ○ ○ ○ ○
取引修正 取引修正依頼 ○ ○ ○ ○
取引修正結果
取引キャンセル 取引キャンセル依頼 ○ ○ ○ ○
取引キャンセル結果
請求依頼 請求依頼依頼 ○ ○ × ×
請求依頼結果
与信ステータス取得 与信ステータス取得 × ○ ○ ○
取引状態確認 取引状態確認依頼 △ △ △ △
取引状態確認結果
インターフェース PATH メソッド
購入企業登録 購入企業登録依頼 /buyers /registrations /requests POST
購入企業登録結果 /buyers /registrations /results POST
購入企業審査結果 購入企業審査結果取得 /buyers /authorizations /results POST
購入企業情報修正 購入企業情報修正依頼 /buyers /modifications /requests POST
購入企業情報修正結果 /buyers /modifications /results POST
取引登録 取引登録依頼 /transactions /registrations /requests POST
取引登録結果 /transactions /registrations /results POST
審査結果 審査結果取得 /transactions /authorizations /results POST
取引修正 取引修正依頼 /transactions /modifications /requests POST
取引修正結果 /transactions /modifications /results POST
取引キャンセル 取引キャンセル依頼 /transactions /cancel /requests POST
取引キャンセル結果 /transactions /cancel /results POST
請求依頼 請求依頼依頼 /billings /requests POST
請求依頼結果 /billings /results POST
与信ステータス取得 与信ステータス取得 /credit /status POST

処理フローと取引状態



NP掛け払い　通販モデル

NP掛け払いサービスの決済を行なう場合の処理フローと取引状態の遷移を以下に示します。


NP掛け払い　営業販売モデル

NP掛け払いサービスの決済を行なう場合の処理フローと取引状態の遷移を以下に示します。


NP掛け払い　月額サービスモデル

NP掛け払いサービスの決済を行なう場合の処理フローと取引状態の遷移を以下に示します。


NP掛け払い　月額サービスモデル（事前審査なし）

NP掛け払いサービスの決済を行なう場合の処理フローと取引状態の遷移を以下に示します。


インターフェース


購入企業登録（営業販売・月額サービス［事前審査あり］）

NP掛け払い決済の対象となる購入企業情報を登録するためのインターフェースです。
購入企業情報の登録依頼と購入企業登録結果を取得する２種類のインターフェースがあります。

購入企業登録依頼

　　　　　　　　　

購入企業登録結果

購入企業登録依頼を受付後、バッチ処理による購入企業登録処理を行い結果データを生成しておりますので、登録結果の取得が可能になるまでに最長で１時間かかります。



購入企業審査結果（営業販売・月額サービス［事前審査あり］）

購入企業審査の結果を取得するためのインターフェースです。
データ仕様、接続情報については別紙を用意しておりますのでそちらをご参照ください。

購入企業審査結果取得

購入企業情報修正（営業販売・月額サービス［事前審査あり］）

NP決済システムに登録されている購入企業情報を修正するためのインターフェースです。
購入企業情報の修正依頼と購入企業情報修正結果を取得する２種類のインターフェースがあります。
データ仕様、接続情報については別紙を用意しておりますのでそちらをご参照ください。

購入企業情報修正依頼

　　　　　　　　　

購入企業情報修正結果

購入企業情報修正依頼を受付後、バッチ処理による購入企業情報修正処理を行い結果データを生成しておりますので、修正結果の取得が可能になるまでに最長で１時間かかります。



取引登録（全モデル共通）

NP掛け払い決済の対象となる取引情報を登録するためのインターフェースです。
取引情報の登録依頼と取引登録結果を取得する２種類のインターフェースがあります。

取引登録依頼

　　　　　　　　　

取引登録結果

取引登録依頼を受付後、バッチ処理による取引登録処理を行い結果データを生成しておりますので、登録結果の取得が可能になるまでに最長で１時間かかります。
結果データが生成されていないタイミングで結果取得を実施した場合は、「ER0093：取得対象の結果データがありません。」が返却されますので、しばらく時間をおいてから再取得を行ってください。



審査結果（全モデル共通）


審査結果取得

審査結果には以下の種類があります。

ステータス 審査結果 説明
結果確定 OK サービスを利用可能です。出荷・サービス提供等を行ってください。
NG サービスを利用できません。
保留 情報の不備などがあります。サポートデスクからのメールを確認し、必要な対応を行ってください。
審査中 － 審査中の状態です。再度審査結果の取得を行ってください。

取引登録受付後、順次与信審査を実施し結果データを生成しておりますので審査結果の取得が可能になるまでに最長で１時間かかります。ただし、取引の内容により詳細審査が必要となった取引については、審査中の取引として結果が返却されます。
審査結果を取得するタイミングによっては、取引登録結果を取得していない取引に対する審査結果が取得される場合があります。



取引修正（全モデル共通）

NP決済システムに登録されている取引情報を修正するためのインターフェースです。
取引情報の修正依頼と取引修正結果を取得する２種類のインターフェースがあります。

取引修正依頼

取引修正結果

取引修正依頼を受付後、バッチ処理による取引修正処理を行い結果データを生成しておりますので、修正結果の取得が可能になるまでに最長で１時間かかります。
取引修正を行った場合、取引に対する審査結果が生成されますので審査結果を再取得してください。
請求依頼済みの取引は、請求依頼を取り消すことによって取引修正可能です。ただし、請求書がすでに発行されている場合、取引修正を行うことはできません。



取引キャンセル（全モデル共通）

NP決済システムに登録されている取引をキャンセルするためのインターフェースです。
取引のキャンセル依頼と取引キャンセル結果を取得する２種類のインターフェースがあります。

取引キャンセル依頼

取引キャンセル結果

取引キャンセル依頼を受付後、バッチ処理による取引キャンセル処理を行い結果データを生成しておりますので、キャンセル結果の取得が可能になるまでに最長で１時間かかります。



請求依頼（通販、営業販売）

出荷等を行い、売上が確定した取引について請求依頼を行うためのインターフェースです。
請求依頼情報の登録依頼と請求依頼結果を取得する２種類のインターフェースがあります。
※事前審査スキームは、請求依頼が必要な場合と不要な場合があります。

請求依頼依頼

請求依頼結果

請求依頼依頼を受付後、バッチ処理による請求依頼処理を行い結果データを生成しておりますので、請求依頼結果の取得が可能になるまでに最長で１時間かかります。



与信ステータス（営業販売・月額サービス）

与信ステータスを確認するためのインターフェースです。

与信ステータス取得

債権保証ステータスの更新を深夜に行っているため、依頼時間によって結果が返却されない可能性がございます。その際は、時間をおいて再度取得をお願いいたします。













データ仕様



送受信データ

加盟店様のシステムとNP決済システム間で送受信されるインターフェースデータはJSON形式です。
送受信されるデータには以下の２種類がございます。

送信データ

加盟店様のシステムよりNP決済システムへ送信して頂く情報です。

HTTPヘッダー情報

項目名 必須 設定値 説明
Host - ドメイン名はbss.netprotections.com となっております。 通信時に自動的に設定されます。
Content-Type ○ application/json コンテンツタイプが未設定の場合、または、"application/json"以外が設定されている場合はエラーとなります。
X-HTTP-Method-Override - POST HTTPメソッドを指定してPOSTリクエストを送信すると、指定したHTTPメソッドに対応するAPIが実行されます。 POSTリクエストのみ有効で、設定値の大文字・小文字の違いは無視されます。値が未設定の場合、または、不正な値が設定されていた場合は無視されます。
X-NP-Telegram-Id - #{電文IDの文字列} APIのインターフェース特定に利用します。 下記の表の通り設定してください。 記載のないインターフェースの場合設定不要となります。
X-NP-Terminal-Id ○ #{端末IDの文字列} APIの認証で利用します。
X-NP-Sp-Code ○ #{SPコードの文字列} APIの認証で利用します。
インターフェース 電文ID
購入企業登録 購入企業登録依頼 －
購入企業登録結果 －
購入企業審査結果 購入企業審査結果取得 －
購入企業情報修正 購入企業情報修正依頼 －
購入企業情報修正結果 －
取引登録 取引登録依頼 XU0010
取引登録結果 XD0010
審査結果 審査結果取得 XD1010
取引修正 取引修正依頼 XU0030
取引修正結果 XD0030
取引キャンセル 取引キャンセル依頼 XU0040
取引キャンセル結果 XD0040
請求依頼 請求依頼依頼 XU0020
請求依頼結果 XD0020
与信ステータス取得 与信ステータス取得 －

HTTPボディ情報

JSON形式で項目を設定します。
下記フォーマットの「単数リソース」は要素を一つしか受け付けられず、複数指定する事は出来ません。
「複数リソース」は要素を単数、複数どちらでも指定できます。


受信データ

NP決済システムより加盟店様のシステムへ送信する情報です。

HTTPヘッダー情報(一部)

項目名 設定値 説明
Status Code 200,400,404など HTTPのステータスコード

HTTPボディ情報

結果を”root”に含めて返却します。
IFのレスポンスによって単数、複数、及びエラーの有無が決定されます。

レスポンスに送信データのHTTPヘッダー情報のエラーを含む場合、エラー結果を”root”に含めて返却します。

HTTPステータスコード

システム接続サービスで返却されるHTTPステータスコードを以下に記載します。

ステータスコード 返却されるケース
200 OK 参照の成功
201 Created 登録、更新の成功
400 Bad Request ボディに含まれるJSON形式の不正、エラーコードのみの返却等
404 Not Found URL不正
405 Method Not Allowed URLのパスは一致しているが、HTTPメソッドが異なる場合
406 Not Acceptable等 RFCで定期されているヘッダー情報に不備がある場合
415 Unsupported Media Type ヘッダーのコンテンツが”application/json”以外の場合
500 Internal Server Error システム接続サービスのシステムエラー

文字コード

リクエスト情報の文字コードは、 UTF-8をご使用ください。
ShiftJIS等の文字コードをご利用の際には、UTF-8へのエンコーディングをお願い致します。

なお、NP決済システムで使用可能な文字は以下のものとなっております。


チェック仕様


インターフェースデータのデータチェックの仕様は以下の４種類に分類されます。 詳細については、インターフェース毎のチェック仕様をご参照ください。
データ型 使用可能文字
半角 半角文字のみ使用可能です。
半角数値 半角の数字のみ使用可能です。
半角英数 半角のアルファベットと数字のみ使用可能です。
日付 日付形式のみ使用可能です。 書式（YYYY/MM/DDなど）については、項目によって異なります。
全角 全角文字のみ使用可能です。
全角カナ 全角カタカナのみ使用可能です。

共通エラーレスポンス

エラーレスポンス

No 項目名 物理名 型 桁数 必須入力 タグ 設定内容
1 ルート root － － ○ 単
2 電文ID telegram_id 半角英数 6 ○ 単
3 受付番号 accept_no 半角英数 14 単 受付番号が設定されます。
4 エラー情報 error_info － － ○ 複
5 エラー番号 error_no 半角英数 6 ○ 単
6 エラー種別 error_level 半角 1 ○ 単
7 エラー内容 error_contents 全角 100以下 ○ 単

レスポンスフォーマット


購入企業登録（営業販売・月額サービス［事前審査あり］）


購入企業登録依頼

https://bss.netprotections.com/npcbr/api/v1/buyers/registrations/requests

リクエスト

No 項目名 物理名 説明 設定値（例）
1 ルート root データブロックを表します
2 購入企業登録依頼パラメータ buyerRegistrationParameter 詳細情報のデータブロックを表します
3 購入企業情報リスト buyerInfoLists 購入企業情報のリストです。
4 購入企業ID buyerId 購入企業IDです
5 購入企業名 companyName 購入企業の購入企業名です。
6 部署名 department 購入企業の部署名です。
7 担当者名 customerName 購入企業の担当者名です。
8 郵便番号 zip 購入企業の郵便番号です。 107-0052
9 住所 address 購入企業の住所です。
10 電話番号 tel 購入企業の電話番号です。 03-9999-9999
11 FAX番号 fax 購入企業のFAX番号です。
12 メールアドレス email 購入企業のメールアドレスです。 np@netprotections.co.jp
13 請求書送付方法 invoicePostingType 請求書送付方法です。 1
14 コンビニ払い設定 conveniencePaymentFlag コンビニ払い設定です。 1
15 上限審査希望フラグ authorizationFlag 上限審査の希望フラグです。 1

チェック仕様

No 項目名 物理名 型 桁数 必須入力 タグ 条件チェック
1 ルート root － － ○ 単
2 購入企業登録依頼パラメータ buyerRegistrationParameter － － ○ 単
3 購入企業情報リスト buyerInfoLists － － ○ 複
4 購入企業ID buyerId 半角英数 50以下 ○ 単 ★ 1
5 購入企業名 companyName 全角 30以下 ○ 単
6 部署名 department 全角 30以下 単
7 担当者名 customerName 全角 15以下 単
8 郵便番号 zip 半角 8以内 ○ 単 ★ 2 （ハイフンは省略可）
9 住所 address 全角 50以下 ○ 単 ★ 2
10 電話番号 tel 半角数値 13以下 ○ 単 （ハイフンは省略可）
11 FAX番号 fax 半角数値 15以下 単 （ハイフンは省略可）
12 メールアドレス email 半角英数 100以下 ○ 単 ★ 3 メールアドレス形式
13 請求書送付方法 invoicePostingType 半角数値 1 単 1：郵送 2：メール
14 コンビニ払い設定 conveniencePaymentFlag 半角数値 1 単 ★ 4
0：なし 1：あり
15 上限審査希望フラグ authorizationFlag 半角数値 1 単 ★ 5
0：希望しない 1：希望する

リクエストフォーマット

正常レスポンス

No 項目名 物理名 型 桁数 必須入力 タグ 設定内容
1 ルート root － － ○ 単
2 処理結果 buyerRegistrationResult － － 単
3 受付番号 acceptNo 半角英数 14 ○ 単 受付番号が設定されます。

レスポンスフォーマット


購入企業登録結果

https://bss.netprotections.com/npcbr/api/v1/buyers/registrations/results

リクエスト

No 項目名 物理名 説明 設定値（例）
1 ルート root データブロックを表します
2 購入企業登録結果取得パラメータ buyerRegistrationResultParameter 詳細情報のデータブロックを表します
3 受付番号 acceptNo 購入企業登録依頼時に初番した受付番号です 10000000000001

チェック仕様

No 項目名 物理名 型 桁数 必須入力 タグ 条件チェック
1 ルート root － － ○ 単
2 与信ステータス取得パラメータ buyerRegistrationResultParameter － － ○ 単
3 受付番号 acceptNo 半角英数 14 ○ 単 有効な受付番号であること

リクエストフォーマット

正常レスポンス

No 項目名 物理名 型 桁数 必須入力 タグ 設定内容
1 ルート root － － ○ 単
2 処理結果 buyerRegistrationResultResult － － 単
3 処理情報 processInfo － － 単
4 受付番号 acceptNo 半角英数 14 ○ 単
5 処理時間 processDate 半角数値 14 ○ 単 処理を開始した時間
6 購入企業登録結果 buyerRegistrationResult － － 単
7 購入企業登録OK結果リスト buyerRegistrationResultOkLists － － 複 購入企業登録OKの購入企業情報リスト
8 購入企業ID buyerId 半角英数 50以下 ○ 単 登録OKの購入企業ID
9 購入企業登録NG結果リスト buyerRegistrationResultNgLists － － 複 購入企業登録NGの購入企業情報リスト
10 購入企業ID buyerId 半角英数 50以下 ○ 単 登録NGの購入企業ID
11 エラーリスト errorLists － － 複 登録NGとなったエラー内容が設定されます。
12 エラー番号 errorNo 半角英数 6 ○ 単 エラー番号が設定されます。
13 エラー種別 errorLevel 半角 1 ○ 単 エラー種別が設定されます。
14 エラー内容 errorContents 全角 100以下 ○ 単 エラー内容が設定されます。
15 エラーリスト errorLists － － 複 結果取得に不備があった際に設定されます。
16 エラー番号 errorNo 半角英数 6 ○ 単 エラー番号が設定されます。
17 エラー種別 errorLevel 半角 1 ○ 単 エラー種別が設定されます。
18 エラー内容 errorContents 全角 100以下 ○ 単 エラー内容が設定されます。

レスポンスフォーマット


購入企業審査結果（営業販売・月額サービス［事前審査あり］）


購入企業審査結果取得

https://bss.netprotections.com/npcbr/api/v1/buyers/authorizations/results

リクエスト

No 項目名 物理名 説明 設定値（例）
1 ルート root データブロックを表します
2 購入企業審査結果取得パラメータ buyerAuthorizationResultParameter 詳細情報のデータブロックを表します
3 購入企業IDリスト buyerIdLists 結果取得を行う購入企業IDのリストです。 B6220

チェック仕様

No 項目名 物理名 型 桁数 必須入力 タグ 条件チェック
1 ルート root － － ○ 単
2 購入企業審査結果取得パラメータ buyerAuthorizationResultParameter － － ○ 単
3 購入企業IDリスト buyerIdLists 半角英数 50以下 ○ 複 有効な購入企業IDであること

リクエストフォーマット

正常レスポンス

No 項目名 物理名 型 桁数 必須入力 タグ 設定内容
1 ルート root － － ○ 単
2 処理結果 buyerAuthorizationResultResult － － ○ 単
3 購入企業審査結果リスト buyerAuthorizationResultLists － － 複 購入企業審査結果リスト
4 購入企業ID buyerId 半角英数 50以下 ○ 単 購入企業IDが設定されます
5 購入企業審査状況 buyerAuthoriStatus 半角英数 2 ○ 単 ★ １
6 与信上限金額 amountCap 半角数値 22以下 単 与信上限金額です。
7 与信枠適用開始日 creditFacilityTermBegin 日付 8 単 与信結果の適用開始日です
8 与信枠適用終了日 creditFacilityTermEnd 日付 8 単 与信結果の適用終了日です
9 結果確定日時 authoriRequiredDate 日付 8 単 NPにて審査結果が確定した日次
10 審査結果種別 resultType 半角数値 2 単 1：新規  2：更新
11 エラー結果リスト errorResultLists － － 単 エラー結果リスト
12 エラーリスト errorLists － － 複 結果取得に不備があった際に設定されます。
13 エラー番号 errorNo 半角英数 6 ○ 単 エラー番号が設定されます。
14 エラー種別 errorLevel 半角 1 ○ 単 エラー種別が設定されます。
15 エラー内容 errorContents 全角 100以下 ○ 単 エラー内容が設定されます。

レスポンスフォーマット


購入企業情報修正（営業販売・月額サービス［事前審査あり］）


購入企業情報修正依頼

https://bss.netprotections.com/npcbr/api/v1/buyers/modifications/requests

リクエスト

No 項目名 物理名 説明 設定値（例）
1 ルート root データブロックを表します
2 購入企業情報変更依頼パラメータ buyerModificationParameter 詳細情報のデータブロックを表します
3 購入企業情報リスト buyerInfoLists 購入企業情報のリストです。
4 購入企業ID buyerId 購入企業IDです
5 購入企業名 companyName 購入企業の購入企業名です。
6 部署名 department 購入企業の部署名です。
7 担当者名 customerName 購入企業の担当者名です。
8 郵便番号 zip 購入企業の郵便番号です。 107-0052
9 住所 address 購入企業の住所です。
10 電話番号 tel 購入企業の電話番号です。 03-9999-9999
11 FAX番号 fax 購入企業のFAX番号です。
12 メールアドレス email 購入企業のメールアドレスです。 np@netprotections.co.jp
13 請求書送付方法 invoicePostingType 請求書送付方法です。 1
14 コンビニ払い設定 conveniencePaymentFlag コンビニ払い設定です。 1
15 上限審査希望フラグ authorizationFlag 上限審査の希望フラグです。 1

チェック仕様

No 項目名 物理名 型 桁数 必須入力 タグ 条件チェック
1 ルート root － － ○ 単
2 購入企業情報修正依頼パラメータ buyerModificationParameter － － ○ 単
3 購入企業情報リスト buyerInfoLists － － ○ 複
4 購入企業ID buyerId 半角英数 50以下 ○ 単
5 購入企業名 companyName 全角 30以下 ○ 単 ★ １
6 部署名 department 全角 30以下 単
7 担当者名 customerName 全角 15以下 単
8 郵便番号 zip 半角 8以内 ○ 単 ★ 2（ハイフンは省略可）
9 住所 address 全角 50以下 ○ 単 ★ 2
10 電話番号 tel 半角数値 13以下 ○ 単 （ハイフンは省略可）
11 FAX番号 fax 半角数値 15以下 単 （ハイフンは省略可）
12 メールアドレス email 半角英数 100以下 ○ 単 ★ 3 メールアドレス形式
13 請求書送付方法 invoicePostingType 半角数値 1 単 1：郵送 2：メール
14 コンビニ払い設定 conveniencePaymentFlag 半角数値 1 単 ★ 4
0：なし 1：あり
15 上限審査希望フラグ authorizationFlag 半角数値 1 単 ★ 5
0：希望しない  1：希望する

リクエストフォーマット

正常レスポンス

No 項目名 物理名 型 桁数 必須入力 タグ 設定内容
1 ルート root － － ○ 単
2 処理結果 buyerModificationResult － － 単
3 受付番号 acceptNo 半角英数 14 ○ 単 受付番号が設定されます。

レスポンスフォーマット


購入企業情報修正結果

https://bss.netprotections.com/npcbr/api/v1/buyers/modifications/results

リクエストフォーマット

No 項目名 物理名 説明 設定値（例）
1 ルート root データブロックを表します
2 購入企業情報修正結果取得パラメータ buyerModificationResultParameter 詳細情報のデータブロックを表します
3 受付番号 acceptNo 購入企業情報修正依頼時に初番した受付番号です 10000000000001

チェック仕様

No 項目名 物理名 型 桁数 必須入力 タグ 条件チェック
1 ルート root － － ○ 単
2 購入企業情報修正結果取得パラメータ buyerModificationResultParameter － － ○ 単
3 受付番号 acceptNo 半角英数 14 ○ 単 有効な受付番号であること
チェック仕様

正常レスポンス

No 項目名 物理名 型 桁数 必須入力 タグ 設定内容
1 ルート root － － ○ 単
2 処理結果 buyerModificationResultResult － － 単
3 処理情報 processInfo － － 単
4 受付番号 acceptNo 半角英数 14 ○ 単
5 処理時間 processDate 半角数値 14 ○ 単 処理を開始した時間
6 購入企業情報修正結果 buyerModificationResult － － 単
7 購入企業情報修正OK結果リスト buyerModificationResultOkLists － － 複 購入企業情報修正OKの購入企業情報リスト
8 購入企業ID buyerId 半角英数 50以下 ○ 単 修正OKの購入企業ID
9 購入企業情報修正NG結果リスト buyerModificationResultNgLists － － 複 購入企業情報修正NGの購入企業情報リスト
10 購入企業ID buyerId 半角英数 50以下 ○ 単 修正NGの購入企業ID
11 エラーリスト errorLists － － 複 修正NGとなったエラー内容が設定されます。
12 エラー番号 errorNo 半角英数 6 ○ 単 エラー番号が設定されます。
13 エラー種別 errorLevel 半角 1 ○ 単 エラー種別が設定されます。
14 エラー内容 errorContents 全角 100以下 ○ 単 エラー内容が設定されます。
15 エラーリスト errorLists － － 複 結果取得に不備があった際に設定されます。
16 エラー番号 errorNo 半角英数 6 ○ 単 エラー番号が設定されます。
17 エラー種別 errorLevel 半角 1 ○ 単 エラー種別が設定されます。
18 エラー内容 errorContents 全角 100以下 ○ 単 エラー内容が設定されます。

レスポンスフォーマット


取引登録（全モデル共通）


取引登録依頼

https://bss.netprotections.com/npcbr/api/v1/transactions/registrations/requests

リクエスト

No 項目名 物理名 説明 設定値（例）
1 ルート root データブロックを表します。
2 電文ID telegram_id 電文IDです。 XU0010
3 取引情報 transaction_details 詳細情報のデータブロックを表します。
4 加盟店取引ID shop_transaction_id 加盟店取引IDです。
5 注文日 order_date 注文が行われた日付です。 2010/01/31
6 購入企業情報 customer_information 購入企業情報のデータブロックを表します。
7 購入企業ID buyer_id 購入企業IDです。
8 企業名 company_name 購入企業の企業名です。
9 部署名 department 購入企業の部署名です。
10 担当者名 customer_name 購入企業の担当者名です。
11 郵便番号 zip 購入企業の郵便番号です。 107-0052
12 住所 address 購入企業の住所です。
13 電話番号 tel 購入企業の電話番号です。 03-9999-9999
14 メールアドレス email 購入企業のメールアドレスです。 np@netprotections.co.jp
15 配送先情報 dest_information 配送先のデータブロックを表します。
16 企業名 dest_company_name 配送先の企業名です。
17 部署名 dest_department 配送先の部署名です。
18 担当者名 dest_customer_name 配送先の担当者名です。
19 担当者名（カナ） dest_customer_name_kana 配送先の担当者名(カナ)です。
20 郵便番号 dest_zip 配送先の郵便番号です。
21 住所 dest_address 配送先の住所です。
22 電話番号 dest_tel 配送先の電話番号です。
23 決済方法 settlement_type 決済方法です。 02
24 請求書送付方法 billed_type 請求書送付方法です。 1
25 コンビニ払い設定 convenience_payment_flag コンビニ払い設定です。 1
26 取引金額 billed_amount 取引金額です。
27 税率別合計金額明細 tax_rate_summaries 税率別合計金額明細のデータブロックを表します。
28 税率別合計金額情報 summary_information 税率別合計金額情報のデータブロックを表します。
29 税率 tax_rate 税率別合計金額の税率です。 8
30 合計金額 total_amount 税率別合計金額の合計金額です。
31 商品明細 goods_details 商品明細のデータブロックです。
32 商品情報 goods_information 商品情報のデータブロックです。 （複数可能） ★ １
33 明細 goods_name 請求書の明細欄に記載される内容です。
34 元加盟店取引受注日 original_transaction_date 返還取引の元加盟店取引受注日です。 2022/10/31
35 商品単価 goods_price 商品の単価です。
36 数量 quantity 商品の数量です。
37 請求書税区分 billed_tax_kind 明細の税区分です。

チェック仕様

No 項目名 物理名 型 桁数 必須入力 タグ 条件チェック/（備考）
1 ルート root － － ○ 単
2 電文ID telegram_id 半角数値 6 ○ 単 XU0010
3 取引情報 transaction_details － － ○ 複
4 加盟店取引ID shop_transaction_id 半角英数 40以内 ○ 単 ★ １
5 注文日 order_date 半角 10 ○ 単 ★ ２
YYYY/MM/DD形式
6 購入企業情報 customer_information － － ○ 単
7 購入企業ID buyer_id 半角 50以内 ○ 単 ★ 3
8 企業名 company_name 全角 30以内 ○ 単
9 部署名 department 全角 30以内 単
10 担当者名 customer_name 全角 15以内 単
11 郵便番号 zip 半角 8以内 ○ 単 ★ ４ （ハイフンは省略可）
12 住所 address 全角 50以内 ○ 単 ★ ４
13 電話番号 tel 半角 13以内 ○ 単 （ハイフンは省略可）
14 メールアドレス email 半角 100以内 ○ 単 ★５
メールアドレス形式
15 配送先情報 dest_information － － 単
16 企業名 dest_company_name 全角 30以内 単 ★ 6
17 部署名 dest_department 全角 30以内 単
18 担当者名 dest_customer_name 全角 15以内 単
19 担当者名（カナ） dest_customer_name_kana 全角カナ 25以内 単
20 郵便番号 dest_zip 半角 8以内 単 ★ ４ ★ 6
21 住所 dest_address 全角 50以内 単 ★ ４ ★ 6
22 電話番号 dest_tel 半角数値 13以内 単 ★ 6
23 決済方法 settlement_type 半角数値 2以内 ○ 単 02
24 請求書送付方法 billed_type 半角数値 1 ○ 単 1：郵送 2：メール
25 コンビニ払い設定 convenience_payment_flag 半角数値 1 単 0：なし 1：あり
★ 7
26 取引金額 billed_amount 半角数値 8以内 ○ 単 -9999999 ～ 99999999
★ 8
27 税率別合計金額明細 tax_rate_summaries － － 単 ★ 12
28 税率別合計金額情報 summary_information － － 複 ★ 9
29 税率 tax_rate 半角数値 2以内 ○ 単
30 合計金額 total_amount 半角数値 13以内 ○ 単
31 商品明細 goods_details － － ○ 単
32 商品情報 goods_information － － ○ 複
33 明細 goods_name 全角 150以内 ○ 単
34 元加盟店取引受注日 original_transaction_date 半角 10 単 YYYY/MM/DD形式
★ 14
35 商品単価 goods_price 半角数値 13以内 ★ 10 単 -99999999.999 ～99999999.999
36 数量 quantity 半角数値 13以内 ★ 10 単 -99999999.999 ～99999999.999
37 請求書税区分 billed_tax_kind 半角英数 3 単 N00:集計対象外,
T08:税込8%,
T10:税込10%,
B08:税別8%,
B10:税別10%,
R08:税込8%（返還）,
R10:税込10%（返還）,
H08:税別8%（返還）,
H10:税別10%（返還）,
E00:非課税,
U00:不課税
★ 11 ★ 13

リクエストフォーマット

正常レスポンス

No 項目名 物理名 型 桁数 必須入力 タグ 設定内容
1 ルート root － － ○ 単
2 電文ID telegram_id 半角英数 6 ○ 単 XU0010
3 受付番号 accept_no 半角英数 14 ○ 単 受付番号が設定されます。

レスポンスフォーマット


取引登録結果

https://bss.netprotections.com/npcbr/api/v1/transactions/registrations/results

リクエスト

No 項目名 物理名 説明 設定値（例）
1 ルート root データブロックを表します。
2 電文ID telegram_id 電文IDです。 XD0010
3 受付番号 accept_no 取引登録依頼時の受付番号です。

チェック仕様

No 項目名 物理名 型 桁数 必須入力 タグ 条件チェック／（備考）
1 ルート root － － ○ 単
2 電文ID telegram_id 半角英数 6 ○ 単 XD0010であること
3 受付番号 accept_no 半角英数 1４ ○ 単 有効な受付番号であること

リクエストフォーマット

正常レスポンス

No 項目名 物理名 型 桁数 必須入力 タグ 設定内容
1 ルート root － － ○ 単
2 電文ID telegram_id 半角英数 6 ○ 単
3 受付番号 accept_no 半角英数 14 ○ 単
4 処理時間 process_date 半角 19 ○ 単 処理を開始した時間 2011/01/01 12:00:00
5 取引登録結果 transaction_regist_details － － ○ 単
6 登録OK結果 regist_OK_result － － 複 取引登録OKの取引情報
7 NP取引ID np_transaction_id 半角数値 11 単 登録時に付与されたNP取引ID
8 加盟店取引ID shop_transaction_id 半角英数 40以下 単 登録OKの加盟店取引ID
9 登録NG結果 regist_NG_result － － 複 取引登録NGの取引情報
10 NP取引ID np_transaction_id 半角数値 11 単 設定されません。
11 加盟店取引ID shop_transaction_id 半角英数 40以下 単 登録NGの加盟店取引ID
12 エラーリスト error_list － － 複 登録NGのエラー内容リスト
13 エラー番号 error_no 半角英数 6 単 エラー番号が設定されます。
14 エラー種別 error_level 半角 1 単 エラー種別が設定されます。
15 エラー内容 error_contents 全角 100以下 単 エラー内容が設定されます。

レスポンスフォーマット


審査結果（全モデル共通）


審査結果取得

https://bss.netprotections.com/npcbr/api/v1/transactions/authorizations/results

リクエスト

リクエストフォーマット

正常レスポンス

No 項目名 物理名 型 桁数 必須入力 タグ 設定内容
1 ルート root － － ○ 単
2 電文ID telegram_id 半角英数 6 ○ 単
3 処理時間 process_date 半角 19 ○ 単 リクエストを受け付けて処理を行った時間 2011/01/01 12:00:00
4 審査結果 authori_result_details － － ○ 単
5 結果確定 authori_decision － － 複 審査結果が確定した取引情報
6 NP取引ID np_transaction_id 半角数値 11 単 結果確定した取引のNP取引ID
7 加盟店取引ID shop_transaction_id 半角英数 40以下 単 結果確定した取引の加盟店取引ID
8 受付番号 transaction_accept_no 半角英数 14 単 取引登録依頼時の受付番号
9 審査結果 authori_result 半角数値 1 単 1：OK 2：保留 3：NG
10 結果確定日時 authori_required_date 半角英数 19 単 YYYY/MM/DD HH:MM;SS形式
11 審査NG理由 authori_ng_reason 半角英数 5 単 NG999
12 審査中 authori_examination － － 複 審査中の取引情報
13 NP取引ID np_transaction_id 半角数値 11 単 審査中の取引のNP取引ID
14 加盟店取引ID shop_transaction_id 半角英数 40以下 単 審査中の取引の加盟店取引ID
15 受付番号 transaction_accept_no 半角英数 14 単 取引登録依頼時の受付番号

レスポンスフォーマット


取引修正（全モデル共通）


取引修正依頼

https://bss.netprotections.com/npcbr/api/v1/transactions/modifications/requests

リクエスト

No 項目名 物理名 説明 設定値（例）
1 ルート root データブロックを表します。
2 電文ID telegram_id 電文IDです。 XU0010
3 取引情報 transaction_details 詳細情報のデータブロックを表します。
4 NP取引ID np_transaction_id NP取引IDです。
5 加盟店取引ID shop_transaction_id 加盟店取引IDです。
6 注文日 order_date 注文が行われた日付です。 2010/01/31
7 購入企業情報 customer_information 購入企業情報のデータブロックを表します。
8 購入企業ID buyer_id 購入企業IDです。
9 企業名 company_name 購入企業の企業名です。
10 部署名 department 購入企業の部署名です。
11 担当者名 customer_name 購入企業の担当者名です。
12 郵便番号 zip 購入企業の郵便番号です。 107-0052
13 住所 address 購入企業の住所です。
14 電話番号 tel 購入企業の電話番号です。 03-9999-9999
15 メールアドレス email 購入企業のメールアドレスです。 np@netprotections.co.jp
16 配送先情報 dest_information 配送先のデータブロックを表します。
17 企業名 dest_company_name 配送先の企業名です。
18 部署名 dest_department 配送先の部署名です。
19 担当者名 dest_customer_name 配送先の担当者名です。
20 担当者名（カナ） dest_customer_name_kana 配送先の担当者名(カナ)です。
21 郵便番号 dest_zip 配送先の郵便番号です。
22 住所 dest_address 配送先の住所です。
23 電話番号 dest_tel 配送先の電話番号です。
24 決済方法 settlement_type 決済方法です。 02
25 請求書送付方法 billed_type 請求書送付方法です。 1
26 コンビニ払い設定 convenience_payment_flag コンビニ払い設定です。 1
27 取引金額 billed_amount 取引金額です。
28 税率別合計金額明細 tax_rate_summaries 税率別合計金額明細のデータブロックを表します。
29 税率別合計金額情報 summary_information 税率別合計金額情報のデータブロックを表します。
30 税率 tax_rate 税率別合計金額の税率です。 8
31 合計金額 total_amount 税率別合計金額の合計金額です。
32 商品明細 goods_details 商品明細のデータブロックです。
33 商品情報 goods_information 商品情報のデータブロックです。 （複数可能） ★ １
34 明細 goods_name 請求書の明細欄に記載される内容です。
35 元加盟店取引受注日 original_transaction_date 返還取引の元加盟店取引受注日です。 2022/10/31
36 商品単価 goods_price 商品の単価です。
37 数量 quantity 商品の数量です。
38 請求書税区分 billed_tax_kind 明細の税区分です。

チェック仕様

No 項目名 物理名 型 桁数 必須入力 タグ 条件チェック/（備考）
1 ルート root － － ○ 単
2 電文ID telegram_id 半角数値 6 ○ 単 XU0010
3 取引情報 transaction_details － － ○ 複
4 NP取引ID np_transaction_id 半角数値 11 ○ 単 有効なNP取引IDの取引であること
5 加盟店取引ID shop_transaction_id 半角英数 40以内 ○ 単 ★ １
6 注文日 order_date 半角 10 ○ 単 ★ ２
YYYY/MM/DD形式
7 購入企業情報 customer_information － － ○ 単
8 購入企業ID buyer_id 半角 50以内 ○ 単 ★ 3
9 企業名 company_name 全角 30以内 ○ 単
10 部署名 department 全角 30以内 単
11 担当者名 customer_name 全角 15以内 単
12 郵便番号 zip 半角 8以内 ○ 単 ★ ４ （ハイフンは省略可）
13 住所 address 全角 50以内 ○ 単 ★ ４
14 電話番号 tel 半角 13以内 ○ 単 （ハイフンは省略可）
15 メールアドレス email 半角 100以内 ○ 単 ★ ５メールアドレス形式
16 配送先情報 dest_information － － 単
17 企業名 dest_company_name 全角 30以内 単 ★ 6
18 部署名 dest_department 全角 30以内 単
19 担当者名 dest_customer_name 全角 15以内 単
20 担当者名（カナ） dest_customer_name_kana 全角カナ 25以内 単
21 郵便番号 dest_zip 半角 8以内 単 ★ ４ ★ 6
22 住所 dest_address 全角 50以内 単 ★ ４ ★ 6
23 電話番号 dest_tel 半角数値 13以内 単 ★ 6
24 決済方法 settlement_type 半角数値 2以内 ○ 単 02
25 請求書送付方法 billed_type 半角数値 1 ○ 単 1：郵送 2：メール
26 コンビニ払い設定 convenience_payment_flag 半角数値 1 単 0：なし 1：あり
★ 7
27 取引金額 billed_amount 半角数値 8以内 ○ 単 -99999999 ～ 99999999
★ 8
28 税率別合計金額明細 tax_rate_summaries － － 単 ★ 12
29 税率別合計金額情報 summary_information － － 複 ★ 9
30 税率 tax_rate 半角数値 2以内 ○ 単
31 合計金額 total_amount 半角数値 13以内 ○ 単
32 商品明細 goods_details － － ○ 単
33 商品情報 goods_information － － ○ 複
34 明細 goods_name 全角 150以内 ○ 単
35 元加盟店取引受注日 original_transaction_date 半角 10 単 YYYY/MM/DD形式
★ 14
36 商品単価 goods_price 半角数値 13以内 ★ 10 単 -99999999.999 ～99999999.999
37 数量 quantity 半角数値 13以内 ★ 10 単 -99999999.999 ～99999999.999
38 請求書税区分 billed_tax_kind 半角英数 3 単 N00:集計対象外,
T08:税込8%,
T10:税込10%,
B08:税別8%,
B10:税別10%,
R08:税込8%（返還）,
R10:税込10%（返還）,
H08:税別8%（返還）,
H10:税別10%（返還）,
E00:非課税,
U00:不課税
★ 11 ★ 13

リクエストフォーマット

正常レスポンス

No 項目名 物理名 型 桁数 必須入力 タグ 設定内容
1 ルート root － － ○ 単
2 電文ID telegram_id 半角英数 6 ○ 単 XU0030
3 受付番号 accept_no 半角英数 14 ○ 単 受付番号が設定されます。

レスポンスフォーマット


取引修正結果

https://bss.netprotections.com/npcbr/api/v1/transactions/modifications/results

リクエスト

No 項目名 物理名 説明 設定値（例）
1 ルート root データブロックを表します。
2 電文ID telegram_id 電文IDを設定します。 XD0030
3 受付番号 accept_no 取引修正依頼時の受付番号を設定します。

チェック仕様

No 項目名 物理名 型 桁数 必須入力 タグ 条件チェック
1 ルート root － － ○ 単
2 電文ID telegram_id 半角数値 6 ○ 単 XD0030であること
3 受付番号 accept_no 半角英数 1４ ○ 単 有効な受付番号であること

リクエストフォーマット

正常レスポンス

No 項目名 物理名 型 桁数 必須入力 タグ 設定内容
1 ルート root － － ○ 単
2 電文ID telegram_id 半角英数 6 ○ 単
3 受付番号 accept_no 半角英数 14 ○ 単
4 処理時間 process_date 半角 19 ○ 単 処理を開始した時間 2011/01/01 12:00:00
5 取引修正結果 transaction_revision_details － － ○ 単
6 修正OK結果 regist_OK_result － － 複 取引修正OKの取引情報
7 NP取引ID np_transaction_id 半角数値 11 単 修正OKのNP取引ID
8 加盟店取引ID shop_transaction_id 半角英数 40以下 単 修正OKの加盟店取引ID
9 修正NG結果 regist_NG_result － － 複 取引修正NGの取引情報
10 NP取引ID np_transaction_id 半角数値 11 単 修正NGのNP取引ID
11 加盟店取引ID shop_transaction_id 半角英数 40以下 単 設定されません。
12 エラーリスト error_list － － 複 修正NGのエラー内容リスト
13 エラー番号 error_no 半角英数 6 単 エラー番号が設定されます。
14 エラー種別 error_level 半角 1 単 エラー種別が設定されます。
15 エラー内容 error_contents 全角 100以下 単 エラー内容が設定されます。

レスポンスフォーマット


取引キャンセル（全モデル共通）


取引キャンセル依頼

https://bss.netprotections.com/npcbr/api/v1/transactions/cancel/requests
リクエスト

No 項目名 物理名 説明 設定値（例）
1 ルート root データブロックを表します。
2 電文ID telegram_id 電文IDです。 XU0040
3 取引キャンセル情報 transaction_cancel_details 詳細情報のデータブロックを表します。
4 NP取引ID np_transaction_id 登録時に付与されたNP取引IDです。

チェック仕様

No 項目名 物理名 型 桁数 必須入力 タグ 条件チェック
1 ルート root － － ○ 単
2 電文ID telegram_id 半角数値 6 ○ 単 XU0040
3 取引キャンセル情報 transaction_cancel_details － － ○ 複
4 NP取引ID np_transaction_id 半角数値 11 ○ 単 有効なNP取引IDであること

リクエストフォーマット

正常レスポンス

No 項目名 物理名 型 桁数 必須入力 タグ 設定内容
1 ルート root － － ○ 単
2 電文ID telegram_id 半角英数 6 ○ 単 XU0040
3 受付番号 accept_no 半角英数 14 ○ 単 受付番号が設定されます。

レスポンスフォーマット

取引キャンセル結果

https://bss.netprotections.com/npcbr/api/v1/transactions/cancel/results
リクエスト

No 項目名 物理名 説明 設定値（例）
1 ルート root データブロックを表します。
2 電文ID telegram_id 電文IDです。 XD0040
3 受付番号 accept_no 取引登録依頼時の受付番号です。

チェック仕様

No 項目名 物理名 型 桁数 必須入力 タグ 条件チェック
1 ルート root － － ○ 単
2 電文ID telegram_id 半角数値 6 ○ 単 XD0040であること
3 受付番号 accept_no 半角英数 1４ ○ 単 有効な受付番号であること

リクエストフォーマット

正常レスポンス

No 項目名 物理名 型 桁数 必須入力 タグ 設定内容
1 ルート root － － ○ 単
2 電文ID telegram_id 半角英数 6 ○ 単
3 受付番号 accept_no 半角英数 14 ○ 単
4 処理時間 process_date 半角 19 ○ 単 処理を開始した時間 2011/01/01 12:00:00
5 取引キャンセル結果 transaction_cancel_details － － ○ 単
6 キャンセルOK結果 regist_OK_result － － 複 取引キャンセルOKの取引情報
7 NP取引ID np_transaction_id 半角数値 11 単 キャンセルOKのNP取引ID
8 加盟店取引ID shop_transaction_id 半角英数 40以下 単 キャンセルOKの加盟店取引ID
9 キャンセルNG結果 regist_NG_result － － 複 取引キャンセルNGの取引情報
10 NP取引ID np_transaction_id 半角数値 11 単 キャンセルNGのNP取引ID
11 加盟店取引ID shop_transaction_id 半角英数 40以下 単 設定されません。
12 エラーリスト error_list － － 複 キャンセルNGのエラー内容リスト
13 エラー番号 error_no 半角英数 6 単 エラー番号が設定されます。
14 エラー種別 error_level 半角 1 単 エラー種別が設定されます。
15 エラー内容 error_contents 全角 100以下 単 エラー内容が設定されます。

レスポンスフォーマット


請求依頼（通販、営業販売）


請求依頼依頼

https://bss.netprotections.com/npcbr/api/v1/billings/requests
リクエスト

No 項目名 物理名 説明 設定値（例）
1 ルート root データブロックを表します。
2 電文ID telegram_id 電文IDです。 XU0020
3 請求依頼明細 sales_details 詳細情報のデータブロックを表します。
4 NP取引ID np_transaction_id 登録時に付与されたNP取引IDです。
5 請求書発行基準日 sales_date 請求書発行基準日です。 2011/01/01

チェック仕様

No 項目名 物理名 型 桁数 必須入力 タグ 条件チェック
1 ルート root － － ○ 単
2 電文ID telegram_id 半角数値 6 ○ 単 XU0020
3 請求依頼明細 sales_details － － ○ 複
4 NP取引ID np_transaction_id 半角数値 11 ○ 単 有効なNP取引IDであること
5 請求書発行基準日 sales_date 半角数値 10 ○ 単 YYYY/MM/DD形式

リクエストフォーマット

正常レスポンス

No 項目名 物理名 型 桁数 必須入力 タグ 設定内容
1 ルート root － － ○ 単
2 電文ID telegram_id 半角英数 6 ○ 単 XU0020
3 受付番号 accept_no 半角英数 14 ○ 単
レスポンスフォーマット


請求依頼結果

https://bss.netprotections.com/npcbr/api/v1/billings/results
リクエスト

No 項目名 物理名 説明 設定値（例）
1 ルート root データブロックを表します。
2 電文ID telegram_id 電文IDです。 XD0020
3 受付番号 accept_no 請求依頼依頼時の受付番号です。

チェック仕様

No 項目名 物理名 型 桁数 必須入力 タグ 条件チェック
1 ルート root － － ○ 単
2 電文ID telegram_id 半角数値 6 ○ 単 XD0020であること
3 受付番号 accept_no 半角英数 1４ ○ 単 有効な受付番号であること

リクエストフォーマット

正常レスポンス

No 項目名 物理名 型 桁数 必須入力 タグ 設定内容
1 ルート root － － ○ 単
2 電文ID telegram_id 半角英数 6 ○ 単
3 受付番号 accept_no 半角英数 14 ○ 単
4 処理時間 process_date 半角 19 ○ 単 処理を開始した時間 2011/01/01 12:00:00
5 請求依頼結果明細 sales_report_details － － ○ 単
6 請求依頼OK結果 regist_OK_result － － 複 請求依頼OKの取引情報
7 NP取引ID np_transaction_id 半角数値 11 単 請求依頼OKのNP取引ID
8 加盟店取引ID shop_transaction_id 半角英数 40以下 単 請求依頼OKの加盟店取引ID
9 請求依頼NG結果 regist_NG_result － － 複 請求依頼NGの取引情報
10 NP取引ID np_transaction_id 半角数値 11 単 請求依頼NGのNP取引ID
11 加盟店取引ID shop_transaction_id 半角英数 40以下 単 設定されません。
12 エラーリスト error_list － － 複 請求依頼NGのエラー内容リスト
13 エラー番号 error_no 半角英数 6 単 エラー番号が設定されます。
14 エラー種別 error_level 半角 1 単 エラー種別が設定されます。
15 エラー内容 error_contents 全角 100以下 単 エラー内容が設定されます。

レスポンスフォーマット


与信ステータス（営業販売・月額サービス）


与信ステータス取得

https://bss.netprotections.com/npcbr/api/v1/credit/status
リクエスト

No 項目名 物理名 説明 設定値（例）
1 ルート root データブロックを表します
2 与信ステータス取得パラメータ creditStatusParameter 詳細情報のデータブロックを表します
3 債権保証ステータス更新日（下限） creditGuaranteeStatusUpdateDateBegin 債権保証ステータス更新日の下限日付（この日付を含む）です。 ★ １ 20170729
4 債権保証ステータス更新日（上限） creditGuaranteeStatusUpdateDateEnd 債権保証ステータス更新日の上限日付です（この日付を含む） ★ １ 20170731

チェック仕様

No 項目名 物理名 型 桁数 必須入力 タグ 条件チェック
1 ルート root － － ○ 単
2 与信ステータス取得パラメータ creditStatusParameter － － ○ 単
3 債権保証ステータス更新日（下限） creditGuaranteeStatusUpdateDateBegin 半角数値 8 単 YYYYMMDD形式 下限は上限と同日または過去の日付であること
4 債権保証ステータス更新日（上限） creditGuaranteeStatusUpdateDateEnd 半角数値 8 単 YYYYMMDD形式

リクエストフォーマット

正常レスポンス

No 項目名 物理名 型 桁数 必須入力 タグ 設定内容
1 ルート root － － ○ 単
2 処理結果 creditStatusResult － － 単
3 購入企業債権保証状況リスト creditGuaranteeStatusLists － － 複 債権保証状況リスト
4 NP購入企業ID npBuyerId 半角英数 11 ○ 単 NP購入企業IDが設定されます
5 購入企業ID buyerId 半角英数 50以下 ○ 単 加盟店にて設定した購入企業IDです
6 購入企業名 companyName 全角 30以下 単 購入企業名
7 部署名 department 全角 30以下 単 部署名
8 担当者名 customerName 全角 15以下 単 担当者名
9 債権保証期限日 creditGuaranteeExpireDate 日付 8 単 NPにて保証が可能な期日
10 債権保証ステータス creditGuaranteeStatus 半角数値 2 ○ 単 ★ ２
11 債権保証ステータス更新日 creditGuaranteeStatusUpdateDate 日付 8 ○ 単 債権保証ステータスの更新日
12 取引登録期限日 transactionRegistrationDueDate 日付 8 単 取引登録が可能な記述。
13 取引登録可/不可 transactionRegistrationStatus 半角数値 2 ○ 単 ★ ３
14 請求残高 billedAmount 半角数値 15以下 単 現在未入金の請求金額。
15 エラーリスト errorLists － － 複 エラー内容リスト
16 エラー番号 errorNo 半角英数 6 ○ 単 エラー番号が設定されます。
17 エラー種別 errorLevel 半角 1 ○ 単 エラー種別が設定されます。
18 エラー内容 errorContents 全角 100以下 ○ 単 エラー内容が設定されます。

レスポンスフォーマット













導入の手引き


システム環境


HTTP通信が可能なプラットフォームであれば、システム接続サービスの利用が可能です。 代表的なプラットフォームには以下の様なものがあります。

接続情報

NP決済システムのシステム接続サービスを利用するうえで、必要な接続情報について記載します。

エンドポイント

APIのエンドポイント（接続先URL）は下記となります。

https://bss.netprotections.com/npcbr/api/v1


タイムアウト

通信中にタイムアウトが発生した場合には、加盟店様システムよりリトライを実施してください。


接続処理プログラム　サンプル


代表的なプラットフォームにおけるSOAP通信の接続処理のサンプルコードを記載します。

java

Jerseyを使用した接続処理の例を記載します。

package jp.co.agilegroup.installation_manual;

import javax.ws.rs.HttpMethod;
import javax.ws.rs.core.MediaType;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.Marshaller;

import com.sun.jersey.api.client.Client;
import com.sun.jersey.api.client.ClientRequest;
import com.sun.jersey.api.client.ClientResponse;
import com.sun.jersey.api.client.WebResource;
import com.sun.jersey.api.client.filter.HTTPBasicAuthFilter;

import java.io.StringWriter;
import java.net.URI;
import java.net.URISyntaxException;

public class RestClient {

    private Client getClient() {
        Client client = new Client();
        return client;
    }

    public String postRequest(String url, MediaType type) {
        Client client = getClient();
        // URIを設定
        WebResource resource = client.resource(url);
        ClientResponse response = resource.accept(type).get(ClientResponse.class);

        switch (response.getStatus()) {
            case 200: // OK
                break;
            default:
                return String.format("Code:%s Entity:%s",
                    response.getStatus(),
                    response.getEntity(String.class));
        }

        return response.getEntity(String.class);
    }
}

Ruby

Faradayを使用した接続処理の例を記載します。 
  require "faraday"

  require "json"


  # エンドポイントを指定

  client = Faraday.new(:url => "https://....") 


  # リクエスト

  res = client.post do |req|

    req.url 'transactions'

    req.headers['Content-Type'] = 'application/json'

    req.body = { … }.to_json // JSONを指定

  end


  body = JSON.parse res.body

  p body













導入試験


試験環境を用意しておりますので、NP掛け払いAPI導入の際にご利用ください。
試験環境の稼働時間はNP営業日の9:00～22:00です。
18:00以降、1・2時間ほどメンテナンスが行われる場合がございます。


接続情報

試験環境を利用するにあり必要な接続情報を記載します。

エンドポイント

APIのエンドポイント（接続先URL）は下記となります。
本番環境とはURLが異なりますので、ご注意ください。

https://bss-ct.np-kakebarai.com/np_ct/npcbr/api/v1

SPコード

試験環境用のSPコードはNPよりお知らせします。

審査結果


試験環境では審査結果に基づいた運用テストが可能になるよう、購入企業登録、取引登録および取引修正に購入企業情報メールアドレスの内容によって、生成される審査結果を指定できるテストモードを用意しております。
メールアドレス（local@任意のドメイン） のローカル部を下表の様に変更してください。

メールアドレス 購入企業審査結果 取引審査結果 備考
OK@任意のドメイン 1,000,000円 OK 審査OK
NG@任意のドメイン 0円 NG 審査NG
PD@任意のドメイン 300,000円 保留 審査保留の状態
IR@任意のドメイン 300,000円 審査中 審査中の状態
上記以外 300,000円 審査前 審査前の状態となり、審査結果は生成されません。