APIパラメータについて

構成されるAPIについてご説明いたします。各APIの詳細については以下を参照ください。

暗号鍵入手API

URL Endpoint

Resource URL:
https://air.veritrans.co.jp/web/commodityRegist.action
Supported Methods:
POST

要求電文

決済種別で項目を絞込み:    

フィールド名 書式* 制限 必須 詳細
MERCHANT_ID AN 22 YES マーチャントID
MERCHANTHASH - - YES マーチャントハッシュキー・マーチャントID・決済タイプ・取引ID・金額を連結しSHA512を使用して生成するハッシュ値です。
SESSION_ID - 50 YES リクエストごとに採番するユニークなSession ID
SETTLEMENT_TYPE N 2 YES 決済方法 '00' = 指定無; '01' = クレジットカード; '02' = コンビニ
ORDER_ID ANS 100 YES 取引ID:取引毎にユニークになるように指定してください。
※記号は "-"(ハイフン)、"_"(アンダースコア)のみ使用可能です。
AMOUNT N 8 YES 合計金額(円)
※コンビニ決済の場合は、合計金額を1~300000で指定する。
※配送料を含む全額を設定してください。
SHIPPING_AMOUNT N 8 NO 配送料(円)
TIMELIMIT_OF_PAYMENT N 8 NO 支払期限 YYYYMMDD
FINISH_PAYMENT_RETURN_URL URL 256 NO 決済完了後戻り URL
UNFINISH_PAYMENT_RETURN_URL URL 256 NO 未決済時戻り URL
ERROR_PAYMENT_RETURN_URL URL 256 NO 決済エラー時戻り URL
FINISH_PAYMENT_ACCESS_URL URL 256 NO 決済結果通知先 URL
DUMMY_PAYMENT_FLAG N 1 NO ダミー取引フラグ 0 = 本番; 1 = テスト
CARD_CAPTURE_FLAG N 1 NO カード売上フラグ 0 = 与信; 1 = 与信同時売上
※デフォルト値 = 0
NAME1 D 20 NO 名前1
NAME2 D 20 NO 名前2
KANA1 D 20 NO カナ1
KANA2 D 20 NO カナ2
ADDRESS1 ADNS 50 NO -
ADDRESS2 ADNS 50 NO -
ADDRESS3 ADNS 50 NO -
ZIP_CODE NS 8 NO 郵便番号 例:123-4567
TELEPHONE_NO N 11 NO 顧客電話番号
MAILADDRESS MAIL 50 NO 顧客メール
BIRTHDAY N 8 NO 誕生日 YYYYMMDD
SEX N 1 NO 性別 '1' = 男; '2' = 女; '3' = その他
COMMODITY_ID ANS 15 NO 商品 ID
COMMODITY_UNIT N 8 NO 単価 (円)
COMMODITY_NUM N 3 NO 個数
COMMODITY_NAME ADNS 50 NO 商品名
JAN_CODE ANS 30 NO JANコード
*書式詳細
  • A:文字 (a-z, A-Z)
  • N:数字 (0 – 9)
  • S:記号 (- _)
  • D:全角
  • URL:URL形式
  • MAIL:メール形式

応答電文

Type:
Plain Text
応答電文(成功時):
MERCHANT_ENCRYPTION_KEY=AFHaRZhqAAQAAwACAAYAQSwEbFtwVzi8BU2Oi+nm8OenD
BROWSER_ENCRYPTION_KEY=AFHaRZhqAAQAAwACAAUAQRzPsfqv7p4nSUoJhXiEjaLjGYja
応答電文(失敗時):
ERROR_MESSAGE=Fail to authenticate merchant.

Air-Web転送API

URL Endpoint

Resource URL:
https://air.veritrans.co.jp/web/paymentStart.action
Supported Methods:
POST

転送電文

フィールド名 詳細
MERCHANT_ID マーチャントID
ORDER_ID 暗号鍵の入手時に指定した取引ID
BROWSER_ENCRYPTION_KEY 暗号鍵の入手時に返送されるBROWSER_ENCRYPTION_KEYの値

応答電文

応答電文なし - 消費者はVeriTrans決済ページへリダイレクトされます。

決済完了通知

支払いが完了すると事前に指定されたPOST先にAir-Webは取引IDと決済結果をECサイトに通知します。
また購入者およびECサイトへメールを送信いたします。通知先URLはサービス設定より確認ください。

設定情報はこちらより確認いただけます。

決済完了通知パラメータ例

パラメータ 書式 制限 サンプル 詳細
orderId ANS 100 air-web-123 ECサイトに指定された取引ID
mStatus AN 32 success 取引ステタス: success; failure; pending
vResultCode AN 16 A001H00100000000
mErrMsg ADNS - 処理が成功しました。
merchantEncryptionKey ANS - AFHaRZhqAAQAAwACAAYAQSwEbFtwVzi8BU2Oi+nm8OenD
決済完了通知に対してECサイト側がHTTPステータスコード"200"を返戻した場合、ECサイト側での受信処理が正常に終了したものと判断します。
HTTPS での結果通知受信を希望される場合は、ECサイト側設置サーバにてSSL 通信環境をご用意ください。SSL 証明書は認証局発行のものをご使用ください。
※自己署名(Self-Sign)のSSL 証明書はご利用できませんので、ご注意ください。

コンビニ決済入金通知

決済センターからの入金完了情報(消費者の支払完了情報)を受け取り、該当の入金が完了したと判断した場合にECサイトに入金通知を通知します。
通知先URLはサービス設定より確認ください。

入金通知パラメータ例

パラメータ 書式 制限 サンプル 詳細
numberOfNotify N 4 100 1度に通知可能な件数は1,000件
1,001件以上は次回通知
pushTime N 14 20140401202500 通知した時刻
YYYYMMDDhhmmss形式
pushId N 8 10082225 プッシュ処理を行うたびに採番されるID
通知件数分下記の項番を繰り返す。尚、フィールド名の後ろに4ケタの連番(0000~0999)を付与する。
orderId ANS 100 air-web-123 ECサイトに指定された取引ID
cvsType ANS 10 sej "sej":セブン-イレブン
"econ-lw":ローソン
"econ-fm":ファミリーマート
"econ-mini":ミニストップ
"econ-other":セイコーマート
"econ-ck":サークルK
"econ-sn":サンクス
receiptNo ANS 32 2000000020001 受付番号
receiptDate N 14 20140401202135 消費者側で支払が完了した時刻
YYYYMMDDhhmmss形式
rcvAmount N 6 5000 入金金額
dummy N 1 1 ダミー取引の場合は"1"
※ダミー取引の場合、入金通知のcvsTypeは下記の通り:
・sejの場合はcvsType=sej
・その他の場合はcvsType=econ-lwになります。
コンビニ決済入金通知に対してECサイト側がHTTPステータスコード"200"を返戻した場合、ECサイトでの受信処理が正常に終了したものと判断します。
ECサイト側よりHTTPステータスコード"200"以外のコードが返戻された場合は、受信失敗と判断し、一定期間通知を繰り返します。
HTTPS での結果通知受信を希望される場合は、ECサイト側設置サーバにてSSL 通信環境をご用意ください。SSL 証明書は認証局発行のものをご使用ください。
※自己署名(Self-Sign)のSSL 証明書はご利用できませんので、ご注意ください。

結果コード一覧

VeriTrans Airサービスにおいてご利用いただける処理結果ステータス、処理結果コード及びレスポンスメッセージ一覧は以下より確認ください。

結果コード一覧 [PDF]