導入
概要
本ガイドには、capture
、cancel
、reauthorize
およびauthorize (with PayNowID)
の各APIを利用するための情報について記載しています。
本ガイドとあわせて、各処理の補足事項や注意事項についてこちらから「インターフェース詳細」の「カード」を参照してください。
capture
: 与信済み取引に対して売上を確定します。
cancel
: 与信済み取引のキャンセルや売上済み取引の返金を実施します。
reauthorize
: 過去の取引で利用したクレジットカード情報を利用して決済を実施します。
authorize (with PayNowID)
: VeriTrans4Gに登録した会員ID(カードID)に紐づくクレジットカード情報を利用して決済を実施します。
※authorize (with PayNowID)
の利用には別途ワンクリック継続課金(PayNowID)の契約が必要です。
APIリファレンス
エンドポイント
Capture : https://pay3.veritrans.co.jp/pop/v1/card-capture
Cancel : https://pay3.veritrans.co.jp/pop/v1/card-cancel
Reauthorize : https://pay3.veritrans.co.jp/pop/v1/card-reauthorize
Authorize (with PayNowID) : https://pay3.veritrans.co.jp/pop/v1/card-authorize
リクエスト仕様
HTTPメソッド
POST
POP_SERVER_KEY = "Test-POP-Server-Key";
AUTH_STRING = Base64("Test-POP-Server-Key:");
AUTH_STRING = "VGVzdC1QT1AtU2VydmVyLUtleTo=";
リクエストヘッダ
次の2つのヘッダをHTTPリクエストに設定します。
Content-Type : application/json; charset=utf-8
Authorization : Basic AUTH_STRING
POPはBASIC認証によりHTTPリクエストの検証を行います。
ユーザ名にPOP_SERVER_KEY
を、パスワードは空文字を設定してください。
API設定からPOP_SERVER_KEY
をご確認いただけます。
Authorization
ヘッダの値はAUTH_STRING
で記載しております。AUTH_STRING
はユーザ名とパスワードをbase64でエンコードした文字列です。
AUTH_STRING
= Base64(POP_SERVER_KEY
+ :
)
Capture
capture
は、与信済み取引に対して売上を確定します。
Captureリクエスト
{
"order_id": "ORDER-0001",
"amount": 10000,
"dummy": true
}
リクエストには、以下のパラメータが指定可能です。
パラメータ | 説明 |
---|---|
order_id string(100) (required) |
与信済み取引の取引ID。半角英数字と ‘-'(ハイフン)と ’_‘(アンダースコア)のみ指定可能です。他の文字は使用できません。 |
amount number (8) (required) |
売上金額。 |
dummy boolean (optional) |
ダミー取引を実施するために設定します。ダミーリクエストでは実際の決済処理は発生いたしません。VeriTransとの結合テスト用にご利用ください。 Values: true or false (Default: false ) |
Captureレスポンス
成功時のレスポンス
{
"order_id": "ORDER-0001",
"status": "success",
"result_code": "R001",
"message": "Payment Captured Successfully",
"m_status": "success",
"v_result_code": "A001000000000000",
"merr_msg": "処理が成功しました。"
}
失敗時のレスポンス
{
"order_id": "ORDER-0001",
"status": "failure",
"result_code": "RM01",
"message": "Gateway error",
"m_status": "failure",
"v_result_code": "AC38000000000000",
"merr_msg": "パラメータで指定した金額は超過しています。"
}
POPは、ECサイトからリクエストを受信した場合、以下のパラメータをレスポンスとして返戻します。
パラメータ | 説明 |
---|---|
order_id string(100) (optional) |
リクエスト時にマーチャント様が設定した取引ID。 |
status string(7) (required) |
処理のステータス。 Values: success or failure |
result_code string(4) (required) |
成功または失敗の具体的な理由を示す4文字の結果コード。 |
message string(256) (required) |
処理結果の詳細を表すメッセージ。 |
m_status string(32) (optional) |
決済ゲートウェイの決済結果。 決済ゲートウェイへのリクエスト送信前にエラーが発生した場合、返戻されません。 Values: success , failure or pending |
v_result_code string(16) (optional) |
決済ゲートウェイの結果コード。 決済ゲートウェイへのリクエスト送信前にエラーが発生した場合、返戻されません。 決済ゲートウェイが返戻する結果コードの詳細につきましては、こちらから「決済結果コード一覧」を参照してください。 |
merr_msg string(300) (optional) |
決済ゲートウェイのエラーメッセージ。 決済ゲートウェイへのリクエスト送信前にエラーが発生した場合、返戻されません。 |
Cancel
cancel
は、与信済み取引のキャンセルや売上済み取引の返金を実施します。
Cancelリクエスト
{
"order_id": "ORDER-0001",
"amount": 10000,
"dummy": true
}
リクエストには、以下のパラメータが指定可能です。
パラメータ | 説明 |
---|---|
order_id string(100) (required) |
与信済み、売上済み取引の取引ID。半角英数字と ‘-'(ハイフン)と ’_‘(アンダースコア)のみ指定可能です。他の文字は使用できません。 |
amount number (8) (optional) |
キャンセルまたは返金する金額。未設定の場合、全額が対象となります。 |
dummy boolean (optional) |
ダミー取引を実施するために設定します。ダミーリクエストでは実際の決済処理は発生いたしません。VeriTransとの結合テスト用にご利用ください。 Values: true or false (Default: false ) |
Cancelレスポンス
成功時のレスポンス
{
"order_id": "ORDER-0001",
"status": "success",
"result_code": "R002",
"message": "Payment Cancelled Successfully",
"m_status": "success",
"v_result_code": "A001000000000000",
"merr_msg": "処理が成功しました。"
}
失敗時のレスポンス
{
"order_id": "ORDER-0001",
"status": "failure",
"result_code": "RM01",
"message": "Gateway error",
"m_status": "failure",
"v_result_code": "AC38000000000000",
"merr_msg": "パラメータで指定した金額は超過しています。"
}
POPは、ECサイトからリクエストを受信した場合、以下のパラメータをレスポンスとして返戻します。
パラメータ | 説明 |
---|---|
order_id string(100) (optional) |
リクエスト時にマーチャント様が設定した取引ID。 |
status string(7) (required) |
処理のステータス。 Values: success or failure |
result_code string(4) (required) |
成功または失敗の具体的な理由を示す4文字の結果コード。 |
message string(256) (required) |
処理結果の詳細を表すメッセージ。 |
m_status string(32) (optional) |
決済ゲートウェイの決済結果。 決済ゲートウェイへのリクエスト送信前にエラーが発生した場合、返戻されません。 Values: success , failure or pending |
v_result_code string(16) (optional) |
決済ゲートウェイの結果コード。 決済ゲートウェイへのリクエスト送信前にエラーが発生した場合、返戻されません。 決済ゲートウェイが返戻する結果コードの詳細につきましては、こちらから「決済結果コード一覧」を参照してください。 |
merr_msg string(300) (optional) |
決済ゲートウェイのエラーメッセージ。 決済ゲートウェイへのリクエスト送信前にエラーが発生した場合、返戻されません。 |
Reauthorize
reauthorize
は、過去の取引で利用したクレジットカード情報を利用して決済を実施します。
Reauthorizeリクエスト
{
"order_id": "ORDER-0002",
"original_order_id": "ORDER-0001",
"amount": 10000,
"capture": true,
"dummy": true
}
リクエストには、以下のパラメータが指定可能です。
パラメータ | 説明 |
---|---|
order_id string(100) (required) |
取引ID。取引毎に一意になるように指定してください。半角英数字と ‘-'(ハイフン)と ’_‘(アンダースコア)のみ指定可能です。他の文字は使用できません。 |
original_order_id string(100) (required) |
元取引ID。過去の取引において指定された取引IDを指定してください。その取引で使用したカード情報を利用して決済を実施します。半角英数字と ’-‘(ハイフン)と ’_‘(アンダースコア)のみ指定可能です。他の文字は使用できません。 |
amount number (8) (required) |
送料を含む合計金額。1以上99,999,999以下の値を指定してください。 |
capture boolean (optional) |
売上フラグ。与信取得と売上を同時に実行するかどうかを決定します。 Values: true or false (Default: true ) |
dummy boolean (optional) |
ダミー取引を実施するために設定します。ダミーリクエストでは実際の決済処理は発生いたしません。VeriTransとの結合テスト用にご利用ください。 Values: true or false (Default: false ) |
Reauthorizeレスポンス
成功時のレスポンス
{
"order_id": "ORDER-0001",
"status": "success",
"result_code": "R003",
"message": "Payment Re-Authorize Successfully",
"m_status": "success",
"v_result_code": "A001000000000000",
"merr_msg": "処理が成功しました。",
"acquirer_code": "01",
"auth_code": "000000",
"masked_card_number": "411111*11",
"transaction_datetime": "20190214171158"
}
失敗時のレスポンス
{
"order_id": "ORDER-0001",
"status": "failure",
"result_code": "RM01",
"message": "Gateway error",
"m_status": "failure",
"v_result_code": "AG48000000000000",
"merr_msg": "無効カードです。",
"masked_card_number": "411111*11",
"transaction_datetime": "20190214135533",
"center_error_code": "G61"
}
POPは、ECサイトからリクエストを受信した場合、以下のパラメータをレスポンスとして返戻します。
パラメータ | 説明 |
---|---|
order_id string(100) (optional) |
リクエスト時にマーチャント様が設定した取引ID。 |
status string(7) (required) |
処理のステータス。 Values: success or failure |
result_code string(4) (required) |
成功または失敗の具体的な理由を示す4文字の結果コード。 |
message string(256) (required) |
処理結果の詳細を表すメッセージ。 |
m_status string(32) (optional) |
決済ゲートウェイの決済結果。 決済ゲートウェイへのリクエスト送信前にエラーが発生した場合、返戻されません。 Values: success , failure or pending |
v_result_code string(16) (optional) |
決済ゲートウェイの結果コード。 決済ゲートウェイへのリクエスト送信前にエラーが発生した場合、返戻されません。 決済ゲートウェイが返戻する結果コードの詳細につきましては、こちらから「決済結果コード一覧」を参照してください。 |
merr_msg string(300) (optional) |
決済ゲートウェイのエラーメッセージ。 決済ゲートウェイへのリクエスト送信前にエラーが発生した場合、返戻されません。 |
acquirer_code string(2) (optional) |
決済ゲートウェイから返戻される仕向け先コード。 |
auth_code string(7) (optional) |
決済ゲートウェイから返戻される承認番号。 |
masked_card_number string(20) (optional) |
取引で使用されたマスクされたカード番号。カード番号は 000000*00 という形式で返戻されます(上6桁下2桁のみ数字表示され、その他は ‘*‘(アスタリスク)に変換されます)。 |
transaction_datetime string(14) (optional) |
決済ゲートウェイから返戻される取引日時。 (YYYYMMDDhhmmss形式) |
center_error_code string(3) (optional) |
決済ゲートウェイから返戻されるカード決済センターエラーコード。 |
Authorize (with PayNowID)
authorize (with PayNowID)
は、VeriTrans4Gに登録した会員ID(カードID)に紐づくクレジットカード情報を利用して決済を実施します。
※別途ワンクリック継続課金(PayNowID)の契約が必要です。
Authorize (with PayNowID)リクエスト
{
"order_id": "ORDER-0001",
"amount": 10000,
"capture": true,
"paynow_account_id": "TEST-ACCOUNT-101",
"paynow_card_id": "232QDFCPFBR93UBEAITN7EQHL",
"paynow_default_card": true,
"dummy": true
}
リクエストには、以下のパラメータが指定可能です。
パラメータ | 説明 |
---|---|
order_id string(100) (required) |
取引ID。取引毎に一意になるように指定してください。半角英数字と ‘-'(ハイフン)と ’_‘(アンダースコア)のみ指定可能です。他の文字は使用できません。 |
amount number (8) (required) |
送料を含む合計金額。1以上99,999,999以下の値を指定してください。 |
capture boolean (optional) |
売上フラグ。与信取得と売上を同時に実行するかどうかを決定します。 Values: true or false (Default: true ) |
paynow_account_id string(100) (required) |
消費者様毎に一意の登録済みの会員IDです。会員IDには1枚以上のクレジットカード情報が紐づいている必要があります。 |
paynow_card_id string(100) (optional) |
決済で使用する会員IDに紐づくクレジットカード情報を指定する場合に使用します。未指定の場合は標準カードに設定されたクレジットカード情報を使用します。 |
paynow_default_card boolean (optional) |
paynow_card_id に紐づいたクレジットカード情報を標準カードとする場合はtrue を設定してください。標準カードを変更しない場合はfalse を設定してください。paynow_card_id を指定していない場合は未設定にしてください。Values: true or false (Default: true ) |
dummy boolean (optional) |
ダミー取引を実施するために設定します。ダミーリクエストでは実際の決済処理は発生いたしません。VeriTransとの結合テスト用にご利用ください。 Values: true or false (Default: false ) |
Authorize (with PayNowID)レスポンス
成功時のレスポンス
{
"order_id": "ORDER-0001",
"status": "success",
"result_code": "R004",
"message": "Payment Authorized Successfully",
"m_status": "success",
"v_result_code": "A001X00100000000",
"merr_msg": "処理が成功しました。",
"acquirer_code": "05",
"auth_code": "000000",
"masked_card_number": "411111*11",
"card_expire": "12/34",
"transaction_datetime": "20230331171241",
"paynow_status": "success",
"paynow_account_id": "pop-payNowAccountId",
"paynow_card_id": "9TTH6VLQ3RJH9JR38ISKFRPDG",
"paynow_message": "処理が成功しました。",
"paynow_default_card": true
}
失敗時のレスポンス
{
"order_id": "ORDER-0001",
"status": "failure",
"result_code": "RM01",
"message": "Gateway error",
"m_status": "failure",
"v_result_code": "AC22XH0900000000",
"merr_msg": "カード番号パラメータが設定していません。",
"transaction_datetime": "20190214135533",
"center_error_code": "G61",
"paynow_status": "failure",
"paynow_message": "未登録のカードです。"
}
POPは、ECサイトからリクエストを受信した場合、以下のパラメータをレスポンスとして返戻します。
パラメータ | 説明 |
---|---|
order_id string(100) (optional) |
リクエスト時に指定した取引ID。 |
status string(7) (required) |
処理のステータス。 Values: success or failure |
result_code string(4) (required) |
成功または失敗の具体的な理由を示す4文字の結果コード。 |
message string(256) (required) |
処理結果の詳細を表すメッセージ。 |
m_status string(32) (optional) |
決済ゲートウェイの決済結果。 決済ゲートウェイへのリクエスト送信前にエラーが発生した場合、返戻されません。 Values: success , failure or pending |
v_result_code string(16) (optional) |
決済ゲートウェイの結果コード。 決済ゲートウェイへのリクエスト送信前にエラーが発生した場合、返戻されません。 決済ゲートウェイが返戻する結果コードの詳細につきましては、こちらから「決済結果コード一覧」を参照してください。 |
merr_msg string(300) (optional) |
決済ゲートウェイのエラーメッセージ。 決済ゲートウェイへのリクエスト送信前にエラーが発生した場合、返戻されません。 |
acquirer_code string(2) (optional) |
決済ゲートウェイから返戻される仕向け先コード。 |
auth_code string(7) (optional) |
決済ゲートウェイから返戻される承認番号。 |
masked_card_number string(20) (optional) |
取引で使用されたマスクされたカード番号。カード番号は 000000*00 という形式で返戻されます(上6桁下2桁のみ数字表示され、その他は ‘*‘(アスタリスク)に変換されます)。 |
card_expire string(5) (optional) |
使用したカード有効期限(MM/YY)。 |
transaction_datetime string(14) (optional) |
決済ゲートウェイから返戻される取引日時。 (YYYYMMDDhhmmss形式) |
center_error_code string(3) (optional) |
決済ゲートウェイから返戻されるカード決済センターエラーコード。 |
paynow_status string(10) (optional) |
決済時の会員ID決済機能の処理結果。 |
paynow_account_id string(100) (optional) |
指定した会員ID。 |
paynow_card_id string(100) (optional) |
決済で使用したカードID。 |
paynow_message string(100) (optional) |
会員ID処理のメッセージ。 |
paynow_default_card boolean (optional) |
使用したカード情報が標準カードか否かを示すフラグ。 |
本番運用の開始
VeriTransより発行された、マーチャント様専用のPOP_SERVER_KEY
をご利用ください。
リクエストにて、dummy
の値をtrue
に設定してテストを実施していただき、動作に問題がないことを十分に確認していただいた後、
dummy
の値をfalse
に設定していただくことで、切り替えが完了となります。
切り替えのタイミングは、マーチャント様の任意のタイミングで実施可能です。 なお、エンドポイントのURLは特に変更していただく必要はございません。
結果コード
各APIでPOPから返戻されるresult_code
は、処理結果を表します。
以下にresult_code
の一覧とその内容を示します。
共通
結果コード | 説明 |
---|---|
RA01 |
Application Error - VeriTransで原因不明のエラーが発生した場合 |
RD01 |
Database Error - VeriTransのデータベース処理でエラーが発生した場合 |
RM01 |
Gateway Error - 決済ゲートウェイでエラーが発生した場合 |
RM03 |
MDK Error - POPから決済ゲートウェイへのリクエスト中にエラーが発生した場合 |
RC01 |
“Order ID"が無効です |
RC17 |
マーチャント認証に失敗しました。POP_SERVER_KEY をご確認ください |
RC26 |
"Dummy"が無効です |
RC30 |
サポートしていない"Media Type"です |
RC32 |
GETメソッドは対応していません |
RC3A |
"Amount"が無効です |
RC43 |
JSON文字列が無効です - POST リクエストに付与されたJSON文字列が不正です |
RC44 |
テストアカウントでは、"Dummy"に"true"を設定してください |
Capture
以下の結果コードはcapture
でのみ返戻されます。
結果コード | 説明 |
---|---|
R001 |
決済の売上に成功しました |
Cancel
以下の結果コードはcancel
でのみ返戻されます。
結果コード | 説明 |
---|---|
R002 |
決済のキャンセルに成功しました |
Reauthorize
以下の結果コードはreauthorize
でのみ返戻されます。
結果コード | 説明 |
---|---|
R003 |
決済の再与信に成功しました |
RC27 |
“Capture"が無効です |
RC3B |
"Security Code"が無効です |
RC3C |
"Original orderId"が無効です |
RC40 |
"JPO"が無効です |
RC41 |
"JPO Count"が無効です |
Authorize (with PayNowID)
以下の結果コードはauthorize (with PayNowID)
でのみ返戻されます。
結果コード | 説明 |
---|---|
R004 |
決済の与信に成功しました |
RC27 |
“Capture"が無効です |
RC2A |
"PayNow Account ID"が無効です |
RC2F |
"PayNow Default Card"が無効です |
RC2K |
"PayNow Card ID"が無効です |
FAQ
よくあるご質問については、こちらから「接続方式」の「POP(4G)」をご参照ください。
改訂履歴
v1.2
2024/3/13
接続先ドメインをpay3.veritrans.co.jp
に変更しました。
- 「APIリファレンス」の「エンドポイント」の「エンドポイント」。
MAP(Merchant Administration Portal)のリンクの接続先ドメインをadmin3.veritrans.co.jp
に変更しました。
v1.1
2023/7/5
Authorize (with PayNowID) APIの記載を追加しました。
v1.0
2019/6/28
新規作成。