VeriTrans4G Unified API (1.1.1 RC)

Download OpenAPI specification:Download

お知らせ

【重要】接続先ドメイン変更について

現行のドメイン(旧ドメイン)の利用は2025年7月末で終了となります。
2025年8月からは新ドメインの利用をお願い致します。
※現行ドメイン(旧ドメイン)をご利用の加盟店様はお手数をおかけしますが、8月中に新ドメインに移行くださいますようお願いいたします。
※新旧ドメインについては「HTTPリクエスト詳細」を参照してください。

概要

導入


VeriTrans4G Unified APIはECサイト等でのオンライン決済におけるシンプルなインターフェースを提供します。
本ガイドは各種APIを利用してオンライン決済を導入するための開発者向けのガイドです。
以下の決済タイプでのオンライン決済をサポートしており、今後も対応する決済タイプを追加予定です。

  1. PayPay
  2. 楽天ペイ
  3. ドコモ(d払い)
  4. au(auPAY(auかんたん決済)、auPAY(ネット支払い))
  5. メルペイ

決済方式


VeriTrans4G Unified APIでは都度決済と随時決済の2つの決済方式を提供します。
それぞれの違いについて以下に記載します。

決済方式 説明
都度決済 商品購入の支払い毎に決済申込を実施する方式。
随時決済 加盟店様と消費者の継続的な利用について随時申込
承諾していただき、商品などの提供状況に応じて随時支払
にて都度課金する方式。
随時申込にて承諾した取引を「元取引」と呼称します。


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
  1. PayPayとの直接接続のみ提供します。
  2. 都度決済のみ。

決済シーケンス


  1. 加盟店サイトは決済申込コマンドをVeriTrans4G Unified APIのサーバ(以下FEPサーバ)に送信し、FEPサーバはリダイレクトURLを返却します。
  2. 加盟店サイトは消費者ブラウザに受け取ったリダイレクトURLへのリダイレクト指示を行います。
  3. リダイレクトを契機にFEPサーバ、GWサーバ、決済事業者、消費者ブラウザにて認証及び決済処理等が実行されます。
  4. FEPサーバが取引結果をWebhookコマンドで加盟店サイトに送信するとともに、消費者ブラウザに加盟店サイトへのリダイレクト指示を行います。
  5. リダイレクトコマンドを受け取った加盟店サイトはFEPサーバに取引結果取得コマンドを送信して、取引結果の詳細を取得し、消費者ブラウザに決済申込結果を表示します。
    (リダイレクトコマンドで返される取引結果は概要の情報で詳細情報はWebhookコマンドもしくは取引結果取得コマンドのいずれかで取得してください)
  6. 随時申込コマンドで申込同時売上タイプ(authCaptureType)を申込のみとしている場合、申込変更コマンドをFEPサーバに送信して、売上前の取引の決済金額等を変更できます。
  7. 決済申込コマンドで申込同時売上タイプ(authCaptureType)を申込のみとしている場合、別途、売上コマンドをFEPサーバに送信して、売上確定を行います。
  8. 与信状態、売上状態の取引をキャンセルする場合はFEPサーバにキャンセルコマンドを送信します。

都度決済

  1. 加盟店サイトは随時申込コマンドをVeriTrans4G Unified APIのサーバ(以下FEPサーバ)に送信し、FEPサーバはリダイレクトURLを返却します。
  2. 加盟店サイトは消費者ブラウザに受け取ったリダイレクトURLへのリダイレクト指示を行います。
  3. リダイレクトを契機にFEPサーバ、GWサーバ、決済事業者、消費者ブラウザにて認証及び決済処理等が実行されます。
  4. FEPサーバが取引結果をWebhookコマンドで加盟店サイトに送信するとともに、消費者ブラウザに加盟店サイトへのリダイレクト指示を行います。
  5. リダイレクトコマンドを受け取った加盟店サイトはFEPサーバに取引結果取得コマンドを送信して、取引結果の詳細を取得し、消費者ブラウザに決済申込結果を表示します。
    (リダイレクトコマンドで返される取引結果は概要の情報で詳細情報はWebhookコマンドもしくは取引結果取得コマンドのいずれかで取得してください)
  6. 随時取引を解約したい場合は、FEPサーバに解約コマンドを送信します。これを行うことで、以降の随時支払が行えなくなります。
  7. 決済タイプによっては、随時決済の解約が決済事業者側で実施された場合に、決済事業者から契約の抹消について通知が発生する場合があります。
    FEPサーバでは該当の抹消通知を受信したタイミングでWebhookコマンドで加盟店サイトへ送信します。

随時決済(随時申込)

  1. 随時申込にて承諾する。
  2. 随時申込にて承諾した取引を「元取引」として、随時支払を行い課金します。
  3. 随時申込コマンドで申込同時売上タイプ(authCaptureType)を申込のみとしている場合、申込変更コマンドをFEPサーバに送信して、売上前の取引の決済金額等を変更できます。
  4. 随時申込コマンドで申込同時売上タイプ(authCaptureType)を申込のみとしている場合、別途、売上コマンドをFEPサーバに送信して、売上確定を行います。
  5. 与信状態、売上状態の取引をキャンセルする場合はFEPサーバにキャンセルコマンドを送信します。

随時決済(随時支払)

決済フロー


決済ライフサイクル


VeriTrans4G Unified APIにて提供する都度決済および随時決済における
それぞれのライフサイクルについて以下に記載します。
なお、pay失敗時だけでなくcharge失敗時にも同一paymentIdでのリトライが可能です。

APIについて

HTTPリクエスト詳細


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

 ※各環境の詳細については「稼働確認」を参照してください。


ポート番号
 443

プロトコル
 SSL/TLS     TLS1.2以上


リクエストヘッダ

フィールド名 設定 書式・制限 説明
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認証として処理します。
それぞれの認証方式に関しては以下をご確認ください。

Bearer認証について

{token}はMAPにて取得(生成)します。期限内のトークンをリクエストヘッダに指定してください。
※MAP画面上の「Unified API」アイコンをクリックし、「Bearer認証設定」からご確認いただけます。
※「Unified API」アイコンはUnified API未契約のマーチャントIDでログインした場合は、非表示となります。



HMAC認証について

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」部分は実際の値に読み替えて生成するようご注意ください。

マーチャントCCID, マーチャント認証鍵はAPI設定情報からご確認いただけます。



冪等性について


リクエスト時に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のリクエスト単位で保持されるため、過去の設定内容の更新・削除はできません。

  • merchantRequestKey1
  • merchantRequestKey2
  • metadata1
  • metadata2

対象の項目について、FEPサーバで保存する際に暗号化は行っておりませんので、
個人情報などは設定しないようにご注意ください。

取引に関する各種IDについて


paymentId

VeriTrans4G Unified APIにおいて、取引を一意に判定するためのIDです。
申込処理毎に他のpaymentIdと重複しないよう、加盟店様で任意に採番してください。他決済タイプとも重複できません。
取引が成功するまでの間は、同一IDで再度リクエストが可能となります。
再リクエストについては、決済ライフサイクルを参照してください。
ただし、取引の成否が未確定の状態で同じpaymentIdで取引を実施された場合は、同一paymentIdで複数の決済が成立する可能性があることに注意してください。
その場合片方の取引に対してUA-000-002が返却されます。MAPなどでUA-000-002が生じた場合はお客様の決済状況を確認するようにしてください。
Sandbox環境で使用したpaymentIdを、Live環境で再度使用することはできません。
paymentIdには、半角英数字以外に-(ハイフン)、_(アンダースコア)も使用可能です。

fepOrderId

VeriTrans4G Unified APIでは決済申込リクエスト時に設定していただいたpaymentIdを元に、決済サーバと連携するID(fepOrderId)を別途採番します。
当IDは、決済申込後のリダイレクトやWebhookにて返戻し、決済申込以外のAPIリクエストやお問い合わせ時にpaymentIdの代わりとして使用するためのIDです。
なお採番体系は以下の通りです。
paymentId + _ + 26~35バイトのランダム文字列
例) paymentId:id123456789のとき、fepOrderId:id123456789_01AHK4HS7GFKHGKE7SGFJKTHIH

※MAPでの取引検索時にはpaymentIdは使用できず、fepOrderIdでのみ検索が可能です。

originalPaymentId

随時支払時、決済に紐づく元取引(随時申込の取引)のID(paymentId)です。
随時決済の決済申込時に指定したIDを設定してください。

originalFepOrderId

随時支払時、決済に紐づく元取引(随時申込の取引)のID(fepOrderId)です。
随時決済の決済申込時にorderで返戻されたfepOrderIdを指定してください。

fepReferenceId

FEPサーバでリクエスト毎に新規採番されたIDです。
取引結果取得APIで使用することができます。

日時について


VeriTrans4G Unified APIで取り扱う日時について、特記がない場合は「JST (日本標準時) (GMT + 9)」となります。

リダイレクト受信時の検証について


電文の改ざん検知のため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は、結果コードの説明が英語表記で設定されます。言語の切り替えは行えませんのでご留意ください。


APIs

決済申込

PayPay 楽天ペイ ドコモ au メルペイ


決済の申込み(オーソリ)を行います。リクエスト項目の設定によって、申込同時売上も可能です。
決済フロー」では決済申込が完了するまでを記述しています。その際にどのAPIを使用するかは[ ]内に記載しています。
Request Body schema: application/json

加盟店⇒Unified API

required
object (order)
object (transaction)
Array of objects (item)
object (merchant)
object (customer)
required
object (control)
object (paymentInstrument)

Responses

Request samples

Content type
application/json
{
  • "order": {
    },
  • "transaction": {
    },
  • "item": [
    ],
  • "merchant": {
    },
  • "customer": {
    },
  • "control": {},
  • "paymentInstrument": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "order": {
    },
  • "transaction": {
    },
  • "control": {}
}

随時申込

PayPay 楽天ペイ ドコモ au メルペイ


随時決済の申込みを行います。
決済フロー」では随時申込が完了するまでを記述しています。その際にどのAPIを使用するかは[ ]内に記載しています。
Request Body schema: application/json

加盟店⇒Unified API

required
object (order)
object (transaction)
Array of objects (item)
object (merchant)
object (customer)
required
object (control)
object (paymentInstrument)

Responses

Request samples

Content type
application/json
{
  • "order": {
    },
  • "transaction": {
    },
  • "item": [
    ],
  • "merchant": {
    },
  • "customer": {
    },
  • "control": {},
  • "paymentInstrument": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "order": {
    },
  • "transaction": {
    },
  • "control": {}
}

リダイレクト

PayPay 楽天ペイ ドコモ au メルペイ


消費者ブラウザから店舗側の完了画面へリダイレクトする際のクエリパラメータとなります。
加盟店様からリクエストすることはできません。
リダイレクトでは取引結果および取引を特定するための情報のみ連携します。
詳細情報については、成功時はWebhookで確認が可能です。また取引結果取得APIでも取得できます。
処理タイミングについては「決済フロー」の決済申込タブまたは随時申込タブのフローを御参照ください。
なお、消費者の操作や利用ブラウザの仕様で同じ内容のリクエストが複数回行われる可能性がございます。
処理済のリクエストが再度届くケースは想定して実装してください。
また、リダイレクトの受信の際には電文の改ざん検知のためその都度検証を行うようお願いします。
詳細につきましては、「リダイレクト受信時の検証について」をご参照ください。


Unified API⇒(消費者ブラウザ⇒)加盟店
query Parameters
status
string <= 10 characters 半角英数字
Example: status=success
PayPay 楽天ペイ ドコモ au メルペイ


取引結果のステータス。

詳細は「取引結果について」のステータスを参照してください。
actionCode
string <= 64 characters 半角英数字記号
Example: actionCode=success
PayPay 楽天ペイ ドコモ au メルペイ


加盟店様の行動の指針となるアクションコード。
記号は-(ハイフン)、_(アンダースコア)。
resultCode
string <= 10 characters 半角英数字記号
Example: resultCode=UA-000-001
PayPay 楽天ペイ ドコモ au メルペイ


取引結果の具体的な理由を示す結果コード。
記号は-(ハイフン)、_(アンダースコア)。
command
string <= 20 characters 半角英数字記号
Example: command=pay
PayPay 楽天ペイ ドコモ au メルペイ


リダイレクトの起因コマンド。
記号は-(ハイフン)、_(アンダースコア)。
paymentId
string <= 64 characters 半角英数字記号
Example: paymentId=paymentId_1234567890
PayPay 楽天ペイ ドコモ au メルペイ


対象取引に紐づくpaymentId。
fepOrderId
string <= 100 characters 半角英数字記号
Example: fepOrderId=paymentId_1234567890_01AHK4HS7GFKHGKE7SGFJKTHIH
PayPay 楽天ペイ ドコモ au メルペイ


対象取引に紐づくfepOrderId。
記号は-(ハイフン)、_(アンダースコア)。
fepReferenceId
string <= 100 characters 半角英数字記号
Example: fepReferenceId=X01AHK4HS7GFKHGKE7SGFJKTHIH
PayPay 楽天ペイ ドコモ au メルペイ


対象取引に紐づくfepReferenceId。
記号は-(ハイフン)、_(アンダースコア)。
merchantRequestKey1
string <= 100 characters 半角英数字記号
Example: merchantRequestKey1=freeKey1
PayPay 楽天ペイ ドコモ au メルペイ


決済申込時に設定された内容。
※リクエスト時に未設定の場合は返戻されません。
merchantRequestKey2
string <= 100 characters 半角英数字記号
Example: merchantRequestKey2=freeKey2
PayPay 楽天ペイ ドコモ au メルペイ


決済申込時に設定された内容。
※リクエスト時に未設定の場合は返戻されません。
vAuthInfo
string <= 4000 characters
PayPay 楽天ペイ ドコモ au メルペイ


下記文字列を順番に区切り文字なしで連結し、「SHA512」 によって算出したハッシュ値
1.マーチャント CCID
2.パラメータ値の連結文字列(authParams が示す順序で連結)
3.マーチャント認証鍵
尚、パラメータ値を連結する際は、パラメータ名や区切り文字は含めず、パラメータ値のみを連結しています。
連結した文字列をバイナリに変換する際の文字エンコーディングは、UTF-8 を使用しています。
authParams
string <= 4000 characters
PayPay 楽天ペイ ドコモ au メルペイ

vAuthInfoのハッシュ値を算出する元とした文字列のパラメータの連結順序を示す値
パラメータ名のカンマ区切り文字列を Base64 エンコードしています。
デコードを行うと文字列が復元されます。

例) status,actionCode,resultCode,command,paymentId,fepOrderId,fepReferenceId,fepReferenceId,paymentId,fepOrderId,actionCode,resultCode,command,status
(順序は固定ではないため、リクエスト受信のたびに動的に処理する必要があります。)

Responses

申込変更

楽天ペイ au


決済申込や随時支払の成功した取引の決済金額変更や与信延長を行います。
決済申込時や随時支払申込時に与信売上を指定した取引や決済申込後に売上処理を行った取引に対して申込変更処理を実行することはできません。
※auの対象は決済申込(都度決済)の成功した取引のみです。随時支払の取引は対象外となるためご注意ください。
Request Body schema: application/json

加盟店⇒Unified API

required
paymentId指定 (object) or fepOrderId指定 (object) (order)
object (transaction)
object (control)

Responses

Request samples

Content type
application/json
{
  • "order": {
    },
  • "transaction": {
    },
  • "control": {}
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "order": {
    },
  • "transaction": {
    },
  • "provider": {
    }
}

売上

PayPay 楽天ペイ ドコモ au メルペイ


申込済み取引の売上確定を行います。
決済申込時の金額以内で一回限り可能です。
Request Body schema: application/json

加盟店⇒Unified API

required
paymentId指定 (object) or fepOrderId指定 (object) (order)
object (transaction)
object (control)

Responses

Request samples

Content type
application/json
{
  • "order": {
    },
  • "transaction": {
    },
  • "control": {}
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "order": {
    },
  • "transaction": {
    },
  • "provider": {
    }
}

キャンセル

PayPay 楽天ペイ ドコモ au メルペイ


取引のキャンセルを行います。
売上後の取引については決済金額(残高)未満の金額を指定した部分返金が可能です。
部分返金については決済金額(残高)がなくなるまで繰り返し実行が可能ですが、
決済タイプや取引の状態によっては不可の場合があります。
詳しくは、別紙補足情報の「部分返金について」をご覧ください。
Request Body schema: application/json

加盟店⇒Unified API

required
paymentId指定 (object) or fepOrderId指定 (object) (order)
object (transaction)
object (control)

Responses

Request samples

Content type
application/json
{
  • "order": {
    },
  • "transaction": {
    },
  • "control": {}
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "order": {
    },
  • "transaction": {
    },
  • "provider": {
    }
}

随時支払

PayPay 楽天ペイ ドコモ au メルペイ


随時決済の利用承諾を取得した取引を元取引として、随時支払を行います。
Request Body schema: application/json

加盟店⇒Unified API

required
originalPaymentId指定 (object) or originalFepOrderId指定 (object) (order)
object (transaction)
Array of objects (item)
object (merchant)
object (control)

Responses

Request samples

Content type
application/json
{
  • "order": {
    },
  • "transaction": {
    },
  • "item": [
    ],
  • "merchant": {
    },
  • "control": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "order": {
    },
  • "transaction": {
    },
  • "provider": {
    },
  • "customer": {
    }
}

解約

PayPay ドコモ au メルペイ


随時決済の解約を要求します。加盟店による強制解約(2者間)のみ実施可能です。
Request Body schema: application/json

加盟店⇒Unified API

paymentId指定 (object) or fepOrderId指定 (object) (Order)
object (transaction)
object (control)

Responses

Request samples

Content type
application/json
{
  • "order": {
    },
  • "transaction": {
    },
  • "control": {}
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "order": {
    },
  • "transaction": {
    },
  • "provider": {
    }
}

Webhook

PayPay 楽天ペイ ドコモ au メルペイ


決済結果をFEPサーバから加盟店様に通知します。
リクエストヘッダについては他APIと同様の項目をVeriTrans4G Unified APIにて設定します。
加盟店様にてWebhookを受信した際は、{hmacString}の検証を実施してください。
加盟店様へWebhook(push)についてはプライベートIPは指定できず、SSL証明書チェックも行われます(自己証明書の場合はエラーとなります)。
ポート番号は「443」のみ許可します。

リクエストヘッダ


フィールド名 設定 書式・制限 説明
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

レスポンスについて


FEPサーバからの通知に対して、加盟店様にて正常に受信できた場合はHTTPステータスコード200を返戻してください。
200以外のコードを返戻した場合は受信失敗と判断し、一定期間通知を繰り返し行います。
加盟店様にて正常に200応答した場合でも、何らかの理由でFEPサーバにて応答が受信できなかった場合はリトライされます。
加盟店様にて200応答した取引に対して再度pushが届くケースがございますので、
ヘッダ項目のX-VT-webhook-idを受信時に確認していただき、受信済みのデータと一致した場合は、
処理をスキップして200応答するといった考慮をお願いします。

通知条件


リクエスト時にpushUrlを指定した取引のステータスが、以下条件を満たす場合に通知を実施します。
通知が不要なAPIについてはpushUrlを指定しないようご注意ください。

なお決済申込の通知条件については、消費者の途中離脱等により取引成功時以外のステータスが確定できないため、成功時のみ通知します。

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サーバでは該当の抹消通知を受信したタイミングで加盟店様に結果を通知します。

Request Body schema: application/json

Unified API⇒加盟店

object (result)
object (order)
object (transaction)
object (control)
object (provider)
object (customer)
object (paymentInstrument)

Responses

Request samples

Content type
application/json
{
  • "result": {
    },
  • "order": {
    },
  • "transaction": {
    },
  • "control": {
    },
  • "provider": {
    },
  • "customer": {
    },
  • "paymentInstrument": {
    }
}

取引結果取得

PayPay 楽天ペイ ドコモ au メルペイ


指定されたfepReferenceIdに紐づく取引のVeriTrans4G Unified API内での取引結果を返却します。

実行結果について

本APIでは、指定されたfepReferenceIdに紐づく取引が実行された時点の情報が返却されます。
返却される情報はWebhookと同程度の内容となります。
ただし以下条件の場合は、取引が完了しておらず未確定状態のため、取引結果取得を実行した場合は取引情報を取得できません(resultCode:UA-U00-001)。
契機 条件
決済申込実施後 消費者ブラウザから店舗側の完了画面へのリダイレクトを受信するまでの間
随時支払実施後 支払結果が「UA-U00-001(user_paying)」の場合に、対応するWebhookを受信するまでの間
Request Body schema: application/json

加盟店⇒Unified API

object (transaction)

Responses

Request samples

Content type
application/json
{
  • "transaction": {
    }
}

Response samples

Content type
application/json
Example
{
  • "result": {
    },
  • "transactionData": {
    }
}

稼働確認


 VeriTrans4G Unified APIではSandbox環境とLive環境を提供します。
 ※各環境のリクエスト先URLについては「HTTPリクエスト詳細」を参照してください。

 Sandbox環境では決済事業者と接続せずに取引をテストすることができ、
 また各APIで金額等を特定の値に設定することで失敗取引のシミュレーションも可能です。
 Sandbox環境で確認されたあとは、Live環境にて実際に決済事業者と接続したテストを実施し、決済事業者の振る舞いを確認してください。
 なおSandbox環境では決済事業者が設定する項目にはダミー値が設定され、動作もダミー用の簡易なものとなりますので、
 加盟店様のリリースまでには必ずLive環境にてテストを実施し実際の値・動作を確認してください。
 テスト時に利用するマーチャントIDについては、各加盟店に発行されたIDをご利用ください。
 ご契約前の利用については、必要に応じてお問い合わせください。



PayPayのシミュレート内容


決済申込(都度決済)


 決済申込のリクエスト金額(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の仕様に伴い変更となる可能性があります。



随時申込(随時決済)


 随時決済の決済申込のテストリクエストはすべて決済成功となります。
 決済申込の結果として返戻された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

 ※1 recoveryType=not_recoveryの場合
 ※2 recoveryType=recoveryの場合。その後1001(成功)に遷移する。


  ・ 金額未指定のキャンセルの場合、残高の全額が指定されたものとして動作します。
  ・ 金額未指定の売上の場合、決済金額の全額が指定されたものとして動作します。

楽天ペイのシミュレート内容


決済申込(都度決済)


 決済申込のリクエスト金額(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

 決済申込の結果として返戻されたredirectUrlでリダイレクト指示すると、以下のダミー環境に自動的に遷移します。
 また「お支払内容の確認」画面にて決済結果を選択できます。選択した内容でリダイレクトの結果が変更されます。

 ※ダミー楽天ペイの画面イメージについては、楽天ペイの仕様に伴い変更となる可能性があります。


決済結果選択 リダイレクト
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

 決済申込の結果として返戻されたredirectUrlでリダイレクト指示すると、以下のダミー環境に自動的に遷移します。

 ※ダミー楽天ペイの画面イメージについては、楽天ペイの仕様に伴い変更となる可能性があります。


 また「申込内容の確認」画面にて申込結果を選択できます。選択した内容でリダイレクトの結果が変更されます。

申込結果選択 リダイレクト
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

  ・ 金額未指定のキャンセルの場合、残高の全額が指定されたものとして動作します。
  ・ 金額未指定の売上の場合、決済金額の全額が指定されたものとして動作します。

auのシミュレート内容


決済申込(都度決済)


 決済申込のリクエスト金額(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

 決済申込の結果として返戻されたredirectUrlでリダイレクト指示すると、以下のダミー環境に自動的に遷移します。

 ※auPAY(auかんたん決済)およびauPAY(ネット支払い)のダミー画面イメージについては、auの仕様に伴い変更となる可能性があります。


お支払い方法の選択画面や決済内容確認画面にて「キャンセル」を選択することで、リダイレクトの結果が変更されます。
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

テストシナリオ

以下にエラーケース毎のシミュレート方法の一例を紹介します。
シミュレートに関係するAPIと設定内容を青字で記載しています。

都度決済

随時決済(元取引)

随時決済(随時支払)

改訂履歴

バージョン リリース年月 更新内容
1.0.0 β 2023/12  新規作成
1.0.0 RC 2024/08
  1. 随時決済追加に伴い、以下に関連の記載を追加
    • 概要
      • 決済方式
      • API一覧
      • 決済シーケンス
      • 決済フロー
      • 決済ライフサイクル
    • APIについて
      • 取引に関する各種IDについて
    • APIs
      • 随時申込
      • 随時支払
      • Webhook
      • 解約
      • 取引結果取得
    • 稼働確認
      • PayPayのシミュレート内容
      • 楽天ペイのシミュレート内容
      • テストシナリオ
  2. HTTPリクエスト詳細のURLドメインを更新
  3. リクエスト項目およびレスポンス項目amountの型をintegerからstringに変更
    ※リクエスト項目およびレスポンス項目にamountがあるAPIはすべて該当
  4. レスポンス項目からbalanceを削除
    ※レスポンス項目にbalanceがあったAPIはすべて該当
  5. 決済申込リクエスト項目において以下を変更
    • storeIdおよびterminalIdを追加
    • userAgentの許容桁数変更
    • successUrl、cancelUrlおよびerrorUrlの指定種別を任意から必須へ変更
  6. 補足情報を別冊として分離
1.0.1 RC 2024/12
  1. API一覧にPayPayの接続方式に関する注釈を追加
  2. 以下の項目から未設定時の挙動に関する説明を削除
    • APIs
      • 決済申込
        • successUrl
        • cancelUrl
        • errorUrl
      • 随時申込
        • successUrl
        • cancelUrl
        • errorUrl
  3. PayPayにおける決済申込/随時申込/随時支払リクエスト項目idの入力値制限を修正
  4. 以下の項目へレスポンスに関する記載を追加
    • APIs
      • リダイレクト
      • Webhook
  5. その他、微細なフォーマットの修正
1.1.0 RC 2025/06
  1. ドコモ、auおよびメルペイ追加に伴い、以下に関連の記載を追加
    • 概要
      • 導入
      • API一覧
      • 決済ライフサイクル
      • 決済シーケンス
      • 決済ライフサイクル
    • APIs
      • 決済申込
      • 随時申込
      • リダイレクト
      • 申込変更
      • 売上
      • キャンセル
      • 随時支払
      • 解約
      • Webhook
      • 取引結果取得
    • 稼働確認
      • ドコモのシミュレート内容
      • auのシミュレート内容
      • メルペイのシミュレート内容
      • テストシナリオ
  2. 申込変更API追加に伴い、以下に関連の記載を追加
    • 概要
      • API一覧
      • 決済シーケンス
      • 決済フロー
      • 決済ライフサイクル
    • APIs
      • 申込変更
      • Webhook
      • 取引結果取得
    • 稼働確認
      • 楽天ペイのシミュレート内容
      • auのシミュレート内容
      • テストシナリオ
  3. 以下にポート番号の記述を追加
    • 「APIについて」の「HTTPリクエスト詳細」
    • 「APIs」の「Webhook」の冒頭サマリ
    • 「APIs」の以下のリクエスト項目pushUrl
      • 決済申込
      • 随時申込
      • 申込変更
      • 売上
      • キャンセル
      • 随時支払
      • 解約
  4. 「取引結果」の「アクションコード」の表において、「alternate_payment」の加盟店様対応の内容を更新
  5. 「稼働確認」の冒頭に「テスト時利用するマーチャントID」について追記
  6. 「APIs」の以下のレスポンス項目result.statusの説明文のリンク先を「取引結果について」から配下の「ステータス」に変更
    • APIs
      • 決済申込
      • 随時申込
      • 申込変更
      • 売上
      • キャンセル
      • 随時支払
      • 解約
      • 取引結果取得
  7. 「APIs」の「キャンセル」リクエスト項目のreasonの説明文を修正
  8. 「Bearer認証について」のMAPの設定画面を追加
  9. 「お知らせ」に新ドメインについての説明を追加
  10. 以下に旧ドメインと新ドメインの記載を追加
    • HTTPリクエスト詳細
    • APIs
      • 決済申込
      • 随時申込
      • 申込変更
      • 売上
      • キャンセル
      • 随時支払
      • 解約
      • 取引結果取得
  11. 新しい結果コード(UA-000-002)の追加に伴い、以下に関連の記載を追加
    • APIについて
      • 取引に関する各種IDについて
        • paymentIdの説明文にUA-000-002についての記載を追加
      • 取引結果について
        • 結果コード (HTTPSステータスコード : 200, resultCode : UA-000-002)
        • アクションコード (actionCode : confirm_payment)
  12. 「APIs」の以下のレスポンス項目result.actionCodeの最大文字数を「64」に変更
    • APIs
      • 決済申込
      • 随時申込
      • リダイレクト
      • 申込変更
      • 売上
      • キャンセル
      • 随時支払
      • 解約
      • Webhook
      • 取引結果取得
  13. 「APIs」の以下のレスポンス項目provider.payment.gatewayOrderIdの最大文字数を「64」に変更し、随時支払のみ「PayPay」のタグを追加
    • APIs
      • キャンセル
      • 売上
      • 随時支払
  14. その他、微細なフォーマットの修正
1.1.1 RC 2025/09
  1. 「APIs」の以下コマンドから、「PayPay」の場合レスポンス項目のcustomer.buyer.customerIdが返戻されなくなったため削除
    • 随時支払
    • 解約
    • 取引結果取得
    • Webhook
  2. 「APIs」の以下のレスポンス項目provider.payment.providerOrderIdの最大文字数を「64」に変更
    • キャンセル
    • 売上
    • 解約
    • 申込変更
  3. 社名表記を「楽天グループ株式会社」から「楽天ペイメント株式会社」に変更
  4. auかんたん決済のサービス名称をauPAY(auかんたん決済)に変更
  5. その他、微細なフォーマットの修正