Download OpenAPI specification:Download
VeriTrans4G Unified APIはECサイト等でのオンライン決済におけるシンプルなインターフェースを提供します。
本ガイドは各種APIを利用してオンライン決済を導入するための開発者向けのガイドです。
以下の決済タイプでのオンライン決済をサポートしており、今後も対応する決済タイプを追加予定です。
VeriTrans4G Unified API では以下APIが用意されています。
| API | 支払方式 | 対応決済タイプ | |||||||||
| 名称 | command名 | リクエスト向き先 | 都度 | 随時申込 | 随時支払 | PayPay ※1 | 楽天ペイ | ドコモ | au | メルペイ | |
| 決済申込 | pay | 加盟店⇒Unified API | 〇 | × | × | 〇 | 〇 | 〇 | 〇 | 〇 | |
| 随時申込 | subscribe | 加盟店⇒Unified API | × | 〇 | × | 〇 | 〇 | 〇 | 〇 | 〇 | |
| 申込変更 | updateOrder | 加盟店⇒Unified API | 〇 | × | 〇 | × | 〇 | × | 〇 ※2 | × | |
| 売上 | capture | 加盟店⇒Unified API | 〇 | × | 〇 | 〇 | 〇 | 〇 | 〇 | 〇 | |
| キャンセル | cancel | 加盟店⇒Unified API | 〇 | × | 〇 | 〇 | 〇 | 〇 | 〇 | 〇 | |
| 随時支払 | charge | 加盟店⇒Unified API | × | × | 〇 | 〇 | 〇 | 〇 | 〇 | 〇 | |
| 解約 | terminate | 加盟店⇒Unified API | × | 〇 | × | 〇 | × | 〇 | 〇 | 〇 | |
| リダイレクト | redirect | Unified API⇒(消費者ブラウザ⇒)加盟店 | 〇 | 〇 | × | 〇 | 〇 | 〇 | 〇 | 〇 | |
| Webhook | push | Unified API⇒加盟店 | 〇 | 〇 | 〇 | 〇 | 〇 | 〇 | 〇 | 〇 | |
| 取引結果取得 | getTransactionResult | 加盟店⇒Unified API | 〇 | 〇 | 〇 | 〇 | 〇 | 〇 | 〇 | 〇 | |
URL
2025年7月末まで
Live環境:https://api.unified.veritrans.co.jp/fep/command
Sandbox環境:https://api.sandbox.unified.veritrans.co.jp/fep/command
2025年8月以降
Live環境:https://api.unified.veritrans.jp/fep/command
Sandbox環境:https://api.sandbox.unified.veritrans.jp/fep/command
※各環境の詳細については「稼働確認」を参照してください。
| フィールド名 | 設定 | 書式・制限 | 説明 |
| Content-Type | 必須 | 右記の通り | application/json |
| Authorization | どちらかのみ 指定必須 |
右記の通り |
Bearer {token} {token}については以下「決済リクエストの認証について」を参照してください。 |
| X-VT-Content-hmac | 右記の通り |
h=HmacSHA512;s={マーチャントCCID};v={hmacString} {マーチャントCCID}と{hmacString} については以下「決済リクエストの認証について」を参照してください。 |
|
| X-VT-Idempotency-Key | 任意 | 半角英数字記号 100バイト以内 |
冪等チェックのための任意の値 ※記号は-(ハイフン)、_(アンダースコア)のみ使用可能です。 詳細は以下「冪等性について」を参照してください。 |
Content-Type: application/json;
Authorization: Bearer 222fd022-dc1d-4736-eab4-c5d9c507a284
X-VT-Content-hmac: h=HmacSHA512;s=MerchantCcId;v=915dd44f78777da61c26e683ae63cdf3aee72a212596ffc7fa4c0833dd224374
X-VT-Idempotency-Key: 29eb1743-b37c-d7c4-badb-7bc4056d9a98
VeriTrans4G Unified API では各APIリクエストの認証処理にBearer認証およびHMAC認証を利用しています。
加盟店様でどちらの認証方式をご利用されるか選択していただき、対応する項目をリクエストヘッダに設定してください。
両方設定された場合にはBearer認証として処理します。
それぞれの認証方式に関しては以下をご確認ください。
{token}はMAPにて取得(生成)します。期限内のトークンをリクエストヘッダに指定してください。
※MAP画面上の「Unified API」アイコンをクリックし、「Bearer認証設定」からご確認いただけます。
※「Unified API」アイコンはUnified API未契約のマーチャントIDでログインした場合は、非表示となります。

X-VTContent-hmacにおける{マーチャントCCID}には、マーチャントCCIDを指定してください。
{hmacString}には、以下の順番で文字列を区切り文字なしで連結し、「HmacSHA512」にて生成したハッシュ値を設定してください。
(Webhookの場合も同様に、リクエストヘッダに指定するため検証を実施してください。)
1. マーチャントCCID
2. リクエストパラメータ文字列(JSON⇒String変換後文字列)
3. マーチャント認証鍵
マーチャントCCID=sampleCcId
リクエストパラメータ文字列={"order":{"payType": "paypay", "paymentId":
"paymentId_1234567890", "amount": "10000"},"item": [{"id": "item001", "name":
"testItem001"},{"id": "item002", "name": "testItem002"}],"merchant":{ "storeName":
"store001"},"control":{"requestMode": "test,successUrl":
"https://example.com/", "cancelUrl": "https://example.com/", "errorUrl":
"https://example.com/", "pushUrl": "https://example.com/"}}
マーチャント認証鍵=sampleKey
連結文字列
str=sampleCcId{"order":{"payType": "paypay", "paymentId":
"paymentId_1234567890", "amount": "10000"},"item": [{"id": "item001", "name":
"testItem001"},{"id": "item002", "name": "testItem002"}],"merchant":{ "storeName":
"store001"},"control":{"requestMode": "test,successUrl":
"https://example.com/", "cancelUrl": "https://example.com/", "errorUrl":
"https://example.com/", "pushUrl": "https://example.com/"}}sampleKey
※上記連結文字列からHmacSHA512にてハッシュ値を生成してください。
なお上記の「sampleCcId」「sampleKey」部分は実際の値に読み替えて生成するようご注意ください。

リクエスト時にIdempotency-Keyを設定することで、過去リクエスト(※1)との同一チェックを行うことができます。
過去リクエストと同一と判断した場合は、実際に処理は行わず過去リクエストの結果を返戻します。
本機能は加盟店様にて受信に失敗したレスポンスを再取得することを想定しています。
例として、売上のリクエストを実施した際に加盟店様にてレスポンスを受信できなかった場合、
Idempotency-Keyも含めて同じパラメータで再度リクエストを実施してください。
Idempotency-Keyが同じであれば最初のレスポンスが送信されます。
このとき最初のリクエスト自体がFEPサーバに到達していなかった場合は、そのまま新規リクエストとして処理されます。
なおIdempotency-Keyには書式内であれば自由に設定可能ですが、UUIDv4での設定を推奨します。
冪等は各API毎に以下項目で判断します。
・(ヘッダ)X-VT-Idempotency-Key
・(ボディ)paymentId(fepOrderIdでも可)
※1:注意事項
・Idempotency-Keyが過去リクエストと同一の場合でも、リクエストされたAPIもしくはpaymentIdが異なる場合は別リクエストとして扱います。
・Idempotency-Keyが過去リクエストと同一の場合でも、リクエスト項目に対する書式チェックは行われるため、リクエスト内容は原則変更しないようにご注意ください。
・Idempotency-Keyの保証期間は24時間となります。保証期間後に同じ値でリクエストした場合、新しいリクエストとして処理されます。
以下項目については加盟店様にて取引に紐づくKey情報を自由に設定可能です。
なお設定内容はAPIのリクエスト単位で保持されるため、過去の設定内容の更新・削除はできません。
対象の項目について、FEPサーバで保存する際に暗号化は行っておりませんので、
個人情報などは設定しないようにご注意ください。
VeriTrans4G Unified APIにおいて、取引を一意に判定するためのIDです。
申込処理毎に他のpaymentIdと重複しないよう、加盟店様で任意に採番してください。他決済タイプとも重複できません。
取引が成功するまでの間は、同一IDで再度リクエストが可能となります。
再リクエストについては、決済ライフサイクルを参照してください。
ただし、取引の成否が未確定の状態で同じpaymentIdで取引を実施された場合は、同一paymentIdで複数の決済が成立する可能性があることに注意してください。
その場合片方の取引に対してUA-000-002が返却されます。MAPなどでUA-000-002が生じた場合はお客様の決済状況を確認するようにしてください。
Sandbox環境で使用したpaymentIdを、Live環境で再度使用することはできません。
paymentIdには、半角英数字以外に-(ハイフン)、_(アンダースコア)も使用可能です。
VeriTrans4G Unified APIでは決済申込リクエスト時に設定していただいたpaymentIdを元に、決済サーバと連携するID(fepOrderId)を別途採番します。
当IDは、決済申込後のリダイレクトやWebhookにて返戻し、決済申込以外のAPIリクエストやお問い合わせ時にpaymentIdの代わりとして使用するためのIDです。
なお採番体系は以下の通りです。
paymentId + _ + 26~35バイトのランダム文字列
例) paymentId:id123456789のとき、fepOrderId:id123456789_01AHK4HS7GFKHGKE7SGFJKTHIH
※MAPでの取引検索時にはpaymentIdは使用できず、fepOrderIdでのみ検索が可能です。
随時支払時、決済に紐づく元取引(随時申込の取引)のID(paymentId)です。
随時決済の決済申込時に指定したIDを設定してください。
随時支払時、決済に紐づく元取引(随時申込の取引)のID(fepOrderId)です。
随時決済の決済申込時にorderで返戻されたfepOrderIdを指定してください。
FEPサーバでリクエスト毎に新規採番されたIDです。
取引結果取得APIで使用することができます。
電文の改ざん検知のためvAuthInfoの検証を必ず行ってください。
なおパラメータの連結順序は固定ではないため、authParamsを参照のうえ動的に処理する必要があります。
また加盟店様の処理におかれましては、検証結果が問題ない場合でも、パラメータのpaymentIdが決済申し込み時と一致しているかどうかのチェックも必ず行ってください。
vAuthInfoの検証だけでは電文の一部改ざんについては検知可能ですが、不正利用目的で過去に成功した取引時のリダイレクト情報全量とすり替えが行われた場合には、不正データであることの検知ができません。
APIのレスポンスに設定される結果コード(resultCode)は以下の通りです。
エラー内容によっては、HTTPステータスコードのみが返却される場合がありますのでご留意ください。
| HTTP ステータスコード |
結果コード (resultCode) |
説明 | ステータス (status) |
アクションコード (actionCode) |
| 200 | UA-000-001 | 成功 | success | success |
| 200 | UA-000-002 | 成功(要確認) | confirm_payment | |
| 200 | UA-U00-001 | 消費者支払待ち | user_paying | |
| 200 | UA-P00-001 | 事業者処理中 | provider_processing | |
| 400 | UA-REQ-001 | 電文不正 | failure | confirm_request |
| 400 | UA-REQ-002 | パラメータ不正 | confirm_request | |
| 409 | UA-REQ-003 | 取引重複 | confirm_request | |
| 401 | UA-REQ-004 | 実行権限がない | confirm_merchant_info | |
| 406 | UA-REQ-005 | 処理中 | retry_request | |
| 400 | UA-REQ-006 | リクエスト期限超過(売上期限、取消期限、など) | alternate_payment | |
| 400 | UA-REQ-007 | API実行不可(内部ステータス不正) | confirm_payment_status | |
| 401 | UA-REQ-008 | 認証エラー | confirm_token | |
| 404 | UA-REQ-900 | リクエスト内容不正(該当加盟店/該当取引なし) | confirm_request | |
| 502 | UA-PRV-001 | 事業者エラー | retry_request | |
| 502 | UA-PRV-002 | API実行不可(外部ステータス不正) | confirm_payment_status | |
| 502 | UA-PRV-003 | API実行不可(加盟店登録&契約関連) | confirm_merchant_info | |
| 502 | UA-PRV-004 | 事業者エラー(金額不正) | confirm_request | |
| 503 | UA-PRV-999 | メンテナンス中 | maintenance | |
| 502 | UA-CST-001 | 消費者起因エラー | confirm_consumer | |
| 502 | UA-CST-002 | 消費者キャンセル | retry_payment | |
| 502 | UA-CST-003 | 消費者認証エラー | retry_payment | |
| 429 | UA-LMT-001 | 同時接続数超過 | retry_request | |
| 403 | UA-LMT-002 | リクエスト元IPアドレス不正 | confirm_merchant_info | |
| 500 | UA-PND-001 | 決済状態不明(ペンディング) | confirm_pending_status | |
| 500 | UA-SYS-001 | システムエラー | error | inquiry_support |
| 500 | UA-SYS-002 | アプリケーションエラー | inquiry_support | |
| 500 | UA-SYS-003 | 内部通信エラー | retry_request | |
| 500 | UA-SYS-004 | 外部通信エラー | retry_request | |
| 404 | - | ページが見つからない | - | - |
APIのレスポンスに設定されるステータス(status)は以下の通りです。
| ステータス (status) |
説明 |
| success | 成功 |
| failure |
取引失敗 (リクエスト不正、消費者利用判定、決済事業者判断など) |
| error |
システムエラー (Unified APIもしくは、決済事業者側のサーバ起因によるものなど) |
APIのレスポンスに設定されるアクションコードは、取引ステータスがsuccess以外の場合に加盟店様の推奨する対応を簡易に表したコードです。
返戻するアクションコードと加盟店様の対応内容については以下の通りです。
| アクションコード (actionCode) |
加盟店様対応 |
|---|---|
| inquiry_support | テクニカルサポートへご連絡ください。 |
| maintenance | メンテナンス期間をご確認の上、再度リクエストしてください。 |
| confirm_payment | 二重取引または取引状態不正の可能性があるため、MAPで取引の状態を確認してください。 |
| confirm_payment_status | 取引の状況に則さないAPIが実行されていないかご確認ください。 |
| confirm_request | エラーメッセージを参考にパラメータ値をご確認ください。 |
| confirm_merchant_info | エラーメッセージを参考に加盟店様の登録状況をご確認ください。 |
| alternate_payment | 取引状況をご確認のうえ、再度リクエストしてください。または異なる決済手段にて決済をしてください。 |
| retry_request | 時間を置いてから再度決済を実行してください。 何度も発生する場合には、テクニカルサポートへご連絡ください。 |
| retry_payment | 決済申込を最初からやり直してください。 |
| confirm_consumer | 消費者様起因のエラーです。消費者様の状態をご確認ください。 |
| confirm_token | 認証トークンを確認してください。 |
| user_paying | 決済処理中となります。一定時間経過後に取引状況をご確認ください。 |
| provider_processing | 決済事業者の処理待ちとなります。一定時間経過後に取引状況をご確認ください。 |
| confirm_pending_status | 決済の状態が成功・失敗どちらの可能性もあります。 一定時間経過後に取引状況を確認し、状態に変化が無ければテクニカルサポートへご連絡ください。 |
APIのレスポンスに設定されるmessageは、結果コードの説明が英語表記で設定されます。言語の切り替えは行えませんのでご留意ください。
加盟店⇒Unified API
required | object (order) |
object (transaction) | |
Array of objects (item) | |
object (merchant) | |
object (customer) | |
required | object (control) |
object (paymentInstrument) |
{- "order": {
- "payType": "paypay",
- "paymentId": "paymentId_1234567890",
- "amount": "10000",
- "authCaptureType": "auth",
- "description": "testOrder",
- "commodityType": "product_sales"
}, - "transaction": {
- "merchantRequestKey1": "freeKey1",
- "merchantRequestKey2": "freeKey2",
- "metadata1": "freeSpace1",
- "metadata2": "freeSpace2"
}, - "item": [
- {
- "id": "item001",
- "name": "testItem001",
- "categoryId": "1112"
}
], - "merchant": {
- "storeId": "storeId001",
- "storeName": "storeName001",
- "terminalId": "terminalId001"
}, - "customer": {
- "buyer": {
- "buyerInfoType": "not_use",
- "userAgent": "example"
}, - "shipping": {
- "deliveryAddressType": "not_use"
}
}, - "control": {
- "requestMode": "sandbox",
}, - "paymentInstrument": {
- "au": {
- "loginType": "linked_id"
}
}
}{- "result": {
- "status": "success",
- "actionCode": "success",
- "resultCode": "UA-000-001",
- "message": "success"
}, - "order": {
- "paymentId": "paymentId_1234567890"
}, - "transaction": {
- "fepReferenceId": "X01AHK4HS7GFKHGKE7SGFJKTHIH",
- "merchantRequestKey1": "freeKey1",
- "merchantRequestKey2": "freeKey2",
- "metadata1": "freeSpace1",
- "metadata2": "freeSpace2"
},
}加盟店⇒Unified API
required | object (order) |
object (transaction) | |
Array of objects (item) | |
object (merchant) | |
object (customer) | |
required | object (control) |
object (paymentInstrument) |
{- "order": {
- "payType": "paypay",
- "paymentId": "paymentId_1234567890",
- "orderName": "testOrderName",
- "description": "testOrder",
- "commodityType": "product_sales"
}, - "transaction": {
- "merchantRequestKey1": "freeKey1",
- "merchantRequestKey2": "freeKey2",
- "metadata1": "freeSpace1",
- "metadata2": "freeSpace2"
}, - "item": [
- {
- "id": "item001",
- "name": "testItem001",
- "categoryId": "1714"
}
], - "merchant": {
- "storeId": "storeId001",
- "storeName": "storeName001",
- "terminalId": "terminalId001"
}, - "customer": {
- "buyer": {
- "buyerInfoType": "not_use",
- "userAgent": "example"
}, - "shipping": {
- "deliveryAddressType": "not_use"
}
}, - "control": {
- "requestMode": "sandbox",
}, - "paymentInstrument": {
- "au": {
- "loginType": "linked_id"
}
}
}{- "result": {
- "status": "success",
- "actionCode": "success",
- "resultCode": "UA-000-001",
- "message": "success"
}, - "order": {
- "paymentId": "paymentId_1234567890"
}, - "transaction": {
- "fepReferenceId": "X01AHK4HS7GFKHGKE7SGFJKTHIH",
- "merchantRequestKey1": "freeKey1",
- "merchantRequestKey2": "freeKey2",
- "metadata1": "freeSpace1",
- "metadata2": "freeSpace2"
},
}| status | |
| actionCode | string <= 64 characters 半角英数字記号 Example: actionCode=success 加盟店様の行動の指針となるアクションコード。 記号は-(ハイフン)、_(アンダースコア)。 |
| resultCode | string <= 10 characters 半角英数字記号 Example: resultCode=UA-000-001 取引結果の具体的な理由を示す結果コード。 記号は-(ハイフン)、_(アンダースコア)。 |
| command | string <= 20 characters 半角英数字記号 Example: command=pay リダイレクトの起因コマンド。 記号は-(ハイフン)、_(アンダースコア)。 |
| paymentId | string <= 64 characters 半角英数字記号 Example: paymentId=paymentId_1234567890 対象取引に紐づくpaymentId。 |
| fepOrderId | string <= 100 characters 半角英数字記号 Example: fepOrderId=paymentId_1234567890_01AHK4HS7GFKHGKE7SGFJKTHIH 対象取引に紐づくfepOrderId。 記号は-(ハイフン)、_(アンダースコア)。 |
| fepReferenceId | string <= 100 characters 半角英数字記号 Example: fepReferenceId=X01AHK4HS7GFKHGKE7SGFJKTHIH 対象取引に紐づくfepReferenceId。 記号は-(ハイフン)、_(アンダースコア)。 |
| merchantRequestKey1 | string <= 100 characters 半角英数字記号 Example: merchantRequestKey1=freeKey1 決済申込時に設定された内容。 ※リクエスト時に未設定の場合は返戻されません。 |
| merchantRequestKey2 | string <= 100 characters 半角英数字記号 Example: merchantRequestKey2=freeKey2 決済申込時に設定された内容。 ※リクエスト時に未設定の場合は返戻されません。 |
| vAuthInfo | string <= 4000 characters 下記文字列を順番に区切り文字なしで連結し、「SHA512」 によって算出したハッシュ値 1.マーチャント CCID 2.パラメータ値の連結文字列(authParams が示す順序で連結) 3.マーチャント認証鍵 尚、パラメータ値を連結する際は、パラメータ名や区切り文字は含めず、パラメータ値のみを連結しています。 連結した文字列をバイナリに変換する際の文字エンコーディングは、UTF-8 を使用しています。 |
| authParams | string <= 4000 characters
vAuthInfoのハッシュ値を算出する元とした文字列のパラメータの連結順序を示す値
例)
|
加盟店⇒Unified API
required | paymentId指定 (object) or fepOrderId指定 (object) (order) |
object (transaction) | |
object (control) |
{- "order": {
- "paymentId": "paymentId_1234567890",
- "amount": "10000",
- "authExtensionType": "not_extend"
}, - "transaction": {
- "merchantRequestKey1": "freeKey1",
- "merchantRequestKey2": "freeKey2",
- "metadata1": "freeSpace1",
- "metadata2": "freeSpace2"
},
}{- "result": {
- "status": "success",
- "actionCode": "success",
- "resultCode": "UA-000-001",
- "message": "success"
}, - "order": {
- "paymentId": "paymentId_1234567890",
- "fepOrderId": "paymentId_1234567890_01AHK4HS7GFKHGKE7SGFJKTHIH",
- "amount": "100",
- "usedPoint": "0",
- "cancelExpirationDatetime": "20230526123456",
- "captureExpirationDatetime": "20230526123456",
- "updateExpirationDatetime": "20230526123456",
- "extendAuthExpirationDatetime": "20230526123456"
}, - "transaction": {
- "fepReferenceId": "X01AHK4HS7GFKHGKE7SGFJKTHIH",
- "transactionDatetime": "20230525123456",
- "merchantRequestKey1": "freeKey1",
- "merchantRequestKey2": "freeKey2",
- "metadata1": "freeSpace1",
- "metadata2": "freeSpace2"
}, - "provider": {
- "payment": {
- "providerOrderId": "XXX00000000001",
- "gatewayOrderId": "00000000000000000001"
}
}
}加盟店⇒Unified API
required | paymentId指定 (object) or fepOrderId指定 (object) (order) |
object (transaction) | |
object (control) |
{- "order": {
- "paymentId": "paymentId_1234567890",
- "amount": "10000",
- "description": "testItem"
}, - "transaction": {
- "merchantRequestKey1": "freeKey1",
- "merchantRequestKey2": "freeKey2",
- "metadata1": "freeSpace1",
- "metadata2": "freeSpace2"
},
}{- "result": {
- "status": "success",
- "actionCode": "success",
- "resultCode": "UA-000-001",
- "message": "success",
- "vResultCode": "1001000000000000"
}, - "order": {
- "paymentId": "paymentId_1234567890",
- "fepOrderId": "paymentId_1234567890_01AHK4HS7GFKHGKE7SGFJKTHIH",
- "amount": "10000",
- "usedPoint": "100"
}, - "transaction": {
- "fepReferenceId": "X01AHK4HS7GFKHGKE7SGFJKTHIH",
- "transactionDatetime": "20230525123456",
- "merchantRequestKey1": "freeKey1",
- "merchantRequestKey2": "freeKey2",
- "metadata1": "freeSpace1",
- "metadata2": "freeSpace2"
}, - "provider": {
- "payment": {
- "providerOrderId": "XXX00000000001",
- "gatewayOrderId": "00000000000000000001"
}
}
}加盟店⇒Unified API
required | paymentId指定 (object) or fepOrderId指定 (object) (order) |
object (transaction) | |
object (control) |
{- "order": {
- "paymentId": "paymentId_1234567890",
- "amount": "10000"
}, - "transaction": {
- "reason": "testCancel",
- "merchantRequestKey1": "freeKey1",
- "merchantRequestKey2": "freeKey2",
- "metadata1": "freeSpace1",
- "metadata2": "freeSpace2"
},
}{- "result": {
- "status": "success",
- "actionCode": "success",
- "resultCode": "UA-000-001",
- "message": "success",
- "vResultCode": "1001000000000000"
}, - "order": {
- "paymentId": "paymentId_1234567890",
- "fepOrderId": "paymentId_1234567890_01AHK4HS7GFKHGKE7SGFJKTHIH",
- "amount": "10000",
- "usedPoint": "100"
}, - "transaction": {
- "fepReferenceId": "X01AHK4HS7GFKHGKE7SGFJKTHIH",
- "transactionDatetime": "20230525123456",
- "merchantRequestKey1": "freeKey1",
- "merchantRequestKey2": "freeKey2",
- "metadata1": "freeSpace1",
- "metadata2": "freeSpace2"
}, - "provider": {
- "payment": {
- "inquiryCode": "inquiryCode12345",
- "providerOrderId": "XXX00000000001",
- "gatewayOrderId": "00000000000000000001"
}
}
}加盟店⇒Unified API
required | originalPaymentId指定 (object) or originalFepOrderId指定 (object) (order) |
object (transaction) | |
Array of objects (item) | |
object (merchant) | |
object (control) |
{- "order": {
- "paymentId": "paymentId_1234567890",
- "originalPaymentId": "orgPaymentId_1234567890",
- "authCaptureType": "auth_with_capture",
- "amount": "10000",
- "description": "testOrder"
}, - "transaction": {
- "merchantRequestKey1": "freeKey1",
- "merchantRequestKey2": "freeKey2",
- "metadata1": "freeSpace1",
- "metadata2": "freeSpace2"
}, - "item": [
- {
- "id": "item001",
- "name": "testItem001",
- "categoryId": "1014"
}
], - "merchant": {
- "storeId": "storeId001",
- "terminalId": "terminalId001"
}, - "control": {
- "protocol": {
- "recoveryType": "recover",
- "recoveryExpiredDatetime": "20230601125959"
}
}
}{- "result": {
- "status": "success",
- "actionCode": "success",
- "resultCode": "UA-000-001",
- "message": "success",
- "vResultCode": "1001000000000000"
}, - "order": {
- "paymentId": "paymentId_1234567890",
- "fepOrderId": "paymentId_1234567890_01AHK4HS7GFKHGKE7SGFJKTHIH",
- "originalPaymentId": "orgPaymentId_1234567890",
- "originalFepOrderId": "orgPaymentId_1234567890_01AHK4HS7GFKHGKE7SGFJKTHIH",
- "amount": "10000",
- "usedPoint": "100",
- "cancelExpirationDatetime": "20230526123456",
- "captureExpirationDatetime": "20230526123456",
- "updateExpirationDatetime": "20230526123456",
- "extendAuthExpirationDatetime": "20230526123456"
}, - "transaction": {
- "fepReferenceId": "X01AHK4HS7GFKHGKE7SGFJKTHIH",
- "transactionDatetime": "20230526123456",
- "merchantRequestKey1": "freeKey1",
- "merchantRequestKey2": "freeKey2",
- "metadata1": "freeSpace1",
- "metadata2": "freeSpace2"
}, - "provider": {
- "payment": {
- "providerOrderId": "XXX00000000001",
- "gatewayOrderId": "00000000000000000001",
- "inquiryCode": "inquiryCode12345"
}
}, - "customer": {
- "buyer": {
- "customerId": "b613865a-6f72-af74-772d-02279b929876"
}
}
}加盟店⇒Unified API
paymentId指定 (object) or fepOrderId指定 (object) (Order) | |
object (transaction) | |
object (control) |
{- "order": {
- "paymentId": "paymentId_1234567890"
}, - "transaction": {
- "merchantRequestKey1": "freeKey1",
- "merchantRequestKey2": "freeKey2",
- "metadata1": "freeSpace1",
- "metadata2": "freeSpace2"
},
}{- "result": {
- "status": "success",
- "actionCode": "success",
- "resultCode": "UA-000-001",
- "message": "success",
- "vResultCode": "1001000000000000"
}, - "order": {
- "paymentId": "paymentId_1234567890",
- "fepOrderId": "paymentId_1234567890_01AHK4HS7GFKHGKE7SGFJKTHIH"
}, - "transaction": {
- "fepReferenceId": "X01AHK4HS7GFKHGKE7SGFJKTHIH",
- "transactionDatetime": "20230526123456",
- "merchantRequestKey1": "freeKey1",
- "merchantRequestKey2": "freeKey2",
- "metadata1": "freeSpace1",
- "metadata2": "freeSpace2"
}, - "provider": {
- "payment": {
- "providerOrderId": "XXX00000000001"
}
}
}| フィールド名 | 設定 | 書式・制限 | 説明 |
| Content-Type | 必須 | 右記の通り | application/json |
| X-VT-webhook-id | 必須 | 半角英数字記号 |
VeriTrans4G Unified APIで新規採番した通知の識別ID。 記号は-(ハイフン)、_(アンダースコア)。 |
| X-VT-Content-hmac | 必須 | 右記の通り |
h=HmacSHA512;s={マーチャントCCID};v={hmacString} {マーチャントCCID}{hmacString} については「決済リクエストの認証について」を参照してください。 |
Content-Type: application/json
X-VT-webhook-id: 01HG79DYJS6MJBN8BRS0HAQ38X
X-VT-Content-hmac: h=HmacSHA512;s=MerchantCcId;v=915dd44f78777da61c26e683ae63cdf3aee72a212596ffc7fa4c0833dd224374
| API | command※1 | PayPay | 楽天ペイ | ドコモ | au | メルペイ |
| 決済申込※2 | pay | 取引成功 | 取引成功 | 取引成功 | 取引成功 | 取引成功 |
| 申込変更 | updateOrder | - | 全てのステータス | - | 全てのステータス | - |
| 売上 | capture | 全てのステータス | 全てのステータス | 全てのステータス | 全てのステータス | 全てのステータス |
| キャンセル | cancel | 全てのステータス | 全てのステータス | 全てのステータス | 全てのステータス | 全てのステータス |
| 随時支払 | charge | 全てのステータス※3 | 全てのステータス | 全てのステータス | 全てのステータス | 全てのステータス |
| 解約 | terminate | 全てのステータス | - | 全てのステータス | 全てのステータス | 全てのステータス |
| 抹消通知※4 | deregistraction | 決済事業者からの通知時 | - | 決済事業者からの通知時 | 決済事業者からの通知時 | 決済事業者からの通知時 |
※1 通知内容のTransactionブロックcommandパラメータ
※2 決済申込については消費者による決済事業者との支払い・申込みが完了後に実施されます。
※3 resultCode=UA-U00-001で通知された後、消費者操作により取引が成立した場合は、resultCode=UA-000-001となるWebhookを追加で通知します。
※4 随時決済の解約が決済事業者側で実施された場合に、決済事業者から契約の抹消について通知が発生します。
FEPサーバでは該当の抹消通知を受信したタイミングで加盟店様に結果を通知します。
Unified API⇒加盟店
object (result) | |
object (order) | |
object (transaction) | |
object (control) | |
object (provider) | |
object (customer) | |
object (paymentInstrument) |
{- "result": {
- "status": "success",
- "actionCode": "success",
- "resultCode": "UA-000-001",
- "message": "success",
- "vResultCode": "1001000000000000"
}, - "order": {
- "payType": "paypay",
- "paymentId": "paymentId_1234567890",
- "fepOrderId": "paymentId_1234567890_01AHK4HS7GFKHGKE7SGFJKTHIH",
- "originalPaymentId": "orgPaymentId_1234567890",
- "originalFepOrderId": "orgPaymentId_1234567890_01AHK4HS7GFKHGKE7SGFJKTHIH",
- "amount": "10000",
- "usedPoint": "0",
- "cancelExpirationDatetime": "20230526123456",
- "captureExpirationDatetime": "20230526123456",
- "updateExpirationDatetime": "20230526123456",
- "extendAuthExpirationDatetime": "20230526123456"
}, - "transaction": {
- "fepReferenceId": "X01AHK4HS7GFKHGKE7SGFJKTHIH",
- "command": "pay",
- "transactionDatetime": "20230526123456",
- "merchantRequestKey1": "freeKey1",
- "merchantRequestKey2": "freeKey2",
- "metadata1": "freeSpace1",
- "metadata2": "freeSpace2"
}, - "control": {
- "requestMode": "sandbox"
}, - "provider": {
- "result": {
- "providerErrorInfo": [
- "payment_error",
- "invalid_point"
]
}, - "payment": {
- "providerOrderId": "XXX00000000001",
- "gatewayOrderId": "00000000000000000001",
- "inquiryCode": "inquiryCode12345",
- "preapprovalId": "preapprovalId1234567890"
}
}, - "customer": {
- "buyer": {
- "nickname": "nick",
- "phoneNumber": 9012341234,
- "email": "customer.buyer.email@example.com",
- "customerId": "b613865a-6f72-af74-772d-02279b929876"
}, - "shipping": {
- "familyName": "山田",
- "firstName": "太郎",
- "familyNameKana": "ヤマダ",
- "firstNameKana": "タロウ",
- "phoneNumber": "0312341234",
- "zipCode1": "150",
- "zipCode2": "0022",
- "preference": "東京都",
- "city": "渋谷区",
- "address1": "恵比寿南3丁目",
- "address2": "5番地7号 デジタルゲートビル10F"
}
}, - "paymentInstrument": {
- "rakuten": {
- "card3ds": "used",
- "cardCvc": "used",
- "cardInstallments": 1,
- "cardBrand": "JCB",
- "cardLast4": "1234"
}
}
}| 契機 | 条件 |
|---|---|
| 決済申込実施後 | 消費者ブラウザから店舗側の完了画面へのリダイレクトを受信するまでの間 |
| 随時支払実施後 | 支払結果が「UA-U00-001(user_paying)」の場合に、対応するWebhookを受信するまでの間 |
加盟店⇒Unified API
object (transaction) |
{- "transaction": {
- "fepReferenceId": "X01AHK4HS7GFKHGKE7SGFJKTHIH"
}
}{- "result": {
- "status": "success",
- "actionCode": "success",
- "resultCode": "UA-000-001",
- "message": "success"
}, - "transactionData": {
- "result": {
- "status": "success",
- "actionCode": "success",
- "resultCode": "UA-000-001",
- "message": "success",
- "vResultCode": "1001000000000000"
}, - "order": {
- "payType": "paypay",
- "paymentId": "paymentId_1234567890",
- "fepOrderId": "paymentId_1234567890_01AHK4HS7GFKHGKE7SGFJKTHIH",
- "originalPaymentId": "orgPaymentId_1234567890",
- "originalFepOrderId": "orgPaymentId_1234567890_01AHK4HS7GFKHGKE7SGFJKTHIH",
- "amount": "1000",
- "usedPoint": "0",
- "cancelExpirationDatetime": "20230526123456",
- "captureExpirationDatetime": "20230526123456",
- "updateExpirationDatetime": "20230526123456",
- "extendAuthExpirationDatetime": "20230526123456"
}, - "transaction": {
- "fepReferenceId": "X01AHK4HS7GFKHGKE7SGFJKTHIH",
- "command": "pay",
- "transactionDatetime": "20230526123456",
- "merchantRequestKey1": "freeKey1",
- "merchantRequestKey2": "freeKey2",
- "metadata1": "freeSpace1",
- "metadata2": "freeSpace2"
}, - "control": {
- "requestMode": "sandbox"
}, - "provider": {
- "result": {
- "providerErrorInfo": [
- "payment_error",
- "invalid_point"
]
}, - "payment": {
- "providerOrderId": "XXX00000000001",
- "gatewayOrderId": "00000000000000000001",
- "inquiryCode": "inquiryCode12345",
- "preapprovalId": "preapprovalId1234567890"
}
}, - "customer": {
- "buyer": {
- "customerId": "b613865a-6f72-af74-772d-02279b929876"
}
}, - "paymentInstrument": {
- "rakuten": {
- "card3ds": "used",
- "cardCvc": "used",
- "cardInstallments": 1,
- "cardBrand": "JCB",
- "cardLast4": "1234"
}
}
}
} VeriTrans4G Unified APIではSandbox環境とLive環境を提供します。
※各環境のリクエスト先URLについては「HTTPリクエスト詳細」を参照してください。
Sandbox環境では決済事業者と接続せずに取引をテストすることができ、
また各APIで金額等を特定の値に設定することで失敗取引のシミュレーションも可能です。
Sandbox環境で確認されたあとは、Live環境にて実際に決済事業者と接続したテストを実施し、決済事業者の振る舞いを確認してください。
なおSandbox環境では決済事業者が設定する項目にはダミー値が設定され、動作もダミー用の簡易なものとなりますので、
加盟店様のリリースまでには必ずLive環境にてテストを実施し実際の値・動作を確認してください。
テスト時に利用するマーチャントIDについては、各加盟店に発行されたIDをご利用ください。
ご契約前の利用については、必要に応じてお問い合わせください。
決済申込(都度決済)
決済申込のリクエスト金額(amount)の下一桁の値を調整することで、意図的にエラーを発生させることができます。
金額の下一桁と、返戻されるresultCode、vResultCodeの対応表を以下に記載します。
| 金額の下一桁 | 決済申込 | |
| resultCode | vResultCode | |
| 0 | UA-000-001(成功) | 1001 |
| 1 | ||
| 2 | ||
| 3 | ||
| 4 | ||
| 5 | ||
| 6 | ||
| 7 | ||
| 8 | UA-PRV-001(失敗) | 1GD1 |
| 9 | UA-000-001(成功) | 1001 |
随時申込(随時決済)
随時決済の決済申込のテストリクエストはすべて決済成功となります。
決済申込の結果として返戻されたredirectUrlでリダイレクト指示すると、以下のダミー環境に自動的に遷移します。
※ダミーPayPayの画面イメージについては、PayPayの仕様に伴い変更となる可能性があります。
その他API
売上、キャンセル、随時支払のリクエスト金額(amount)の下一桁の値を調整することで、
意図的にエラーを発生させることができます。
金額の下一桁と、返戻されるresultCode、vResultCodeの対応表を以下に記載します。
| 金額の 下一桁 |
売上 | キャンセル | 随時支払 | |||
| resultCode | vResult Code |
resultCode | vResult Code |
resultCode | vResult Code |
|
| 0 | UA-000-001(成功) | 1001 | UA-000-001(成功) | 1001 | UA-000-001(成功) | 1001 |
| 1 | UA-PRV-001(失敗) | 1GD2 | ||||
| 2 | UA-PND-001(失敗) | 1E50 | ||||
| 3 | UA-PRV-001(失敗) | 1GD5 | UA-000-001(成功) | 1001 | UA-PRV-001(失敗) | 1GD6 |
| 4 | UA-PND-001(失敗) | 1E50 | UA-PND-001(失敗) | 1E50 | ||
| 5 | UA-000-001(成功) | 1001 | UA-CST-001(失敗) | 1G02※1 | ||
| UA-U00-001(成功) | 1G21※2 | |||||
| 6 | UA-000-001(成功) | 1001 | ||||
| 7 | ||||||
| 8 | ||||||
| 9 | ||||||
決済申込(都度決済)
決済申込のリクエスト金額(amount)の下一桁の値を調整することで、意図的にエラーを発生させることができます。
金額の下一桁と、返戻されるresultCode、vResultCodeの対応表を以下に記載します。
| 金額の下一桁 | 決済申込 | |
| resultCode | vResultCode | |
| 0 | UA-000-001(成功) | F001 |
| 1 | UA-PRV-999(失敗) | FG90 |
| 2 | UA-PRV-001(失敗) | FG24 |
| 3 | UA-000-001(成功) | F001 |
| 4 | ||
| 5 | ||
| 6 | ||
| 7 | ||
| 8 | ||
| 9 | ||
| 決済結果選択 | リダイレクト | |
| resultCode | vResultCode | |
| 成功 | UA-000-001(成功) | F001 |
| 中断 | UA-PND-001(失敗) | FED1 |
| 失敗(ポイント不正) | - | FG11※ |
| 失敗(決済失敗) | UA-PRV-001(失敗) | FG24 |
| 失敗(メンテナンス中) | UA-PRV-999(失敗) | FG90 |
随時申込(随時決済)
随時申込のリクエストitem[] 配下の(name)の値で、意図的にエラーを発生させることができます。
| name | 決済申込 | |
| resultCode | vResultCode | |
| fail | UA-PRV-999(失敗) | FG90 |
| 上記以外 | UA-000-001(成功) | F001 |
| 申込結果選択 | リダイレクト | |
| resultCode | vResultCode | |
| 成功 | UA-000-001(成功) | F001 |
| 中断 | UA-PND-001(失敗) | FED1 |
| 失敗(承諾期限超過) | UA-REQ-006(失敗) | FG26 |
その他API
売上、キャンセル、申込変更、随時支払のリクエスト金額(amount)の下一桁の値を調整することで、
意図的にエラーを発生させることができます。
金額の下一桁と、返戻されるresultCode、vResultCodeの対応表を以下に記載します。
| 金額の 下一桁 |
売上 | キャンセル | 申込変更 | 随時支払 | ||||||||||
| 全額売上 | 部分売上 | 与信延長 | 金額変更 | 与信延長 + 金額変更 | ||||||||||
| resultCode | vResult Code |
resultCode | vResult Code |
resultCode | vResult Code |
resultCode | vResult Code |
resultCode | vResult Code |
resultCode | vResult Code |
resultCode | vResult Code |
|
| 0 | UA-000-001(成功) | F001 | UA-000-001(成功) | F001 | UA-000-001(成功) | F001 | UA-000-001(成功) | F001 | UA-000-001(成功) | F001 | UA-000-001(成功) | F001 | UA-000-001(成功) | F001 |
| 1 | UA-PRV-999(失敗) | FG90 | UA-PND-001(失敗) | FED1 | UA-PRV-999(失敗) | FG90 | UA-PRV-999(失敗) | FG90 | ||||||
| 2 | UA-PND-001(失敗) | FED1 | UA-PND-001(失敗) | FED1 | UA-PRV-999(失敗) | FG90 | UA-000-001(成功) | F001 | UA-PND-001(失敗) | FED2 | UA-PND-001(失敗) | FED2 | ||
| 3 | UA-PRV-001(失敗) | FG30 | UA-PND-001(失敗) | FED2 | UA-000-001(成功) | F001 | ||||||||
| 4 | UA-000-001(成功) | F001 | UA-000-001(成功) | F001 | UA-000-001(成功) | F001 | UA-000-001(成功) | F001 | UA-000-001(成功) | F001 | UA-PND-001(失敗) | FED1 | ||
| 5 | UA-PND-001(失敗) | FED1 | UA-PND-001(失敗) | FED2 | UA-PND-001(失敗) | FED2 | UA-PRV-001(失敗) | FG30 | ||||||
| 6 | UA-PRV-001(失敗) | FG30 | UA-PRV-001(失敗) | FG30 | UA-PRV-001(失敗) | FG30 | UA-PRV-999(失敗) | FG90 | ||||||
| 7 | UA-000-001(成功) | F001 | UA-REQ-006(失敗) | FG26 | UA-000-001(成功) | F001 | UA-PND-001(失敗) | FED2 | UA-PND-001(失敗) | FED2 | UA-PRV-001(失敗) | FG24 | ||
| 8 | UA-REQ-006(失敗) | FG26 | UA-PRV-001(失敗) | FG29 | UA-PND-001(失敗) | FED1 | UA-REQ-006(失敗) | FG26 | UA-PRV-001(失敗) | FG29 | ||||
| 9 | UA-PRV-001(失敗) | FG30 | UA-000-001(成功) | F001 | UA-PRV-001(失敗) | FG30 | UA-PND-001(失敗) | FED1 | ||||||
決済申込(都度決済)
都度決済申込の結果として返戻されたredirectUrlでリダイレクト指示すると、以下のダミー環境に自動的に遷移します。
※ダミーd払いの画面イメージについては、d払いの仕様に伴い変更となる可能性があります。
お支払い方法の選択画面や決済内容確認画面にて「購入中止」を選択することで、リダイレクトの結果が変更されます。
| name | 決済申込 | |
| resultCode | vResultCode | |
| 購入中止 | UA-CST-002(失敗) | WGU1 |
| 上記以外 | UA-000-001(成功) | W001 |
随時申込(随時決済)
随時申込の結果として返戻されたredirectUrlでリダイレクト指示すると、以下のダミー環境に自動的に遷移します。
※ダミーd払いの画面イメージについては、d払いの仕様に伴い変更となる可能性があります。
お支払い方法の選択画面や決済内容確認画面等にて「購入中止」を選択することで、リダイレクトの結果が変更されます。
| name | 決済申込 | |
| resultCode | vResultCode | |
| 購入中止 | UA-CST-002(失敗) | WGU1 |
| 上記以外 | UA-000-001(成功) | W001 |
その他API
売上、キャンセル、随時支払のリクエスト金額(amount)の下一桁の値を調整することで、
意図的にエラーを発生させることができます。
金額の下一桁と、返戻されるresultCode、vResultCodeの対応表を以下に記載します。
| 金額の 下1桁 |
売上 | キャンセル | 随時支払 | |||
| resultCode | vResultCode | resultCode | vResultCode | resultCode | vResultCode | |
| 0 | UA-000-001(成功) | W001 | UA-000-001(成功) | W001 | UA-000-001(成功) | W001 |
| 1 | ||||||
| 2 | UA-PRV-001(失敗) | WG02 | ||||
| 3 | UA-PRV-001(失敗) | WG02 | UA-000-001(成功) | W001 | ||
| 4 | UA-000-001(成功) | W001 | UA-PRV-001(失敗) | WA02 | ||
| 5 | UA-CST-001(失敗) | WG12 | ||||
| 6 | UA-SYS-002(失敗) | WG05 | ||||
| 7 | UA-PRV-001(失敗) | WG02 | ||||
| 8 | UA-CST-001(失敗) | WG04 | ||||
| 9 | UA-000-001(成功) | W001 | ||||
決済申込(都度決済)
決済申込のリクエスト金額(amount)の下一桁の値を調整することで、意図的にエラーを発生させることができます。
金額の下一桁と、返戻されるresultCode、vResultCodeの対応表を以下に記載します。
| 金額の下1桁 | resultCode | vResultCode |
| 0 | UA-000-001(成功) | W001 |
| 1 | ||
| 2 | ||
| 3 | ||
| 4 | ||
| 5 | UA-PRV-001(失敗) | WG02 |
| 6 | UA-CST-001(失敗) | WG04 |
| 7 | UA-PRV-001(失敗) | WG02 |
| 8 | UA-CST-001(失敗) | WG04 |
| 9 | UA-000-001(成功) | W001 |
| name | 決済申込 | |
| resultCode | vResultCode | |
| キャンセル | UA-CST-002(失敗) | WGU1 |
| 上記以外 | UA-000-001(成功) | W001 |
随時申込(随時決済)
随時申込の結果として返戻されたredirectUrlでリダイレクト指示すると、以下のダミー環境に自動的に遷移します。
※auPAY(auかんたん決済)およびauPAY(ネット支払い)のダミー画面イメージについては、auの仕様に伴い変更となる可能性があります。
お支払い方法の選択画面や決済内容確認画面にて「キャンセル」を選択することで、リダイレクトの結果が変更されます。
| name | 決済申込 | |
| resultCode | vResultCode | |
| キャンセル | UA-CST-002(失敗) | WGU1 |
| 上記以外 | UA-000-001(成功) | W001 |
その他API
売上、キャンセル、申込変更、随時支払のリクエスト金額(amount)の下一桁の値を調整することで、
意図的にエラーを発生させることができます。
金額の下一桁と、返戻されるresultCode、vResultCodeの対応表を以下に記載します。
| 金額の 下1桁 |
売上 | キャンセル | 申込変更 | 随時支払 | ||||
| resultCode | vResultCode | resultCode | vResultCode | resultCode | vResultCode | resultCode | vResultCode | |
| 0 | UA-000-001(成功) | W001 | UA-000-001(成功) | W001 | UA-000-001(成功) | W001 | UA-000-001(成功) | W001 |
| 1 | UA-CST-001(失敗) | WG04 | ||||||
| 2 | UA-PRV-001(失敗) | WG02 | UA-CST-001(失敗) | WG35 | ||||
| 3 | UA-000-001(成功) | W001 | UA-PRV-001(失敗) | WG02 | UA-000-001(成功) | W001 | ||
| 4 | UA-000-001(成功) | W001 | ||||||
| 5 | - | - | UA-PRV-001(失敗) | WG02 | ||||
| 6 | UA-CST-001(失敗) | WG04 | ||||||
| 7 | UA-PRV-001(失敗) | WG02 | ||||||
| 8 | UA-CST-001(失敗) | WG04 | ||||||
| 9 | UA-000-001(成功) | W001 | UA-000-001(成功) | W001 | ||||
決済申込(都度決済)
決済申込のリクエスト金額(amount)の下一桁の値を調整することで、意図的にエラーを発生させることができます。
金額の下一桁と、返戻されるresultCode、vResultCodeの対応表を以下に記載します。
| 金額の下1桁 | resultCode | vResultCode |
| 0 | UA-000-001(成功) | K001 |
| 1 | UA-PRV-001(失敗) | KG10 |
| 2 | UA-000-001(成功) | K001 |
| 3 | ||
| 4 | ||
| 5 | ||
| 6 | ||
| 7 | UA-PRV-999(失敗) | KG11 |
| 8 | UA-000-001(成功) | K001 |
| 9 |
決済申込の結果として返戻されたredirectUrlでリダイレクト指示すると、以下のダミー環境に自動的に遷移します。
※ダミーメルペイの画面イメージについては、メルペイの仕様に伴い変更となる可能性があります。
決済画面にてチェックボックスとボタンの組み合わせを選択することで、リダイレクトの結果が変更されます。
| アクセス許可画面 | 決済内容画面 | resultCode | vResultCode | |
| ボタン | チェックボックス | |||
| 許可する | 支払う | 成功 | UA-000-001 | K001 |
| みなし成功(メルカリからの結果通知を受信しない) | K003 | |||
| みなし成功(決済確定処理でエラー) | K003 | |||
| 失敗(リダイレクトでエラー※結果通知は成功) | K001 | |||
| キャンセル | -(失敗以外) | UA-CST-001 | KGU1 | |
| 失敗(リダイレクトでエラー※結果通知は成功) | UA-000-001 | K001 | ||
| キャンセル | - | UA-CST-001 | KGU1 | |
随時申込(随時決済)
随時申込の結果として返戻されたredirectUrlでリダイレクト指示すると、以下のダミー環境に自動的に遷移します。
※ダミーメルペイの画面イメージについては、メルペイの仕様に伴い変更となる可能性があります。
決済画面にてチェックボックスとボタンの組み合わせを選択することで、リダイレクトの結果が変更されます。
組み合わせおよび返戻値は都度決済と同様です。
その他API
売上、キャンセル、申込変更、随時支払のリクエスト金額(amount)の下一桁の値を調整することで、
意図的にエラーを発生させることができます。
金額の下一桁と、返戻されるresultCode、vResultCodeの対応表を以下に記載します。
| 金額の 下1桁 |
売上 | キャンセル | 随時支払 | |||||
| 売上前 | 売上後 | |||||||
| resultCode | vResultCode | resultCode | vResultCode | resultCode | vResultCode | resultCode | vResultCode | |
| 0 | UA-000-001(成功) | K001 | UA-000-001(成功) | K001 | UA-000-001(成功) | K001 | UA-000-001(成功) | K001 |
| 1 | - | - | UA-PRV-001(失敗) | KG10 | UA-PRV-001(失敗) | KG10 | ||
| 2 | UA-000-001(成功) | K001 | UA-PND-001(失敗) | KED1 | UA-000-001(成功) | K001 | ||
| 3 | UA-000-001(成功) | K001 | UA-PRV-002(失敗) | KG19 | ||||
| 4 | UA-CST-001(失敗) | KG15 | ||||||
| 5 | UA-PRV-001(失敗) | KG10 | UA-PRV-001(失敗) | KG10 | UA-000-001(成功) | K001 | ||
| 6 | UA-PND-001(失敗) | KED1 | UA-PND-001(失敗) | KED1 | ||||
| 7 | UA-000-001(成功) | K001 | - | - | UA-PRV-999(失敗) | KG11 | UA-PRV-999(失敗) | KG11 |
| 8 | UA-PRV-999(失敗) | KG11 | UA-PRV-999(失敗) | KG11 | UA-000-001(成功) | K001 | UA-000-001(成功) | K001 |
| 9 | UA-000-001(成功) | K001 | UA-000-001(成功) | K001 | ||||
| バージョン | リリース年月 | 更新内容 |
| 1.0.0 β | 2023/12 | 新規作成 |
| 1.0.0 RC | 2024/08 |
|
| 1.0.1 RC | 2024/12 |
|
| 1.1.0 RC | 2025/06 |
|
| 1.1.1 RC | 2025/09 |
|