メルペイ
本ガイドについて
本ガイドの内容
本ガイドは、株式会社DGフィナンシャルテクノロジーが提供するVeriTrans4Gのメルペイオンライン決済サービスを導入するための、アプリケーション開発者向けのガイドです。
メルペイ(オンライン決済)サービス概要
メルペイ(オンライン決済)サービスの概要
メルペイ(オンライン決済)サービスは、メルカリユーザがパートナーのECサイト等で利用できるインターネットを介した、非対面で決済できるサービスです。(メルペイは、メルカリアプリを利用した決済サービスです。)
- スマートフォン/アプリによる決済
- スマートフォンブラウザおよびアプリを起点としたメルペイでの決済を行う手法です。
この決済ではメルカリアプリを利用することでユーザはシームレスに認証と決済を行うことができます。
- スマートフォンブラウザおよびアプリを起点としたメルペイでの決済を行う手法です。
- PC+スマートフォンによる決済
- PCを起点としたメルペイでの決済を行う手法です。
この決済ではPCに表示されるQRコードを読み込むことで、ユーザはメルカリアプリにて決済を行うことができます。
- PCを起点としたメルペイでの決済を行う手法です。
- メルペイに保持されている個人情報の取得
- 申込の際に個人情報を取得するには、申込時に「配送先情報フラグ」と「購入者情報フラグ」を連携頂くことにより、メルペイへ保持されている配送先情報・購入者情報を取得することができます。(フラグの詳細は「5.1.1申込」 参照)
個人情報を取得する場合はメルカリアプリ画面でユーザの同意が必要となり、ユーザの同意が行われなかった場合は、決済処理がキャンセルとなります。
(「6.3.1個人情報(配送先情報・購入者情報)の要求について」 参照)
- 申込の際に個人情報を取得するには、申込時に「配送先情報フラグ」と「購入者情報フラグ」を連携頂くことにより、メルペイへ保持されている配送先情報・購入者情報を取得することができます。(フラグの詳細は「5.1.1申込」 参照)
決済の画面遷移のイメージを以下に示します。
スマートフォンのみで決済

PC+スマートフォンで決済

都度決済と随時決済
メルペイ(オンライン決済)サービスでは、「都度決済」と「随時決済」の2種類の決済を行うことができます。
【都度決済機能】
消費者の購入した商品などについて、1回だけ決済を行います。
都度決済機能には以下の特徴があります。
- 都度決済の申込は、「課金種別」を未指定、あるいは都度決済を指定して行います。
- 都度決済の申込は、消費者の端末から行います。
- 与信のキャンセル、売上、売上後の返金はMDKまたは管理画面(MAP)から可能です。
【随時決済機能】
店舗様と利用者の継続的な利用の承諾に基づき、商品などの提供状況に応じて加盟店の処理要求単位に課金することができます。解約手続き(利用承諾の終了)が行われるまで、店舗様からの要求の都度、課金が発生します。
- 随時決済の申込(利用承諾)は、「課金種別」に随時決済を指定し、都度決済と同様のフローで行います。
※随時決済の申込時に決済金額を指定することにより、利用承諾と同時に決済要求(与信、与信売上)を行います。
- 随時決済の申込は、消費者の端末から行います。
- 課金する場合には、①の取引IDを元取引IDに指定し、新しい取引IDで再与信することにより金額を確保します。
※withCaptureを指定することで同時に売上処理も可能です。
- 3.の取引IDに対して、キャンセル、売上、返金を実施します。
再与信した取引のキャンセル、売上、売上後の返金はMDKまたは管理画面(MAP)から可能です。 - 随時決済の解約が行われるまで、③と④を何度でも実施できます。 ただし、一定期間(1年)、再与信を行わなかった場合、または、消費者がメルペイを退会した場合は、メルペイ側で利用承諾終了となり、抹消通知が店舗様に通知されます。
- 随時決済の解約はMDKまたは管理画面(MAP)から可能です。
MDKの処理概要
機能一覧(決済要求コマンド)
使用可能な決済要求コマンドを下記表に示します。
決済要求種類 /コマンド |
概要 |
---|---|
申込 (与信) /Authorize |
決済の申し込み(オーソリ)を要求します。 |
申込 (与信+売上) /Authorize |
決済の申し込み(オーソリ)と売上を同時に要求します。 |
申込 (承諾) /Authorize |
利用承諾を要求します。 要求パラメータのaccountingTypeを1に設定した場合に、随時決済の申込を行います。 また、随時決済の申込と同時に「与信」「与信+売上」を要求することができます。 |
取消 /Cancel |
決済を取消(キャンセル)します。 売上前の取引に対してのみ実行でき、与信(オーソリ)の取消となります。 |
売上 /Capture |
申込済み取引の売上確定を要求します。 |
返金 /Refund |
売上確定済みの取引に対し返金します。 |
再与信 /ReAuthorize |
決済申込で随時決済を指定した取引に対して、再与信(オーソリ)を要求します。 |
解約 /Terminate |
随時決済の利用承諾の終了(解約)を要求します。 随時決済の売上以降も実行でき、随時決済の取消を要求します。 |
決済処理シーケンス
【メルペイ:決済申込時の処理(スマートフォンのみ)】

No. | 基本機能 | 処理説明 |
---|---|---|
1 | 決済申込要求 | ECサイト上の決済導入部に渡された決済申込情報を電文化し決済サーバーに送信します。 |
2 | 結果応答 | 決済サーバーから返戻された結果を受信します。結果が成功(決済可能)の場合、「3. リダイレクト指示」を実施します。消費者ブラウザに返すリダイレクト先のURLが決済サーバーより返戻された結果に含まれます。 |
3 | リダイレクト指示 | 決済サーバーにより返戻されたURLを表示します。URLをリダイレクトし、メルカリアプリの注文画面へ遷移します。 |
4 | 申込結果通知(PUSH) |
この通知は、決済申込により与信が成功した場合のみ通知されます。 リクエスト時に指定したPUSH通知先URL(未指定の場合は、MAP(Merchant Administration Portal)により設定した値)に、決済サーバーよりPOSTで通知されますので、決済結果を受け取り、注文データ等に反映します。 完了画面要求は、消費者の端末(PCやスマートフォン)のネットワーク環境の問題や、誤操作(ブラウザやタブを閉じてしまう等)により、正しく行われない可能性がありますので、必ずこの通知を受信してください。 なお、結果応答と完了画面要求のリダイレクト結果が加盟店に届く順番は保証されていません。どちらが先に届いても問題とならないようにご対応ください |
5 | 決済完了通知 | メルペイより消費者へ決済結果が通知されます。 ※通知されていない場合についても、メルペイからリダイレクト(後処理)が行われます。 |
6 | 完了画面要求 | 消費者ブラウザから結果を受信し、完了画面を送信します。 消費者側の状況により通信断や誤ってブラウザを閉じる、といったケースではこのシーケンスは発生しませんが、4.申込結果通知(PUSH)を受信していれば、決済結果を取りこぼすことはありません。 |
【メルペイ:決済申込時の処理(PC+スマートフォン)】

No. | 基本機能 | 処理説明 |
---|---|---|
1 | 決済申込要求 | ECサイト上の決済導入部に渡された決済申込情報を電文化し決済サーバーに送信します。 |
2 | 結果応答 | 決済サーバーから返戻された結果を受信します。結果が成功(決済可能)の場合、「3. リダイレクト指示」を実施します。消費者ブラウザに返すリダイレクト先のURLが決済サーバーより返戻された結果に含まれます。 |
3 | リダイレクト指示 | 決済サーバーにより返戻されたURLを表示します。URLをリダイレクトし、メルカリアプリの注文画面へ遷移します。 |
4 | 申込結果通知(PUSH) |
この通知は、決済申込により与信が成功した場合のみ通知されます。 リクエスト時に指定したPUSH通知先URL(未指定の場合は、MAP(Merchant Administration Portal)により設定した値)に、決済サーバーよりPOSTで通知されますので、決済結果を受け取り、注文データ等に反映します。 完了画面要求は、消費者の端末(PCやスマートフォン)のネットワーク環境の問題や、誤操作(ブラウザやタブを閉じてしまう等)により、正しく行われない可能性がありますので、必ずこの通知を受信してください。 なお、結果応答と完了画面要求のリダイレクト結果が加盟店に届く順番は保証されていません。どちらが先に届いても問題とならないようにご対応ください |
5 | 決済完了通知 | メルペイより消費者へ決済結果が通知されます。 ※通知されていない場合についても、メルペイからリダイレクト(後処理)が行われます。 |
6 | 完了画面要求 | 消費者ブラウザから結果を受信し、完了画面を送信します。 消費者側の状況により通信断や誤ってブラウザを閉じる、といったケースではこのシーケンスは発生しませんが、4.申込結果通知(PUSH)を受信していれば、決済結果を取りこぼすことはありません。 |
【取消処理】

No. | 基本機能 | 処理説明 |
---|---|---|
1 | 取消要求 | 与信取消の対象となる取引情報を電文化し、決済サーバーに送信します。 |
2 | 結果応答 | 決済サーバーより取消の結果応答を受信し、結果情報を取得します。 |
【売上処理】

No. | 基本機能 | 処理説明 |
---|---|---|
1 | 売上要求 | 売上の対象となる取引情報を電文化し、決済サーバーに送信します。 |
2 | 結果応答 | 決済サーバーより売上の結果応答を受信し、結果情報を取得します。 |
【返金処理】

No. | 基本機能 | 処理説明 |
---|---|---|
1 | 返金要求 | 返金の対象となる取引情報を電文化し、決済サーバーに送信します。 |
2 | 結果応答 | 決済サーバーより返金の結果応答を受信し、結果情報を取得します。 |
【再与信処理】

No. | 基本機能 | 処理説明 |
---|---|---|
1 | 再与信要求 | 再与信の対象となる取引情報を電文化し、決済サーバーに送信します。 |
2 | 結果応答 | 決済サーバーより返金の結果応答を受信し、結果情報を取得します。 |
【解約処理】

No. | 基本機能 | 処理説明 |
---|---|---|
1 | 解約要求 | 解約の対象となる取引情報を電文化し、決済サーバーに送信します。 |
2 | 結果応答 | 決済サーバーより返金の結果応答を受信し、結果情報を取得します。 |
結果通知受信処理
結果通知受信処理の対象
メルペイ(オンライン決済)の結果通知受信処理の対象は以下の機能です。
決済サービス名 | 決済申込 | 返金 | 取消 | 売上 | 再与信 | 解約 | 抹消 | |
---|---|---|---|---|---|---|---|---|
メルペイ (オンライン決済) |
都度 | ○ | - | - | - | - | - | - |
随時 | ○ | - | - | - | - | - | ○ |
※ 抹消は日次バッチにより決済サーバーがメルペイへ「抹消」のステータスを確認したタイミングで送信されます。
通信電文仕様(共通部)および店舗受信後応答仕様は、『開発ガイド』をご参照ください。
メルペイ(オンライン決済)固有の通知電文インターフェイスにつきましては、「5-3結果通知電文」の「5.3.2結果通知のタイミングと項目について」をご参照ください。
インターフェイス詳細
ここではメルペイサービスで利用するMDKインターフェイス項目を説明します。
-
「設定」欄の内容は以下の通りです。
- 要求電文 ...
- 必須項目:○ 任意項目:△ 設定不可:× その他条件付:※、※n(条件は説明欄、または欄外に記入)
- 応答電文 ...
- 必ず返戻:○ 処理成功時のみ返戻:△ 返戻なし:× その他条件付:※
-
orderId(取引ID)について
店舗で任意に採番してください。申込処理毎に付ける必要があります。他の取引IDと重複しないよう採番してください。他決済サービスとも重複できません。
また、テスト取引で使用した取引IDを、本番取引で再度使用することはできません。
取引IDには、半角英数字以外に"-"(ハイフン)、"_"(アンダースコア)も使用可能です。 -
応答電文について
応答電文には、本書に記載されていないフィールド(パラメータ)も存在しますが、通常は、記載されているフィールド以外は加盟店様の方で意識する必要はございません。
メルペイ
申込
要求電文 : MerpayAuthorizeRequestDto | |||||
---|---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 | |
orderId | 取引ID | 半角英数字 100桁以内 |
店舗側で採番した取引IDを指定 |
○ | |
serviceOptionType | サービスオプションタイプ | 右記参照 | 利用する決済方法のタイプを指定 "online":オンライン決済 |
○ | |
amount | 決済金額 | 半角数字 7桁以内 |
決済金額を指定 1~1000000の間で指定できます。 ※以下の場合、未設定または0のみ許容します。 |
△ | |
accountingType | 課金種別 | 半角数字 | 利用する決済方法の課金種別を指定 0:都度(デフォルト値) 1:随時 ※未指定の場合、"0"都度になります。 |
△ | |
consentAuthType | 承諾時決済タイプ | 右記参照 | 0:承諾のみ(デフォルト値) 1:承諾同時決済 ※課金種別が"1:随時"以外の場合、当項目は設定不可(null)となります。 ※未設定の場合は"0:承諾のみ"になります。 |
△ | |
withCapture | 与信同時売上フラグ | 右記参照 | - true:与信同時売上 - false:与信のみ(デフォルト値) ※未指定の場合、"false:与信のみ"になります。 ※以下の場合、当項目は設定不可(null)となります。 |
△ | |
successUrl | 決済成功URL | 半角英数字記号 1024桁以内 |
決済成功時の戻り先となるURL | △ | |
cancelUrl | 決済キャンセルURL | 半角英数字記号 1024桁以内 |
決済キャンセル時の戻り先となるURL | △ | |
pushUrl | PUSH通知URL | 半角英数字記号 1024桁以内 |
決済結果を応答するPush通知先URL | △ | |
useDeliveryAddress | 配送先情報フラグ | 右記参照 | - true:メルペイより配送先情報必要 - false:メルペイより配送先情報不要 ※未指定の場合、「"false": メルペイより配送先情報不要」になります。 ※配送先情報の詳細は 6.3.1個人情報(配送先情報・購入者情報)の要求について を参照 |
△ | |
useBuyerInfo | 購入者情報フラグ | 右記参照 | - true:メルペイより購入者情報必要 - false:メルペイより購入者情報不要 ※未指定の場合、「"false": メルペイより購入者情報不要」になります。 |
△ | |
preapprovedServiceName | 提供サービス名 | 全半角かな英数字記号 20桁以内 |
提供サービス名を指定
※課金種別が"0:都度"の場合設定不可 |
△ | |
preapprovedServiceDescription | 提供サービス説明 | 全半角かな英数字記号 120桁以内 |
提供サービス説明を指定
※課金種別が"0:都度"の場合設定不可 |
△ | |
userAgent | ユーザエージェント | 半角英数字記号 1000桁以内 |
決済を行うユーザの端末のUserAgentを指定。 ※指定していない場合、決済処理開始時と完了時でのブラウザの違いが発生する可能性があります。 ※この項目は現在Chromeのみに有効です。メルペイ側の仕様により対象ブラウザが変更・追加になる可能性があります。 |
△ | |
商品情報 (※) | |||||
name | 商品名 | 全半角かな英数字記号 40桁以内 |
商品の名称 | △ | |
description | 商品説明 | 全半角かな英数字記号 1000桁以内 |
商品に対する説明文 | △ | |
imageUrl1 | 商品画像URL1 | 半角英数字記号 2000桁以内 |
商品の画像URL | △ | |
imageUrl2 | 商品画像URL2 | 半角英数字記号 2000桁以内 |
商品の画像URL | △ | |
imageUrl3 | 商品画像URL3 | 半角英数字記号 2000桁以内 |
商品の画像URL | △ | |
imageUrl4 | 商品画像URL4 | 半角英数字記号 2000桁以内 |
商品の画像URL | △ | |
imageUrl5 | 商品画像URL5 | 半角英数字記号 2000桁以内 |
商品の画像URL | △ | |
imageUrl6 | 商品画像URL6 | 半角英数字記号 2000桁以内 |
商品の画像URL | △ | |
imageUrl7 | 商品画像URL7 | 半角英数字記号 2000桁以内 |
商品の画像URL | △ | |
imageUrl8 | 商品画像URL8 | 半角英数字記号 2000桁以内 |
商品の画像URL | △ | |
imageUrl9 | 商品画像URL9 | 半角英数字記号 2000桁以内 |
商品の画像URL | △ | |
category | カテゴリ名 | 全半角かな英数字記号 40桁以内 |
商品のカテゴリ名 | △ | |
size | サイズ | 全半角かな英数字記号 20桁以内 |
商品のサイズ | △ | |
brand | ブランド名 | 全半角かな英数字記号 40桁以内 |
商品のブランド | △ | |
color | 色 | 全半角かな英数字記号 32桁以内 |
商品の色 | △ | |
listPrice | 定価 | 半角数字 7桁以内 |
商品の定価 1~1000000の間で指定できます。 |
△ | |
unitPrice | 購入時価格 | 半角数字 7桁以内 |
商品購入時に値引きなどが入った場合、値引き後の商品価格です。 1~1000000の間で指定できます。 |
△ | |
quantity | 購入数 | 半角数字 7桁以内 |
購入された商品の総数 1~1000000の間で指定できます。 |
△ | |
itemCode | 製品管理コード(SKU) | 半角英数字記号 128桁以内 |
JANコードを発行している製品はJANコードを入れてください。 JANコードがない場合は内部で製品を管理する際に利用されている製品管理コードの送付となります。 |
△ | |
janCode | JANコード | 半角英数字 13桁以内 |
JANコードがある場合、製品管理コードと同様のJANコード | △ | |
categoryId | 商品カテゴリID | 半角英数字 4桁以内 |
商品カテゴリを示すID 詳細は 6.3.2商品カテゴリID一覧を参照 |
○ |
- 商品情報は「かんたん出品連携」に関連する項目となります。「categoryId(商品カテゴリID)」以外の項目は、都度決済(課金種別="0")のときのみ設定が可能です。詳細は「6-4かんたん出品連携について」を参照してください。
- 商品情報のうち「categoryId(商品カテゴリID)」は、決済手段のメルペイスマート払いを利用するために必要な情報です。都度決済、随時決済どちらの場合でも設定は必須です。必ず「6.3.2商品カテゴリID一覧」に記載のあるカテゴリIDを設定してください。(かんたん出品連携を利用しない場合でも設定が必要です。)
応答電文 : MerpayAuthorizeResponseDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
serviceType | 決済サービスタイプ | 半角英数字 10桁以内 |
要求電文を送信した決済サービスタイプ | ○ |
mstatus | 処理結果コード | 半角英数字 32文字以内 |
"success":正常終了 "failure":異常終了 |
○ |
vResultCode | 詳細結果コード | 半角英数字 16文字 |
処理の結果を詳細に表すコード 4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。 詳細は『結果コード一覧』を参照下さい。 |
○ |
merrMsg | エラーメッセージ | 文字列 1024 byte以内 |
処理結果を日本語又は英語で表示 | ○ |
marchTxn | 電文ID | 文字列 100桁以内 |
決済サーバーにて決済処理電文(内部処理も含む)毎に付与するID 1つの取引IDに対して、複数のIDが付与されます。 |
○ |
orderId | 取引ID | 半角英数字 100 桁以内 |
決済要求時に店舗様にて任意に採番し送信された取引ID | ○ |
custTxn | 取引毎に付くID | 文字列 100桁以内 |
決済サーバーがオーダー(取引ID)と紐付ける為に採番するID | ○ |
txnVersion | MDK バージョン | 半角英数字 5桁 |
電文のバージョン 問題発生時などに用いますが、通常ご利用になることはありません。 |
○ |
merpayProcessingId | 決済センターとの取引ID | 半角英数字 20桁 |
決済センターとの取引ID | △ |
paymentUrl | 決済開始URL | 半角英数字記号 2000桁以内 |
メルペイオンライン決済を開始するためのURLです。スマートフォン上でアクセスすることでメルカリアプリが起動します。 通常はこのURLに対してHTTPリダイレクトを指定してください。リダイレクトを使用しない場合、このURLに対してスマートフォンブラウザ等がGET Methodでリクエストが行われるように構成してください |
△ |
消費者ブラウザから店舗側の完了画面へリダイレクトする時のクエリパラメータ
リダイレクト受信内容:決済サーバーから消費者ブラウザ経由で店舗側へリダイレクト(GET)される内容 | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
mstatus | 処理結果コード | 半角英数字 32文字以内 |
"success":正常終了 "failure" :異常終了 |
○ |
vResultCode | 詳細結果コード | 半角英数4桁 | 処理の結果を詳細に表すコード 詳細は『結果コード一覧』を参照下さい。 |
○ |
orderId | 取引ID | 半角英数字 100文字以内 |
決済要求時に店舗様にて任意に採番し送信された取引ID | ○ |
merpayProcessingId | 決済センターとの取引ID | 半角英数字 20文字以内 |
決済センターとの取引ID | △ |
inquiryCode | 問い合わせ番号 | 半角英数字 20文字以内 |
ユーザがメルペイアプリの残高履歴を確認するための番号 | △ |
preapprovalId | 事前承認ID | 半角英数字 50文字以内 |
随時決済の利用承諾済みの取引をメルペイで識別するためID ※随時決済の決済申込の場合にのみ設定します。 |
△ |
txnType | トランザクションタイプ | 文字列 右記参照 |
通知対象となるトランザクションのタイプが設定されます。 "Authorize" |
○ |
vAuthInfo | 改ざんチェック用 ハッシュ値 |
文字列 右記参照 |
下記文字列を連結し、SHA-256によって算出したハッシュ値。
|
○ |
authParams | ハッシュ値算出パラメータ順序 | 文字列 右記参照 |
vAuthInfo のハッシュ値を算出する元とした文字列の、パラメータの連結順序を示す値。 パラメータ名のカンマ区切り文字列を、Base64エンコードしたもの。 Base64デコードを行うことで、下記のような文字列が復元される。 例) "mstatus,vResultCode,orderId,merpayProcessingId,inquiryCode,preapprovalId,command" "mstatus,preapprovalId,orderId,merpayProcessingId,inquiryCode,command,vResultCode" (順序は固定ではないため、リクエスト受信のたびに動的に処理する必要がある。) |
○ |
これらのパラメータはブラウザを経由して連携されるため、画面遷移が正常に行われないケースでは取得することができません。そのため、決済サーバーから直接送信される「5-3 結果通知電文」の受信と組み合わせて確実に結果を取得するようにしてください。
決済サーバーから消費者ブラウザを経由して店舗側の結果画面に遷移(リダイレクト)しますが、ここで店舗側システムが受け取ったクエリパラメータが改ざんされていないことを検証するためのパラメータが、vAuthInfoとauthParamsです。
店舗側システムで算出したハッシュ値が、クエリパラメータより取得したvAuthInfoと一致している場合は、パラメータは改ざんされていない、とみなすことができます。
この改ざんチェックは、悪意を持った第三者によって、不正なリダイレクト電文を受信する可能性がありますので、実装を強く推奨しています。
実装方法の詳細につきましては、弊社より提供しているサンプルプログラムをご参照ください。
取消
要求電文 : MerpayCancelRequestDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
orderId | 取引ID | 半角英数字 100桁以内 |
都度決済:決済申込時の取引IDを指定 随時決済:決済申込時、または再与信時の取引IDを指定 |
○ |
serviceOptionType | サービスオプションタイプ | 半角英数字 | 利用する決済方法のタイプを指定 "online":オンライン決済 |
○ |
応答電文 : MerpayCancelResponseDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
serviceType | 決済サービスタイプ | 半角英数字 10桁以内 |
要求電文を送信した決済サービスタイプ | ○ |
mstatus | 処理結果コード | 半角英数字 32文字以内 |
"success":正常終了 "failure":異常終了 "pending":保留 |
○ |
vResultCode | 詳細結果コード | 半角英数字 16文字 |
処理の結果を詳細に表すコード 4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。 詳細は『結果コード一覧』を参照下さい。 |
○ |
merrMsg | エラーメッセージ | 文字列 1024 byte以内 |
処理結果を日本語又は英語で表示 | ○ |
marchTxn | 電文ID | 文字列 100桁以内 |
決済サーバーにて決済処理電文(内部処理も含む)毎に付与するID 1つの取引IDに対して、複数のIDが付与されます。 |
○ |
orderId | 取引ID | 半角英数字 100桁以内 |
決済要求時に店舗様にて任意に採番し送信された取引ID | ○ |
custTxn | 取引毎に付くID | 文字列 100桁以内 |
決済サーバーがオーダー(取引ID)と紐付ける為に採番するID | ○ |
txnVersion | MDK バージョン | 半角英数字5桁 | 電文のバージョン 問題発生時などに用いますが、通常ご利用になることはありません。 |
○ |
merpayProcessingId | 決済センターとの取引ID | 半角英数字20桁 | 決済センターとの取引ID | △ |
売上
要求電文 : MerpayCaptureRequestDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
orderId | 取引ID | 半角英数字 100桁以内 |
都度決済:決済申込時の取引IDを指定 随時決済:決済申込時、または再与信時の取引IDを指定 |
○ |
serviceOptionType | サービスオプションタイプ | 半角英数字 | 利用する決済方法のタイプを指定 "online":オンライン決済 |
○ |
amount | 売上金額 | 半角数字 7桁以内 |
売上金額を指定 1~1000000の間で指定できます。 売上時に金額を指定することで決済全額の一部での売上確定(部分売上)が可能です ※未設定の場合、全額売上となります。 |
△ |
応答電文 : MerpayCaptureResponseDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
serviceType | 決済サービスタイプ | 半角英数字 10桁以内 |
要求電文を送信した決済サービスタイプ | ○ |
mstatus | 処理結果コード | 半角英数字 32文字以内 |
"success":正常終了 "failure":異常終了 "pending":保留 |
○ |
vResultCode | 詳細結果コード | 半角英数字 16文字 |
処理の結果を詳細に表すコード 4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。 詳細は『結果コード一覧』を参照下さい。 |
○ |
merrMsg | エラーメッセージ | 文字列 1024 byte以内 |
処理結果を日本語又は英語で表示 | ○ |
marchTxn | 電文ID | 文字列 100桁以内 |
決済サーバーにて決済処理電文(内部処理も含む)毎に付与するID 1つの取引IDに対して、複数のIDが付与されます。 |
○ |
orderId | 取引ID | 半角英数字 100桁以内 |
決済要求時に店舗様にて任意に採番し送信された取引ID | ○ |
custTxn | 取引毎に付くID | 文字列 100桁以内 |
決済サーバーがオーダー(取引ID)と紐付ける為に採番するID | ○ |
txnVersion | MDK バージョン | 半角英数字5桁 | 電文のバージョン 問題発生時などに用いますが、通常ご利用になることはありません。 |
○ |
merpayProcessingId | 決済センターとの取引ID | 半角英数字20桁 | 決済センターとの取引ID | △ |
返金
要求電文 : MerpayRefundRequestDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
orderId | 取引ID | 半角英数字 100桁以内 |
都度決済:決済申込時の取引IDを指定 随時決済:決済申込時、または再与信時の取引IDを指定 |
○ |
serviceOptionType | サービスオプションタイプ | 半角英数字 | 利用する決済方法のタイプを指定 "online":オンライン決済 |
○ |
amount | 返金金額 | 半角数字 7桁以内 |
返金金額を指定 1~1000000の間で指定できます。 返金時に金額を指定することで決済全額の一部を返金(部分返金)が可能です。 ※未設定の場合、全額返金となります。 |
△ |
応答電文 : MerpayRefundResponseDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
serviceType | 決済サービスタイプ | 半角英数字 10桁以内 |
要求電文を送信した決済サービスタイプ | ○ |
mstatus | 処理結果コード | 半角英数字 32文字以内 |
"success":正常終了 "failure":異常終了 "pending":保留 |
○ |
vResultCode | 詳細結果コード | 半角英数字 16文字 |
処理の結果を詳細に表すコード 4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。 詳細は『結果コード一覧』を参照下さい。 |
○ |
merrMsg | エラーメッセージ | 文字列 1024 byte以内 |
処理結果を日本語又は英語で表示 | ○ |
marchTxn | 電文ID | 文字列 100桁以内 |
決済サーバーにて決済処理電文(内部処理も含む)毎に付与するID 1つの取引IDに対して、複数のIDが付与されます。 |
○ |
orderId | 取引ID | 半角英数字 100桁以内 |
決済要求時に店舗様にて任意に採番し送信された取引ID | ○ |
custTxn | 取引毎に付くID | 文字列 100桁以内 |
決済サーバーがオーダー(取引ID)と紐付ける為に採番するID | ○ |
txnVersion | MDK バージョン | 半角英数字5桁 | 電文のバージョン 問題発生時などに用いますが、通常ご利用になることはありません。 |
○ |
merpayProcessingId | 決済センターとの取引ID | 半角英数字20桁 | 決済センターとの取引ID | △ |
balance | 残高 | 半角数字 7桁以内 |
現在の決済金額を返します。 | △ |
inquiryCode | 問合せ番号 | 半角英数字 20桁以内 |
ユーザがメルカリアプリで確認できる取引番号 | ○ |
再与信
要求電文 : MerpayReAuthorizeRequestDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
orderId | 取引ID | 半角英数字100桁以内 | 上記「orderId(取引ID)について」参照 | ○ |
originalOrderId | 元取引ID | 半角英数字100桁以内 | 随時決済の決済申込時に指定した取引IDを指定 | ○ |
serviceOptionType | サービスオプションタイプ | 右記参照 | 利用する決済方法のタイプを指定 "online":オンライン決済 |
○ |
amount | 決済金額 | 半角数字 7桁以内 |
決済金額を指定 1~1000000の間で指定できます。 |
○ |
withCapture | 与信同時売上フラグ | 右記参照 | "true":与信同時売上 "false":与信のみ(デフォルト値) ※未指定の場合、「"false":与信のみ」になります。 |
△ |
categoryId | 商品カテゴリID | 半角英数字 4桁以内 |
商品カテゴリを示すID 詳細は6.3.2商品カテゴリID一覧を参照 |
○ |
応答電文 : MerpayReAuthorizeResponseDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
serviceType | 決済サービスタイプ | 半角英数字f 10桁以内 |
要求電文を送信した決済サービスタイプ | ○ |
mstatus | 処理結果コード | 半角英数字 32文字以内 |
"success":正常終了 "failure":異常終了 "pending":保留 |
○ |
vResultCode | 詳細結果コード | 半角英数字 16文字 |
処理の結果を詳細に表すコード 4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。 詳細は『結果コード一覧』を参照下さい。 |
○ |
merrMsg | エラーメッセージ | 文字列 1024 byte以内 |
処理結果を日本語又は英語で表示 | ○ |
marchTxn | 電文ID | 文字列 100桁以内 |
決済サーバーにて決済処理電文(内部処理も含む)毎に付与するID 1つの取引IDに対して、複数のIDが付与されます。 |
○ |
orderId | 取引ID | 半角英数字 100桁以内 |
再与信要求時に店舗様にて任意に採番し送信された取引ID | ○ |
originalOrderId | 元取引ID | 半角英数字 100桁以内 |
再与信要求時に指定された随時決済の決済申込時に指定した取引ID | ○ |
merpayProcessingId | 決済センターとの取引ID | 半角英数字20桁 | 決済センターとの取引ID | △ |
inquiryCode | 問合せ番号 | 半角英数字 20桁以内 |
ユーザがメルカリアプリで確認できる取引番号 | △ |
custTxn | 取引毎に付くID | 文字列 100桁以内 |
決済サーバーがオーダー(取引ID)と紐付ける為に採番するID | ○ |
txnVersion | MDK バージョン | 半角英数字5桁 | 電文のバージョン 問題発生時などに用いますが、通常ご利用になることはありません。 |
○ |
解約
要求電文 : MerpayTerminateRequestDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
orderId | 取引ID | 半角英数字 100桁以内 |
随時決済の決済申込時に指定した取引IDを指定 | ○ |
serviceOptionType | サービスオプションタイプ | 半角英数字 | 利用する決済方法のタイプを指定 "online":オンライン決済 |
○ |
応答電文 : MerpayTerminateResponseDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
serviceType | 決済サービスタイプ | 半角英数字 10桁以内 |
要求電文を送信した決済サービスタイプ | ○ |
mstatus | 処理結果コード | 半角英数字 32文字以内 |
"success":正常終了 "failure":異常終了 "pending":保留 |
○ |
vResultCode | 詳細結果コード | 半角英数字 16文字 |
処理の結果を詳細に表すコード 4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。 詳細は『結果コード一覧』を参照下さい。 |
○ |
merrMsg | エラーメッセージ | 文字列 1024 byte以内 |
処理結果を日本語又は英語で表示 | ○ |
marchTxn | 電文ID | 文字列 100桁以内 |
決済サーバーにて決済処理電文(内部処理も含む)毎に付与するID 1つの取引IDに対して、複数のIDが付与されます。 |
○ |
orderId | 取引ID | 半角英数字 100桁以内 |
決済要求時に店舗様にて任意に採番し送信された取引ID | ○ |
merpayProcessingId | 決済センターとの取引ID | 半角英数字20桁 | 決済センターとの取引ID | △ |
custTxn | 取引毎に付くID | 文字列 100桁以内 |
決済サーバーがオーダー(取引ID)と紐付ける為に採番するID | ○ |
txnVersion | MDK バージョン | 半角英数字5桁 | 電文のバージョン 問題発生時などに用いますが、通常ご利用になることはありません。 |
○ |
共通
検索
-
「設定」欄の内容は以下の通りとなります。
- 要求電文 ...
- 必須項目:○ 任意項目:△ 設定不可:× その他条件付:※(条件は説明欄に記入)
- 応答電文 ...
- 必ず返戻:○ 該当取引存在時に返戻:△ 返戻なし:× その他条件付:※
-
「設定」欄の内容は以下の通りとなります。
例)exparam.serviceTypeCd[0]=card&exparam.serviceTypeCd[1]=merpay -
ワイルドカードは値の一部と"*"を組み合わせて検索します。"*"のみの指定はできません。
例)exparam.searchParameters.common.orderId=123*
要求電文 : SearchRequestDto | |||||||
---|---|---|---|---|---|---|---|
※以下は、共通の検索要求フィールドです。 |
|||||||
検索フィールド名 | 検索項目名 | 書式・制限 | 複数 指定 |
ワイルド カード |
説明 | 設定 | |
requestId | リクエストID | 半角英数字記号 128文字以内 |
リクエストIDを指定します。指定した場合は、それ以外のパラメータは指定できなくなります。 | △ | |||
serviceTypeCd | 決済サービスタイプ | 右記参照 | ○ | 検索対象の決済を指定します。未指定の場合は、全決済が検索対象となります。 "merpay": メルペイ |
△ | ||
newerFlag | 最新トランザクションフラグ | 右記参照 | 成功、失敗に関係なく、最新トランザクションのみを検索する場合に使用します。 "true": 1取引内の最新トランザクションのみ検索 "false": 全てのトランザクションを検索 ※指定しない場合は"false"になります。 |
△ | |||
containDummyFlag | ダミー決済対象フラグ | 右記参照 | ダミー取引も検索する場合に使用します。 "true": ダミー取引も検索する "false": ダミー取引は検索しない ※指定しない場合は"false"になります。 |
△ | |||
maxCount | 検索最大件数 | 1~1000 | 取得したい検索結果の最大件数です。未指定の場合、最大値となります。 ※短時間で大量の検索を繰り返すような処理はサーバーに負荷が掛かりますのでご遠慮頂けますようお願いします。 |
△ | |||
common 共通 | |||||||
orderId | 取引ID | 半角英数字 100桁以内 |
○ | 検索したい取引IDを指定します。 | △ | ||
orderStatus | 取引決済状態 | 右記参照 | ○ | 以下のいずれかを指定します。 " initial ":初期状態 " end ":終了 " pending ":保留 " validation_error ":検証エラー " error ":エラー |
△ | ||
command | コマンド | 右記参照 | ○ | 決済で使用するコマンドを指定します。 " Authorize ":申込(与信)/申込(与信+売上)/申込(承諾) " Cancel ":取消 " Capture ":返金 " Refund ":返金 " ReAuthorize ":再与信(与信)/再与信(与信+売上) " Terminate ":解約 |
△ | ||
mstatus | ステータスコード | 右記参照 | ○ | 決済結果として返戻されるステータスコードを指定します。 " success ":成功 " failure ":失敗 " pending ":保留 |
△ | ||
txnDatetime.from | 取引日(From) | 文字列12桁 | 取引日時の範囲(From)を指定します。 YYYYMMDDhhmm形式 |
△ | |||
txnDatetime.to | 取引日(To) | 文字列12桁 | 取引日時の範囲(To)を指定します。 YYYYMMDDhhmm形式 |
△ | |||
amount.from | 金額(From) | 数字12桁以内 | 決済金額の範囲(From)を指定します。 | △ | |||
amount.to | 金額(To) | 数字12桁以内 | 決済金額の範囲(To)を指定します。 | △ | |||
※以下は、メルペイ固有の検索要求フィールドです。 |
|||||||
merpay メルペイ | |||||||
merpayProcessingId | 詳細オーダー決済状態 | 半角英数字 20桁以内 |
決済センターとの取引ID | △ | |||
detailOrderType | 詳細オーダー決済状態 | 右記参照 | ○ |
※「detailOrderType」の詳細は6-2検索(Search)に関する補足(詳細コマンドタイプ/詳細オーダー決済状態)を参照 |
△ | ||
merpayServiceType | メルペイサービスタイプ | ○ | 決済申込時に指定したメルペイオンライン決済決済のタイプ(serviceOptionType) | △ | |||
detailCommandType | 詳細コマンドタイプ | 右記参照 | ○ |
※「detailCommandType」の詳細は6-2検索(Search)に関する補足(詳細コマンドタイプ/詳細オーダー決済状態)を参照 |
△ | ||
accountingType | 課金種別 | ○ | 決済申込時に指定したメルペイオンライン決済の課金種別(accountingType) 0."都度"(onetime)、1. "随時"(ondemand) |
△ | |||
inquiryCode | 問合せ番号 | 半角英数字 20桁以内 |
ユーザがメルカリアプリで確認できる取引番号 | △ | |||
originalOrderId | 元取引ID | 半角英数字 100桁以内 |
検索したい随時決済の決済申込時に指定した取引IDを指定します。 | △ | |||
consentAuthType | 承諾時決済タイプ | ○ | 決済申込時に指定した承諾時決済フラグ 0."承諾のみ"、1."承諾時決済" |
△ |
応答電文 : SearchResponseDto | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
※以下は、共通の検索結果フィールドです。 |
||||||||||
検索フィールド名 | 検索項目名 | 書式・制限 | 説明 | 設定 | ||||||
result | 処理結果 | - | ○ | |||||||
serviceType | サービスタイプ | 右記参照 | "search" | ○ | ||||||
mstatus | 処理結果コード | 半角英数字32文字以内 | 処理の結果ステータスが格納されます。 "success":正常終了 "failure":異常終了 |
○ | ||||||
vResultCode | 詳細結果コード | 半角英数字16文字 | 処理の結果を詳細に表すコードとなります。 詳細は『結果コード一覧』を参照下さい。 |
○ | ||||||
merrMsg | エラーメッセージ | 文字列1024 バイト以内 | 処理結果を日本語又は英語で表示します。 | ○ | ||||||
overMaxCountFlag | 最大件数超えフラグ | 右記参照 | 検索対象データが要求電文で指定した検索最大件数より多いかどうかを表します。 "true": 最大件数以上"false": 最大件数未満 |
△ | ||||||
searchCount | 検索結果件数 | 0~1000 | 検索結果件数(オーダー件数)が格納されます。 | △ | ||||||
orderInfos | オーダー情報リスト | 複数のオーダー情報(orderInfo)が格納されます。 | △ | |||||||
orderInfo | オーダー情報 | - |
検索条件に該当した取引の情報が該当件数分繰り返されます。0~1000件(要求電文で指定した検索最大件数まで)となります。 | △ | ||||||
index | インデックス | 0~999 | 検索された情報のインデックスが格納されます。 | △ | ||||||
serviceTypeCd | 決済サービスタイプ | 右記参照 | 決済の種類が格納されます。 "merpay": メルペイ |
△ | ||||||
orderId | 取引ID | 文字列 | 取引の取引IDが格納されます。 | △ | ||||||
orderStatus | 取引決済状態 | 右記参照 | 決済の状態が格納されます。 " initial ":初期状態 " end ":終了 " pending ":保留 " validation_error ":検証エラー " error ":エラー ※このフィールドは、取引IDに関連する注文データの状態を完全に表現するものではありません。サービスタイプによっては詳細な状態遷移を別のフィールドに保持している場合がありますので、店舗側システムの用途に合わせてsuccessDetailTxnTypeや、決済固有の状態フィールドをご参照ください。 |
△ | ||||||
lastSuccessTxnType | 最終成功トランザクションタイプ | 文字列 | 直近の成功したコマンド名が格納されます。 | △ | ||||||
successDetailTxnType | 詳細トランザクションタイプ | 文字列 | 取引の詳細な状態が格納されます。 検索要求電文の各決済の detailOrderType参照。 |
△ | ||||||
properOrderInfo | 固有オーダー情報 | - |
各決済サービスの固有オーダー情報が格納されます。後述の一覧参照。 | △ | ||||||
transactionInfos | 決済トランザクションリスト | - |
複数の決済トランザクション情報(transactionInfo)が格納されます。 | △ | ||||||
transactionInfo | 決済トランザクション情報 | - |
検索条件に該当した取引の情報が該当件数分繰り返されます。 | △ | ||||||
txnId | トランザクション管理ID | 文字列 | 決済サーバーが採番する管理IDとなります。 | △ | ||||||
command | コマンド | 文字列 | 実行されたコマンド名が格納されます。 ※MDKで要求したコマンドだけでなく、決済サーバーの内部処理コマンドも含まれます。 |
△ | ||||||
mstatus | 処理結果コード | 半角英数字 32文字以内 |
処理の結果ステータスが格納されます。 "success":正常終了 "failure":異常終了 "pending":保留 |
△ | ||||||
vResultCode | 詳細結果コード | 文字列16桁 | 処理の結果を詳細に表すコードとなります。 詳細は『結果コード一覧』を参照下さい。 |
△ | ||||||
txnDatetime | 取引日時 | 文字列23桁 | 取引日時が格納されます。 YYYY-MM-DD hh:mi:ss.mmm形式 |
△ | ||||||
amount | 金額 | 半角数字12桁以内 | 決済した金額が格納されます。 | △ | ||||||
properTransactionInfo | 固有トランザクション情報 | - |
各決済サービスの固有トランザクション情報が格納されます。後述の一覧参照。 | △ | ||||||
☆ 以下の情報は、上記 「固有オーダー情報」 「固有トランザクション情報」 内の階層にセットされます。 | ||||||||||
※以下は、メルペイ固有の検索結果フィールドです。 |
||||||||||
properOrderInfo | メルペイ 固有オーダー情報 | |||||||||
merpayServiceType | メルペイサービスタイプ | 文字列 | 決済申込時に指定したメルペイオンライン決済のタイプ(serviceOptionType) | △ | ||||||
accountingType | 課金種別 | 半角数字1桁 | 決済申込時に指定したメルペイオンライン決済の課金種別(accountingType) 0."都度"(onetime)、1. "随時"(ondemand) |
△ | ||||||
withCapture | 与信同時売上フラグ | 文字列 | 決済申込時に指定した与信同時売上フラグ | △ | ||||||
authorizeAmount | 申込金額 | 半角数字7桁以内 | 決済申込時に指定した金額 | △ | ||||||
captureAmount | 売上金額 | 半角数字7桁以内 | 売上時に指摘した金額 | △ | ||||||
balance | 残高 | 半角数字7桁以内 | 残高(現在の決済金額) | △ | ||||||
authorizeDatetime | 決済申込日時 | 文字列14桁 | 決済申込日時 YYYYMMDDhhmmss形式 |
△ | ||||||
consentAuthType | 承諾時決済タイプ | 半角数字1桁 | 決済申込時に指定した承諾時決済タイプ 0."承諾のみ"、1."承諾同時決済" |
△ | ||||||
originalOrderId | 元取引ID | 半角英数字 100桁以内 |
随時決済の決済申込時に指定した取引ID | △ | ||||||
preapprovalId | 事前承認ID | 半角英数字 50桁以内 |
随時決済の利用承諾済みの取引をメルペイで識別するためID | △ | ||||||
consentStatus | 承諾状態 | 右記参照 | 随時決済の利用承諾状態 "Init":初期状態 "Consent":承諾 "ConsentTerminate":解約 "ConsentDeregistration":抹消 |
△ | ||||||
properTransactionInfo | メルペイ 固有トランザクション情報 | |||||||||
merpayErrorCode | メルペイエラーコード | 文字列 | メルペイ側から返却されたエラーコード | △ | ||||||
detailCommandType | 詳細コマンドタイプ | 文字列 |
※「detailCommandType」の詳細は6-2検索(Search)に関する補足(詳細コマンドタイプ/詳細オーダー決済状態)を参照 |
△ | ||||||
storeId | 店舗ID | 半角英数字 32桁以内 |
決済申込時に指定した店舗ID ※オンライン決済では利用しません |
× | ||||||
teminalId | 店舗端末ID | 半角英数字 32桁以内 |
決済申込時に指定した店舗端末ID ※オンライン決済では利用しません |
× | ||||||
operatorId | 従業員ID | 半角英数字 128桁以内 |
決済申込時に指定した従業員ID ※オンライン決済では利用しません |
× | ||||||
slipCode | 伝票コード | 半角英数字 128桁以内 |
決済申込時に指定した伝票コード ※オンライン決済では利用しません |
× | ||||||
merpayResouceId | メルペイの管理ID | 半角英数字 128桁以内 |
メルペイ側で発番した管理ID ※オンライン決済では利用しません |
× | ||||||
merpayProcessingId | 決済センターとの取引ID | 半角英数字20桁 | 決済センターとの取引ID | △ | ||||||
merpayRequestDatetime | メルペイへの要求日時 | 文字列14文字 | メルペイへの要求日時が格納されます。 YYYYMMDDhhmmss形式 |
△ | ||||||
merpayResponseDatetime | メルペイからの返戻日時 | 文字列14文字 | メルペイからの返戻日時が格納されます。 YYYYMMDDhhmmss形式 |
△ | ||||||
inquiryCode | 問合せ番号 | 半角英数字 20桁以内 |
ユーザがメルカリアプリで確認できる取引番号 | △ |
結果通知電文
結果通知電文の概要
実装方法の詳細につきましては、弊社より提供しているサンプルプログラムをご参照ください。
-
機能概要
決済サーバーから店舗システムへ決済の結果通知を行います。
通知は、HTTPのPOSTを利用します。※プロトコルはHTTP(Port:80)、HTTPS(Port:443)に対応しています。
処理の概要については「結果通知受信処理」をご参照ください。 -
HMACについて
POSTにてデータを通知するとき、リクエストヘッダーにHMACを設定します。
また、HMAC値は、リクエストボディから算出します。
アルゴリズムは「HmacSHA256」が設定されます。フィールド名 設定値 content-hmac h={アルゴリズム名};s={CCID};v={HMAC値} -
結果通知受信処理結果について
決済サーバーからの通知に対して店舗側システムがHTTPステータスコード"200"を返戻した場合、受信処理が正常に終了したものと判断します。"200"以外のコードを返した場合は、受信失敗と判断し、一定期間、通知を繰り返します。
※ 規定の回数失敗した場合は、通知処理が停止しますのでご注意ください。
※ 決済サーバー側で"200"のコードを受信できなかった場合には、通知を繰り返すことがあります。
同じ通知が複数回届いた場合でも受信処理が正常に行われるように実装してください。
結果通知のタイミングと項目について
メルペイ(オンライン決済)における結果通知電文の通知タイミングは以下となります。
- メルペイ側で決済申込みが成立し、決済サーバーがメルペイからの通知を受信したタイミングとなります。
- メルペイ側で取引の抹消が行われ、日次バッチにより「抹消」のステータスを確認したタイミングとなります。
消費者が画面遷移の途中で離脱した場合や、通信環境の問題で画面遷移時にタイムアウトが発生した場合には、最終遷移先の完了画面URLまで到達しない場合がありますので、このような場合にも、決済サーバーからの通知を店舗側システムで受信して頂くことで、決済が成立したことを検知することができます。
No. | 通知機能 | 通知タイミング | 注意事項 |
---|---|---|---|
1 | 決済申込完了通知 (Authorize) |
決済申込が成立(成功)の通知を受信したタイミングで送信されます。 | 決済申込が失敗した場合は送信されません。 |
2 | 抹消通知 (Deregistration) |
日次バッチにより決済サーバーがメルペイへ「抹消」のステータスを確認したタイミングで送信されます。 | 「抹消」を確認した場合は、当該消費者の承諾終了となりますので、注意が必要です。 |
以下に、メルペイ(オンライン決済)の結果通知項目を示します。
項番 | フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 | |
---|---|---|---|---|---|---|
決済申込 | 抹消 | |||||
1 | numberOfNotify | 通知件数 | 半角数字 4桁以内 |
1度に通知可能な件数は100件、 101件以上は次回通知 |
○ | ○ |
2 | pushTime | 送信時刻 | 半角数字 14桁 |
ゲートウェイから通知した時刻 YYYYMMddHHmmss形式 |
○ | ○ |
3 | pushId | 識別ID | 半角数字 8桁 |
プッシュ処理を行うたびに採番されるID。 注)他の決済サービスで使用されたIDと重複する場合があります。 |
○ | ○ |
通知件数分下記の項番(4~31)を繰り返します。なお、フィールド名の後ろに4ケタの連番(0000~0999)を付与します。 | ||||||
4 | orderId | 取引ID | 半角英数字 100桁以内 |
取引ID | ○ | ○ |
5 | merpayProcessingId | 決済センターとの取引ID | 半角英数字 20桁以内 |
決済センターとの取引ID | ○ | ○ |
6 | inquiryCode | 問い合わせ番号 | 半角英数字 20桁以内 |
メルペイアプリで残高履歴から確認できる取引IID ※accountingType"1:随時"かつconsentAuthType"0:承諾のみ"の場合は通知しない |
△ | △ |
7 | txnType | トランザクションタイプ | 右記参照 | "Authorize":決済申込完了通知 "Deregistration":抹消通知 |
○ | ○ |
8 | txnTime | 処理日時 | 半角数字 14桁 |
YYYYMMddHHmmss形式 | ○ | ○ |
9 | vResultCode | 詳細結果コード | 半角数字4桁 | 処理結果コードの詳細は、 『結果コード一覧』をご参照ください。 |
○ | ○ |
10 | mstatus | 処理ステータス | 半角英数字 8桁以内 |
"success ":正常終了 (failureの場合は通知されません。) |
○ | ○ |
11 | amount | 決済金額 | 半角数字 7桁以内 |
決済申込時に指定した決済金額 |
△ | × |
12 | serviceOptionType | サービスオプションタイプ | 右記参照 | "online":オンライン決済 | ○ | ○ |
13 | accountingType | 課金種別 | 右記参照 | 決済申込時に指定したメルペイオンライン決済の課金種別(accountingType) 0:"都度" 1: "随時" |
○ | ○ |
14 | withCapture | 与信同時売上フラグ | 右記参照 | 決済時に指定した与信同時売上フラグ "true":与信同時売上 "false":与信のみ |
△ | △ |
15 | buyerNickname | 購入者ニックネーム | 文字列 40桁以内 |
メルペイへ保管されている購入者のニックネーム (※1) |
△ | × |
16 | buyerTelephone | 購入者電話番号 | 文字列 40桁以内 |
メルペイへ保管されている購入者の電話番号 (※1) |
△ | × |
17 | buyerEmail | 購入者メールアドレス | 文字列 100桁以内 |
メルペイへ保管されている購入者のメールアドレス (※1) |
△ | × |
18 | familyName | 配送先姓 | 文字列 100桁以内 |
メルペイへ保管されている購入者の配送先情報 (※2) |
△ | × |
19 | firstName | 配送先名 | 文字列 100桁以内 |
メルペイへ保管されている購入者の配送先情報 (※2) |
△ | × |
20 | familyNameKana | 配送先姓(カナ) | 文字列 100桁以内 |
メルペイへ保管されている購入者の配送先情報 (※2) |
△ | × |
21 | firstNameKana | 配送先名(カナ) | 文字列 100桁以内 |
メルペイへ保管されている購入者の配送先情報 (※2) |
△ | × |
22 | telephone | 配送先電話番号 | 半角数字 40桁以内 |
メルペイへ保管されている購入者の配送先情報 (※2) |
△ | × |
23 | zipCode1 | 配送先郵便番号(ハイフン前) | 半角数字 10桁以内 |
メルペイへ保管されている購入者の配送先情報 (※2) |
△ | × |
24 | zipCode2 | 配送先郵便番号(ハイフン後) | 半角数字 10桁以内 |
メルペイへ保管されている購入者の配送先情報 (※2) |
△ | × |
25 | prefecture | 配送先都道府県 | 文字列 100桁以内 |
メルペイへ保管されている購入者の配送先情報 (※2) |
△ | × |
26 | city | 配送先市町村 | 文字列 100桁以内 |
メルペイへ保管されている購入者の配送先情報 (※2) |
△ | × |
27 | address1 | 配送先番地等1 | 文字列 200桁以内 |
メルペイへ保管されている購入者の配送先情報 (※2) |
△ | × |
28 | address2 | 配送先番地等2 | 文字列 200桁以内 |
メルペイへ保管されている購入者の配送先情報 (※2) |
△ | × |
29 | preapprovalId | 事前承認ID | 半角英数字 50桁以内 |
随時決済の利用承諾済みの取引をメルペイで識別するためID ※accountingType"1:随時"の場合に通知 |
△ | ○ |
30 | consentAuthType | 承諾時決済タイプ | 右記参照 | 決済時に指定した承諾時決済タイプ "0":承諾のみ "1":承諾同時決済 ※accountingType"1:随時"の場合に通知 |
△ | ○ |
31 | dummy | ダミー決済フラグ | 半角数字 1桁 |
ダミー取引を示す場合は"1"を設定します。 | ○ | ○ |
※1 「MerpayAuthorizeRequestDto」の項目「useBuyerInfo」にtrueを設定した場合に通知します。
※2 「MerpayAuthorizeRequestDto」の項目「useDeliveryAddress」にtrueを設定した場合に通知します。
-
「設定」欄の内容は以下の通りです。
必ず返戻:○ 条件付きで返戻:△ 返戻なし:×
- pushId(識別ID)は、他の決済サービスで使用されたIdと重複する場合がありますので、ユニークキーとして処理しないようにしてください。
- amount(決済金額)およびwithCapture(与信同時フラグ)は、随時決済(承諾のみ)では設定されません。
- 項目の並び順は、必ずしも表の順序とは一致しません。
その他 補足事項
メルペイの注意事項
決済金額について
ユーザの決済可能な金額は、お支払用口座およびメルカリアプリの本人確認登録状態などにより異なります。 詳細はメルペイアプリのガイドをご確認ください。
返金について
与信売上方式では申込後、与信後売上方式では売上後の取引について返金を行うことができます。
-
返金結果が消費者に反映されるタイミングについて
返金結果は、残高へ即時に反映されます。 -
部分返金
部分返金については、残高を超えない範囲で、返金金額を指定できます。※部分返金は複数回の実施が可能となっております。
なお、残高を超えた返金を実施した際には詳細結果コード「KC02」が返却されます。
売上について
与信後売上方式では決済申込後の取引について売上を行うことができます。
-
部分売上
部分売上については、与信金額を超えない範囲で、売上金額を指定できます。※部分売上は1回のみ実施可能となっておりますので、ご利用の際はご注意ください。
なお、本番決済で2回目以降実施した際には詳細結果コード「KC01」が返却されます。
処理要求可能期間について
メルペイサービスにおける、各処理の要求可能期間を下表に示します。
要求種類 | 要求可能期間 |
---|---|
売上 | 決済申込(与信) または 再与信(与信) の取得から60日間 |
返金 | 売上確定(※)から365日間 ※売上確定する処理を以下に記載します。
|
消費者における支払い/申込時間制限
決済申込応答受領後「20分以内」に、消費者をメルペイの決済画面に遷移させて支払い手続きを完了させる必要があります。
時間制限を超えた場合、消費者による支払い手続きは完了できませんので、決済申込処理を最初からやり直していただくようご案内ください。
検索(Search)に関する補足(詳細コマンドタイプ/詳細オーダー決済状態)
決済サーバーでは、システム内部データとして詳細コマンド(処理要求の種類)と詳細な決済状態(その取引がどのような状態にあるか)を管理しています。
通常の運用では、店舗様システムではこれらの内部情報を利用する必要はありませんが、店舗様システムにおいて取引の状態検索が必要なケースや、障害等のお問い合わせ時の参照情報として、これらの内部データをSearchコマンドで公開しています。
下表にSearchコマンドにて利用可能な内部データの一覧を示します。
詳細コマンドタイプ | コマンド成功時の詳細オーダー決済状態 | ||
---|---|---|---|
論理名 | 値 | 論理名 | 値 |
決済認可 | PreAuth | 決済申込 | Init |
与信 | Auth | 与信 | Auth |
取消(与信) | VoidAuth | 取消(与信) | VoidAuth |
売上 | PostAuth | 売上 | PostAuth |
返金(売上) | RefundPostAuth | 売上 | PostAuth |
取消(売上) | VoidPostAuth | 取消(売上) | VoidPostAuth |
売上(与信売上) | AuthCapture | 与信売上 | AuthCapture |
返金(与信売上) | RefundAuthCapture | 与信売上 | AuthCapture |
取消(与信売上) | VoidAuthCapture | 取消(与信売上) | VoidAuthCapture |
承諾 | Consent | 承諾 | Consent |
解約 | ConsentTerminate | 解約 | ConsentTerminate |
注)一覧に記載していないコマンドタイプと状態も存在します。
申込要求電文(MerpayAuthorizeRequestDto)の補足事項
「5.1.1申込」の要求電文(MerpayAuthorizeRequestDto)の項目に対する補足事項を以下へ記載します。
個人情報(配送先情報・購入者情報)の要求について
メルペイより個人情報の提供を受けることができます。
取得できる個人情報は申込み時の審査で承認された項目のみとなります。
また、加盟店様が個人情報を受け取るには、ユーザがメルカリアプリで個人情報を提供することに同意する必要があり、
個人情報の提供の同意が行われない場合は、メルカリアプリよりキャンセル処理が行われ、MerpayAuthorizeRequestDtoで指定されたcancelUrlへリダイレクトされます。
※個人情報は決済申込の結果通知電文でのみ通知いたします。
結果通知受信に失敗した場合は、個人情報を取得できませんので、ご注意ください。
(結果通知電文は「5-3結果通知電文」を参照)
-
配送先情報
配送先情報フラグ(useDeliveryAddress)を設定することにより、決済処理時にメルペイより配送先情報の提供を受けることができます。これによってユーザはシームレスに商品の注文を行うことができます。 -
購入者情報
購入者情報フラグ(useBuyerInfo)を設定することにより、決済処理時にメルペイより購入者情報の提供を受けることができます。
商品カテゴリID一覧
カテゴリIDへ入力する一覧となります。
カテゴリIDは決済手段のメルペイスマート払いを利用するために必要な情報となる為、適切に設定してください。
金融庁のガイドラインでは、メルペイスマート払いを利用する場合は、その商品がどういった商品カテゴリ(衣類、コスメ、食品等々)であるかを、明示することを求めています。
なお、メルペイスマート払いは消費者が選択可能な決済手段で、利用不可とすることはできません。
カテゴリ名 | カテゴリID | |
---|---|---|
大カテゴリ | 中カテゴリ | |
ファッション | 衣類 | 1010 |
アクセサリー/腕時計 | 1011 | |
バッグ・小物・ブランド雑貨 | 1012 | |
家電 | 生活家電 | 1110 |
スマホ・携帯電話 | 1111 | |
PC・タブレット | 1112 | |
テレビ・映像機器 | 1113 | |
周辺機器 | 1114 | |
美容 | コスメ | 1210 |
医療品/健康食品 | 1211 | |
エンタメ | テレビゲーム | 1310 |
ホビー | 1311 | |
楽器・音楽機材 | 1312 | |
エンタメ用品 | 1313 | |
グルメ | 食品 | 1410 |
酒 | 1411 | |
住まい/暮らし | ソファ/ベッド | 1510 |
家具 | 1511 | |
日用品 | 1512 | |
スポーツ用品/アウトドア | 1513 | |
ベビー用品 | 1514 | |
本 | 1515 | |
車 | オートパーツ | 1610 |
その他 | 優待券/割引券/施設利用券 | 1710 |
金券 | 1711 | |
デジタルコンテンツ | 1712 | |
寄付/納税 | 1713 | |
その他 | 1714 |
かんたん出品連携について
-
概要
かんたん出品連携とは、メルカリユーザがメルペイを使ったECサイトでの購入時に、 メルカリユーザが商品情報を引き継ぐことで、メルカリの持ち物一覧に入りかんたんにメルカリで出品することができます。
-
かんたん出品連携の利用方法について
以下の条件を満たした場合に限り、簡単出品連携をご利用いただけます。- メルペイ利用申込時にかんたん出品連携機能の利用申込みが必要となります。
- 都度決済でのみご利用いただけます。
- 決済申込時に、以下「5.1.1申込 要求電文(MerpayAuthorizeRequestDto)」の商品情報の必須設定項目について、全てご指定いただく必要がございます。
※上記の条件が満たされていない場合でも、エラーとならず消費者の持ち物一覧への追加もされませんので、ご注意ください。
-
「設定」欄の内容は以下の通りです。
- 要求電文 ...
- 必須項目:○ 任意項目:△
※項目の詳細は「5.1.1申込」を参照
フィールド名 | 項目名 | 設定 |
---|---|---|
name | 商品名 | ○ |
description | 商品説明 | ○ |
imageUrl1 | 商品画像URL1 | ○ |
imageUrl2 | 商品画像URL2 | △ |
imageUrl3 | 商品画像URL3 | △ |
imageUrl4 | 商品画像URL4 | △ |
imageUrl5 | 商品画像URL5 | △ |
imageUrl6 | 商品画像URL6 | △ |
imageUrl7 | 商品画像URL7 | △ |
imageUrl8 | 商品画像URL8 | △ |
imageUrl9 | 商品画像URL9 | △ |
category | カテゴリ名 | △ |
size | サイズ | △ |
brand | ブランド名 | △ |
color | 色 | △ |
listPrice | 定価 | △ |
unitPrice | 購入時価格 | ○ |
quantity | 購入数 | ○ |
itemCode | 製品管理コード(SKU) | ○ |
janCode | JANコード | △ |
categoryId | 商品カテゴリID | ○ |
スマートフォン決済におけるメルカリアプリ起動についての注意事項
【スマートフォンブラウザ】決済処理開始時と完了時でのブラウザの違いによる問題
消費者様がスマートフォンブラウザからECサイトを利用する場合、決済処理でメルカリアプリを経由することで、処理開始と完了時でのブラウザが異なる可能性があります。
現在のメルペイの仕様上、Chromeで処理を開始した場合に限り、申込時にuserAgentを指定すれば完了時にもChromeに戻すことができますが、Chrome以外のブラウザの場合は、完了時に異なるブラウザに戻る可能性があります。
問題の詳細については以下のメルペイ仕様書の内容をご参照ください。
https://netpayment.merpay.com/partner/integration-guideline/#/partner_order_completion?id=決済開始時と完了時でのブラウザの違いによる問題
ID:mp6822263272
PASS:3R(qc&gFwNMp
このような問題に対しても弊社決済サーバーからブラウザを経由して連携する決済結果を受け取り、正常に処理できるように実装してください。
【スマートフォンアプリ(加盟店アプリ)】メルカリアプリ起動について
スマートフォンアプリ(以後、加盟店アプリと呼びます)を起点とした決済でメルカリアプリを起動するためには、各OS(iOS, Android)が提供するAPIを利用してpaymentUrlを開いてください。paymentUrlは、iOSの Universal Links、Androidの App Links として登録されています。
各OSの実装方法に応じた注意点がメルペイ仕様書に説明されていますので、内容をご参照ください。
https://netpayment.merpay.com/partner/integration-guideline/#/payment_on_smartphone_app
ID:mp6822263272 PASS:3R(qc&gFwNMp
【スマートフォンアプリ(加盟店アプリ)】決済後の加盟店アプリ起動について
メルカリアプリでの決済完了後、消費者導線を加盟店アプリに戻したい場合にディープリンク連携による遷移を行ってください。
ディープリンクとはHTTP/HTTPSのURLをアプリ側と紐付けることで、通常はブラウザでWebページが開かれる所をアプリ起動への置き換えが可能な機能です。
申込要求電文(MerpayAuthorizeRequestDto)の決済成功URL(successUrl)、決済キャンセルURL(cancelUrl)で指定可能なURLの接頭辞は"http(s)"となるため、"http(s)"以外のURLで加盟店アプリを起動する場合には、別途、加盟店アプリを起動するランディングページを作成して、この時の決済成功/決済キャンセルのURLに作成したランディングページのURLを指定してください。この時のランディングページは消費者環境の「標準ブラウザ」で表示されます。
ランディングページ作成の例)
以下の設定を持つ加盟店アプリに遷移したい場合のHTMLページのサンプルを示します。
- 起動時のURLスキーム : merpaysample
- 起動時のURLホスト : www.example.com
- 起動時のURLパス : result
ランディングページを経由する場合の決済時の消費者導線例は以下のようになります。
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML>
<HEAD>
<TITLE>アプリ起動</TITLE>
</HEAD>
<SCRIPT language="javascript" type="text/javascript">
window.location.href = "merpaysample://www.example.com/result";
</SCRIPT>
<BODY>
○○アプリを起動します。
</BODY>
</HTML>

導入・テストに関する補足
決済サーバーに接続し、テストを実施するための各種手続き・手順の詳細につきましては、『導入テストガイド』を参照してください。
決済申込時のエラー画面への画面遷移をシミュレートする
弊社では、メルペイ(オンライン決済)のテストのための疑似環境を提供しています。
Authorizeコマンドの結果として返戻されたレスポンスコンテンツを表示させると、以下の疑似環境に自動的に遷移します。



各画面の選択と、決済結果画面からの遷移先の対応表を以下に記載します。
アクセス許可画面 | 決済情報画面 | 決済内容確認画面 | 応答するURL | |
---|---|---|---|---|
ボタン | 決済結果選択 | |||
許可する | 確認画面へ | 支払う | 成功 | 決済申込で指定したsuccessUrl (成功) |
みなし成功 (メルカリからの結果通知を受信しない) |
決済申込で指定したsuccessUrl (みなし成功 ※1) |
|||
みなし成功 (決済確定処理でエラー) |
決済申込で指定したsuccessUrl (みなし成功 ※1) |
|||
失敗 (リダイレクトでエラー※結果通知は成功) |
システムエラー画面(※2) | |||
キャンセル | - | 決済申込で指定したcancelUrl | ||
失敗 (リダイレクトでエラー※結果通知は成功) |
システムエラー画面(※2) | |||
キャンセル | - | 決済申込で指定したcancelUrl |
※1みなし成功の処理結果コードは「K003」となります。
※2決済申込で指定したURL(successUrl、cancelUrl)への表示が失敗するパターンとなります。(結果通知は成功しています。)
決済内容確認画面の決済結果選択について
決済内容確認画面では、決済センターおよび決済サーバーの状態を疑似環境で再現させることができます。
-
成功
決済が正常に終了するパターンとなります。 -
みなし成功(メルカリからの結果通知を受信しない)
メルカリからの決済結果通知を受信できていない場合に「みなし成功」として応答するパターンとなります。※MAP(Merchant Administration Portal)もしくは検索コマンドにて決済状態をご確認ください。(このパターンは、最終ステータスが成功となるシミュレーションとなります。)
-
みなし成功(決済確定処理でエラー)
メルカリで決済処理が成功 かつ 決済サーバーの決済確定処理が失敗した場合に「みなし成功」として応答するパターンとなります。※MAP(Merchant Administration Portal)もしくは検索コマンドにて決済状態をご確認ください。(このパターンは、最終ステータスが失敗となるシミュレーションとなります。)
-
失敗(リダイレクトでエラー※結果通知は成功)
決済は正常に終了しているが、決済申込で指定したURLへの応答に失敗し、システムエラーを表示するパターンとなります。
決済申込・取消・売上・返金・再与信・解約のエラーをシミュレートする
Authorizeコマンドの要求金額("amount")、Captureコマンドの売上金額("amount")、Refundコマンドの返金金額("amount")、ReAuthorize("amount")の下一桁の値を調整することで、意図的にエラーを発生させることができます。(Captureコマンド、Refundコマンド、Terminateコマンドの金額未設定はAuthorizeコマンドリクエスト時の要求金額で判定されます。)
要求金額 下1桁 |
Authorize (申込み) |
Cancel (取消) |
Capture (売上) |
Refund (返金) |
ReAuthorize (再与信) |
Terminate (解約) |
---|---|---|---|---|---|---|
0 | K001(成功) | K001(成功) | K001(成功) | K001(成功) | K001(成功) | K001(成功) |
1 | KG10(失敗) | - | K001(成功) | KG10(失敗) | KG10(失敗) | - |
2 | K001(成功) | K001(成功) | K001(成功) | KED1 (ペンディング) |
K001(成功) | K001(成功) |
3 | K001(成功) | K001(成功) | K001(成功) | K001(成功) | KG19(抹消) | KG10(失敗) |
4 | K001(成功) | K001(成功) | K001(成功) | K001(成功) | KG15(失敗) | KG11(失敗) |
5 | K001(成功) | KG10(失敗) | KG10(失敗) | K001(成功) | K001(成功) | K001(成功) |
6 | K001(成功) | KED1 (ペンディング) |
KED1 (ペンディング) |
K001(成功) | K001(成功) | K001(成功) |
7 | KG11(失敗) | - | K001(成功) | KG11(失敗) | KG11(失敗) | - |
8 | K001(成功) | KG11(失敗) | KG11(失敗) | K001(成功) | K001(成功) | K001(成功) |
9 | K001(成功) | K001(成功) | K001(成功) | K001(成功) | K001(成功) | KED1 (ペンディング) |
- Terminate(解約)のエラーにつきましては、Authorizeコマンドリクエスト時の要求金額を指定できる「承諾時同時決済(consentAuthTypeへ"1"を設定)」でリクエストした場合にシュミレート可能です。
- 返戻されるエラーコード(vResultCode)につきましては、今後、予告なしに変更させて頂く場合がございます。