DGFT Veritrans4G開発ガイド

お問い合わせ
  • TOP
  • MDK(SDK)導入ガイド
  • MDK(SDK)インターフェースガイド
  • ID決済

Amazon Pay

本ガイドについて

本ガイドの内容

本ガイドは、株式会社DGフィナンシャルテクノロジーが提供するVeriTrans4GのAmazon Payサービスをインターネット店舗等に導入するための、Webアプリケーション開発者向けのガイドです。

Amazon Payサービス概要

Amazon Payサービスの概要

Amazon Payサービスは、加盟店のサイトで購入された商品の代金を、Amazon社が提供するAmazon Payサービス上で選択した支払い方法で決済できるサービスです。

  • Amazon Payサービスでは、ユーザがAmazonに登録した支払い方法と配送先情報を選択することができます。(購入のたびにユーザがこれらの情報を入力する必要はありません。)
    また、決済申込の際に新規の支払い方法や配送先情報を登録することも可能です。
    • 支払い方法について、2021年3月時点では、都度決済ではAmazonギフト券とクレジットカード、随時決済ではクレジットカードのみ利用可能です。その他の方法で支払いを行うことはできません。

      ※支払い方法については追加される可能性があります。
      支払い方法についてはAmazon PayのFAQなどを参照してください。

  • Amazon PayサービスはPC・スマートフォンのどちらにも対応しています。
    Amazon Pay決済の画面遷移のイメージを以下に示します。

    ※決済導入ページのお支払いボタンには以下のURLの画像のうちSandbox以外の画像を必ずお使いください。
    https://amazon-pay-v2.s3.ap-northeast-1.amazonaws.com/button_images/amazonpay_button_images.zip

・加盟店サイトでは「Amazonアカウントでお支払い」ボタン、決済導入ページ/Thanksページを作成していただきます。・決済導入ページではAmazonアカウントの住所/支払い情報から取得できない項目を入力します。・支払い方法は加盟店サイトに連携いたしません。・配送先情報は加盟店サイトに連携いたします。
図 2.1 画面遷移のイメージ

都度決済と随時決済

Amazon Payサービスでは、「都度決済」と「随時決済」の2種類の決済を行うことができます。

【都度決済機能】

消費者の購入した商品などについて、1回だけ決済を行います。
都度決済機能には以下の特徴があります。

  1. 都度決済の申込は、「課金種別」を未指定、あるいは都度決済を指定して行います。
  2. 都度決済の申込は、消費者の端末から行います。
  3. 与信のキャンセル、売上、売上後の返金、与信変更はMDKまたは管理画面(MAP)から可能です。

【随時決済機能】

店舗様と利用者の決済頻度についての承諾に基づき、その決済頻度にあわせて課金することができます。解約手続き(利用承諾の終了)が行われるまで、店舗様からの要求の都度、課金が発生します。

  1. 随時決済の申込(利用承諾)は、「課金種別」に随時決済を指定し、「頻度(単位)」と「頻度(値)」を設定して、都度決済と同様のフローで行います。
  2. 随時決済の申込時に「承諾時決済タイプ」を指定することで、「承諾のみ」か「与信+承諾」のいずれかを行うことができます。
    ※withCapture を指定することで申込と同時に売上処理も可能です。
  3. 随時決済の申込は、消費者の端末から行います。
  4. 課金する場合には、1.の取引IDを元取引IDに指定し、新しい取引IDで再与信することにより金額を確保します。

    ※withCaptureを指定することで同時に売上処理も可能です。

  5. 4.の取引IDに対して、キャンセル、売上、返金を実施します。
    再与信した取引のキャンセル、売上、売上後の返金はMDKまたは管理画面(MAP)から可能です。
  6. 随時決済の解約が行われるまで、4.5.を何度でも実施できます。
    ただし、13か月以上再与信を行わなかった場合は、Amazon Pay側で利用承諾終了となり、抹消通知が店舗様に通知されます。消費者側で解約が行われた場合にも抹消通知が店舗様に通知されます。
    また、金額、頻度を変えて再与信を行う場合は、承諾情報更新を実施する必要があります。
  7. 随時決済の解約はMDKまたは管理画面(MAP)から可能です。

配送先による金額の変更

Amazon Payサービスでは、決済申込フローの中で配送先の住所を選択することができます。選択された住所により配送料が異なる場合は、以下の方法で決済金額の変更を行います。

※決済申込時の決済確認画面に「決済サーバー画面」と「加盟店画面」を利用した2つのパターンがあり、それぞれで決済金額の変更方法が異なります。

【決済サーバー画面】を利用する場合

決済申込処理の完了後に「与信変更」コマンド(都度決済)、または「承諾変更」コマンド(随時決済)を実施します。
決済処理シーケンスは「決済申込時の処理(決済サーバーの決済確認画面利用)」を参照してください。

【加盟店画面】を利用する場合

決済申込フローの途中で「与信変更」コマンド(都度決済および随時決済)を実施します。
決済確認画面では消費者が配送先や支払い方法を変えるための処理を実装する必要があります。詳細については、「6-7決済申込での加盟店の決済確認画面の利用について」を参照してください。
決済処理シーケンスは「決済申込時の処理(加盟店の決済確認画面利用)」を参照してください。

MDKの処理概要

機能一覧(決済要求コマンド)

使用可能な決済要求コマンドを下記表に示します。

表 3.1使用可能なコマンド一覧
決済要求種類
/コマンド
概要
申込 (与信)
/Authorize
決済の申込のため、Amazon Payへのログインを要求します。
消費者の操作完了後に、与信(オーソリ)を要求します。
要求パラメータのaccountingTypeを1に設定した場合は、随時決済の申込を行います。
申込 (与信+売上)
/Authorize
決済の申込のため、Amazon Payへのログインを要求します。
消費者の操作完了後に、与信(オーソリ)と売上を同時に要求します。
要求パラメータのaccountingTypeを1に設定した場合は、随時決済の申込を行います。
申込(承諾)
/Authorize
随時決済の利用承諾のみを申込むための、Amazon Payへのログインを要求します。
消費者の操作完了後に、利用承諾を要求します。
要求パラメータのaccountingTypeを1に設定し、consentAuthTypeを0に設定することで
この決済要求が行えます。
売上
/Capture
申込済み取引の売上確定を要求します。
オーソリ金額を超えない範囲で売上金額を指定できます(部分売上)※1
申込キャンセル
/Cancel
売上前の取引に対して、与信(オーソリ)の取消を要求します。
オーソリ全額のキャンセルとなります。(オーソリの一部金額の取消は行えません。)
返金
/Refund
売上済の取引に対し、返金を要求します。
売上金額を超えない範囲で返金金額を指定できます(部分返金)※2
住所情報取得
/GetAddress
申込済みの取引に対して、消費者が選択した配送先情報を要求します。
購入者が処理途中でブラウザを閉じた場合など、申込結果の配送先情報を得られなかった場合には、当コマンドの結果により配送先情報を取得することができます。

※決済申込時に、加盟店の決済確認画面を利用するパターンでは、与信前に実行可能です。コマンドの結果により配送先情報を取得し、決済確認画面上に表示することや送料計算に利用することができます。

再与信
/ReAuthorize
随時決済の利用承諾を取得した取引を元取引として再度与信(オーソリ)を要求します。
解約
/Terminate
随時決済の利用承諾の終了を要求します。
承諾情報更新
/UpdateConsent
随時決済の承諾情報の更新を要求します※3
与信変更
/UpdateAuthorize
都度決済の、売上前または与信(オーソリ)取消前の取引に対してオーソリの変更を要求します※4
オーソリを取り直すため、売上の要求期限が与信変更を要求してから30日間に延長されます。

※決済申込時に加盟店の決済確認画面を利用するパターンでは、都度および随時決済両方で与信前でも実施可能です。

※1 部分売上を複数回行うことはできません。部分売上を行った場合の残りのオーソリ枠は解放されます
※2 部分返金は、決済金額の残り(残高)が0円になるまで繰り返し実行できます。
※3 承諾情報更新は解約を行うまで繰り返し実行できます。
※4 与信変更は売上、与信(オーソリ)の取消を行うまで繰り返し実行できます。

決済処理シーケンス

【決済申込時の処理(決済サーバーの決済確認画面利用)】

図 3.1 MDK利用時システム処理概要図(AmazonPay申込、決済サーバーの決済確認画面利用)
図 3.1 MDK利用時システム処理概要図(AmazonPay申込、決済サーバーの決済確認画面利用)
No. 基本機能 処理説明
1 決済申込要求 ECサイトに渡された決済申込情報を電文化し、決済サーバーに要求を送信します。
2 リダイレクト情報の受信 決済サーバーから返戻された結果を受信します。結果が成功(決済可能)の場合、「3.リダイレクト指示」を実施します。消費者ブラウザに返すHTMLコンテンツが決済サーバーより返戻された結果に含まれます。
3 Amazon Pay認証画面へのリダイレクト指示 決済サーバーにより返戻されたHTMLコンテンツを用いて、消費者ブラウザにAmazon Payの認証画面へのリダイレクト指示を送信します。
4 結果応答 決済結果を受け取り、注文データ等に反映します。

完了画面要求は、消費者の端末(PCやスマートフォン)のネットワーク環境の問題や、誤操作(ブラウザやタブを閉じてしまう等)により、正しく行われない可能性がありますので、必ずこの通知を受信してください。
なお、結果応答と完了画面要求のリダイレクト結果が加盟店に届く順番は保証されていません。どちらが先に届いても問題とならないようにご対応ください。

5 完了画面要求 決済サーバーから応答されたAmazon Payの決済結果を加盟店の画面などに表示し、消費者に決済結果をお伝えください。
決済サーバーからの返戻項目の詳細は、5.1.2消費者ブラウザから店舗側の決済完了画面へリダイレクトする時のリクエストパラメータを参照してください。

【決済申込時の処理(加盟店の決済確認画面利用)】

図 3.2 MDK利用時システム処理概要図(AmazonPay申込、加盟店の決済確認画面利用)
図 3.2 MDK利用時システム処理概要図(AmazonPay申込、加盟店の決済確認画面利用)
No. 基本機能 処理説明
1 決済申込要求 ECサイトに渡された決済申込情報を電文化し、決済サーバーに要求を送信します。
2 リダイレクト情報の受信 決済サーバーから返戻された結果を受信します。結果が成功(決済可能)の場合、「3.リダイレクト指示」を実施します。消費者ブラウザに返すHTMLコンテンツが決済サーバーより返戻された結果に含まれます。
3 Amazon Pay認証画面へのリダイレクト指示 決済サーバーにより返戻されたHTMLコンテンツを用いて、消費者ブラウザにAmazon Payの認証画面へのリダイレクト指示を送信します。
4 決済確認画面要求 ECサイトに決済確認画面の表示を要求します。
5 住所情報取得要求 決済確認画面に表示するための配送先や支払い方法の情報が必要な取引の情報を電文化し、決済サーバーに送信します。
6 住所情報取得応答 決済サーバーより住所情報取得応答を受信し、結果を加盟店サイトに返戻します。
7 決済確認画面表示 消費者に、支払い方法や配送先情報を表示するページを返戻します。
配送先の住所により金額変更がある場合は、新しい算出した金額を返戻するページに反映します。
8 与信変更要求 配送先の住所によって金額変更がある場合は、対象の取引情報を電文化し、決済サーバーに送信します。
9 与信変更応答 決済サーバーより与信変更の結果応答を受信し、結果情報を取得します。

※結果通知は送信しません。

10 リダイレクト指示 Amazon Payのサーバーへのリダイレクト指示を実施し、与信処理を進めます。
11 結果応答 決済結果を受け取り、注文データ等に反映します。

完了画面要求は、消費者の端末(PCやスマートフォン)のネットワーク環境の問題や、誤操作(ブラウザやタブを閉じてしまう等)により、正しく行われない可能性がありますので、必ずこの通知を受信してください。
なお、結果応答と完了画面要求のリダイレクト結果が加盟店に届く順番は保証されていません。どちらが先に届いても問題とならないようにご対応ください。

12 完了画面要求 決済サーバーから応答されたAmazon Payの決済結果を加盟店の画面などに表示し、消費者に決済結果をお伝えください。
決済サーバーからの返戻項目の詳細は、5.1.2消費者ブラウザから店舗側の決済完了画面へリダイレクトする時のリクエストパラメータを参照してください。

【売上処理】

図 3.3 MDK利用時システム処理概要図(AmazonPay 売上要求)
図 3.3 MDK利用時システム処理概要図(AmazonPay 売上要求)
No. 基本機能 処理説明
1 売上要求 売上の対象となる取引情報を電文化し、決済サーバーに送信します。
2 売上応答 決済サーバーより売上応答を受信し、結果を加盟店サイトに返戻します。

※Amazon Payの売上では、売上要求の受付応答時点で売上が成立しないことがあり、この場合は売上要求がAmazon側で受け付けられたかどうか、という結果を返戻します。ただし、直ちにAmazon側で処理完了の応答を行った場合は、売上応答として、処理が成功した旨の応答を行います。
※売上応答と結果応答が加盟店に届く順番は保証されていません。どちらが先に届いても問題とならないようにご対応ください。また、売上応答で処理結果を返した場合でも、結果応答を行います。

3 結果応答 決済サーバーより売上の結果応答を受信し、結果応答を行います。

【キャンセル処理】

図 3.4 MDK利用時システム処理概要図(AmazonPay キャンセル要求)
図 3.4 MDK利用時システム処理概要図(AmazonPay キャンセル要求)
No. 基本機能 処理説明
1 キャンセル要求 キャンセルの対象となる取引情報を電文化し、決済サーバーに送信します。
2 キャンセル応答 決済サーバーよりキャンセルの結果応答を受信し、結果を加盟店サイトに返戻します。

※キャンセル応答と結果応答が加盟店に届く順番は保証されていません。どちらが先に届いても問題とならないようにご対応ください。

3 結果応答 決済サーバーよりキャンセルの結果応答を受信し、結果応答を行います。
決済サーバーがAmazonからの応答を即時に得られなかった場合、決済サーバーからの問い合わせによりキャンセルの成立・不成立が明らかとなった場合に結果応答を行います。

【返金処理】

図 3.5 MDK利用時システム処理概要図(AmazonPay 返金要求)
図 3.5 MDK利用時システム処理概要図(AmazonPay 返金要求)
No. 基本機能 処理説明
1 返金要求 返金の対象となる取引情報を電文化し、決済サーバーに送信します。
2 返金応答 決済サーバーより返金の受付応答を受信し、結果を加盟店サイトに返戻します。

※Amazon Payの返金では、返金要求の受付応答時点で返金が成立することは稀であり、この時点では返金要求がAmazon側で受け付けられたかどうか、という結果を返戻します。ただし、直ちにAmazon側で処理完了の応答を行った場合は、返金応答として、処理が成功した旨の応答を行います。
※返金応答と結果応答が加盟店に届く順番は保証されていません。どちらが先に届いても問題とならないようにご対応ください。また、返金応答で処理結果を返した場合でも、結果応答を行います。

3 結果応答 決済サーバーより返金の結果応答を受信し、結果応答を行います。

【住所情報取得処理】

図 3.6 MDK利用時システム処理概要図(AmazonPay 住所情報取得要求)
図 3.6 MDK利用時システム処理概要図(AmazonPay 住所情報取得要求)
No. 基本機能 処理説明
1 住所情報取得要求 住所情報取得の対象となる取引情報を電文化し、決済サーバーに送信します。
2 住所情報取得応答 決済サーバーより住所情報取得の結果応答を受信し、結果情報を取得します。

【再与信処理】

図 3.7 MDK利用時システム処理概要図(AmazonPay 再与信要求)
図 3.7 MDK利用時システム処理概要図(AmazonPay 再与信要求)
No. 基本機能 処理説明
1 再与信要求 再与信の対象となる取引情報を電文化し、決済サーバーに送信します。
2 再与信応答 決済サーバーより再与信の結果応答を受信し、結果を加盟店サイトに返戻します。

※再与信応答と結果応答が加盟店に届く順番は保証されていません。どちらが先に届いても問題とならないようにご対応ください。

3 結果応答 決済サーバーより再与信の結果応答を受信し、結果応答を行います。

【解約処理】

図 3.8 MDK利用時システム処理概要図(AmazonPay 解約要求)
図 3.8 MDK利用時システム処理概要図(AmazonPay 解約要求)
No. 基本機能 処理説明
1 解約要求 解約の対象となる取引情報を電文化し、決済サーバーに送信します。
2 解約応答 決済サーバーより解約の結果応答を受信し、結果を加盟店サイトに返戻します。

※解約応答と結果応答が加盟店に届く順番は保証されていません。どちらが先に届いても問題とならないようにご対応ください。

3 結果応答 決済サーバーより解約の結果応答を受信し、結果応答を行います。
決済サーバーがAmazonからの応答を即時に得られなかった場合、決済サーバーからの問い合わせにより解約の成立・不成立が明らかとなった場合に結果応答を行います。

【承諾情報更新処理】

図 3.9 MDK利用時システム処理概要図(AmazonPay 承諾情報更新要求)
図 3.9 MDK利用時システム処理概要図(AmazonPay 承諾情報更新要求)
No. 基本機能 処理説明
1 承諾情報更新要求 承諾情報更新の対象となる取引情報を電文化し、決済サーバーに送信します。
2 承諾情報更新応答 決済サーバーより承諾情報更新の結果応答を受信し、結果情報を取得します。

【与信変更処理】

図 3.10 MDK利用時システム処理概要図(AmazonPay 与信変更要求)
図 3.10 MDK利用時システム処理概要図(AmazonPay 与信変更要求)
No. 基本機能 処理説明
1 与信変更要求 与信変更の対象となる取引情報を電文化し、決済サーバーに送信します。
2 与信変更応答 決済サーバーより与信変更の結果応答を受信し、結果を加盟店サイトに返戻します。

※与信変更応答と結果応答が加盟店に届く順番は保証されていません。どちらが先に届いても問題とならないようにご対応ください。

3 結果応答 決済サーバーより与信変更の結果応答を受信し、結果応答を行います。
決済サーバーがAmazonからの応答を即時に得られなかった場合、決済サーバーからの問い合わせにより与信変更の成立・不成立が明らかとなった場合に結果応答を行います。

結果通知受信処理

結果通知受信処理の対象

Amazon Payの結果通知受信処理の対象は以下の機能です。

表 4.1 通知対象一覧
決済要求種類 都度決済 随時決済
決済申込
売上
キャンセル
返金
住所情報取得
再与信
解約
抹消
承諾情報更新
与信変更 ○(※1)

通信電文仕様(共通部)および店舗様受信後応答仕様は、『開発ガイド』をご参照ください。
Amazon Pay固有の通知電文インターフェイスにつきましては、「5-3 結果通知電文」の「5.3.2 Amazon Payの結果通知電文」をご参照ください。

※1:決済申込で加盟店の決済確認画面を利用するパターンにおいて、決済申込処理の途中で与信変更を実施した場合は結果通知を送信しません。

インターフェイス詳細

ここではAmazon Payサービスで利用するMDKインターフェイス項目を説明します。

応答電文について

応答電文には、本書に記載されていないフィールド(パラメータ)も存在しますが、通常は、記載されているフィールド以外は加盟店の方で意識する必要はございません。

  • 「設定」欄の内容は以下の通りです。

    要求電文 ...
    必須項目:○  任意項目:△  設定不可:×  その他条件付:※、※n(条件は説明欄、または欄外に記入)
    応答電文 ...
    必ず返戻:○  処理成功時のみ返戻:△  返戻なし:×  その他条件付:※
  • orderId(取引ID)について

    店舗様で任意に採番してください。申込、再与信処理毎に付ける必要があります。他の取引IDと重複しないよう採番してください。他決済サービスとも重複できません。
    また、テスト取引で使用した取引IDを、本番取引で再度使用することはできません。
    取引IDには、半角英数字以外に"-"(ハイフン)、"_"(アンダースコア)も使用可能です。

  • 応答電文について

    応答電文には、本書に記載されていないフィールド(パラメータ)も存在しますが、通常は、記載されているフィールド以外は加盟店様の方で意識する必要はございません。

Amazon Pay

申込

要求電文 : AmazonpayAuthorizeRequestDto
フィールド名 項目名 書式・制限 説明 設定
orderId 取引ID 半角英数字
100桁以内
店舗側で採番した取引IDを指定
上記「orderId(取引ID)について」参照
accountingType 課金種別 右記参照 "0":都度決済
"1":随時決済

※未指定の場合は、'"0":都度決済となります。

consentAuthType 承諾時決済タイプ 右記参照 "0":承諾のみ
"1":与信+承諾

※課金種別が都度決済の場合は 指定できません。
※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用。

amount 決済金額 半角数字
8桁以内
決済金額を指定
- 都度決済:1~10000000の間
- 随時決済:1~100000の間
withCapture 売上フラグ 右記参照 "true":与信同時売上
"false":与信のみ

※未指定の場合は、"false":与信のみとなります。

suppressShippingAddressView 配送先表示抑止フラグ 右記参照 消費者がAmazon Payの提供する画面上で配送先を選択するかどうかを制御します。
"true":配送先非表示
"false":配送先表示

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用。

noteToBuyer 注文説明 文字列
 255byte以内
購入者のメールに表示される注文の説明
successUrl 完了時URL URLに使用可能な半角文字
256桁以内
決済申込成功時に、店舗側サイトに画面遷移を戻すためのURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用。

cancelUrl キャンセル時URL URLに使用可能な半角文字
256桁以内
決済申込を消費者がキャンセルした時に、店舗側サイトに画面遷移を戻すためのURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用。
※本番取引の場合、HTTPSプロトコルを設定する必要があります。

errorUrl エラー時URL URLに使用可能な半角文字
256桁以内
決済申込エラー時に、店舗側サイトに画面遷移を戻すためのURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用。

authorizePushUrl 与信時プッシュ先URL URLに使用可能な半角文字
256桁以内

※localhostを含むURLは指定不可

決済申込、再与信要求および与信変更要求が成立(成功または失敗)した時に、結果通知電文をプッシュする先のURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用。

capturePushUrl 売上時プッシュ先URL URLに使用可能な半角文字
256桁以内

※localhostを含むURLは指定不可

売上要求の処理結果が確定(成功または失敗)した時に、結果通知電文をプッシュする先のURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用。

cancelPushUrl キャンセル時プッシュ先URL URLに使用可能な半角文字
256桁以内

※localhostを含むURLは指定不可

キャンセル要求、返金要求および解約要求の処理結果が確定(成功または失敗)した時と、Amazon Payから抹消通知を受信した時に、結果通知電文をプッシュする先のURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用。

frequencyUnit 頻度(単位) 右記参照 随時決済の頻度の単位(例:2週間毎であれば、単位はWeek、値は2)
"Year":年
"Month":月
"Week":週
"Day":日

※課金種別が都度決済の場合は指定できません。

※課金種別が随時決済の場合は指定必須です。

6-4随時決済の頻度についてをご参照の上ご利用ください。

frequencyValue 頻度(値) 半角数字
3桁以内
随時決済の頻度の値(例:2週間毎であれば、単位はWeek、値は2)
- 頻度(単位)毎に設定できる範囲が異なります。
"Year":1のみ
"Month":1~12
"Week":1~52
"Day":1~365

※課金種別が都度決済の場合は指定できません。

※課金種別が随時決済の場合は指定必須です。

6-4随時決済の頻度についてをご参照の上ご利用ください。

addressRestrictions 配送先制限リスト 文字列
4,000字以内

配送先を制限するための許可リストまたは禁止リスト。

- リストには下記内容をJSON形式で指定する必要があります。

{"type": "【Allowed】", "restrictions": {
  "【countryCode】": {"statesOrRegions": ["【AA】"],"zipCodes": ["【99999】", "【99999】"]},
  "【countryCode】": {"statesOrRegions": ["【AA】"],"zipCodes": ["【999-9999】"]}, ...
}}

※【】で括られた部分は下記に従い適切な値を設定

"type":"Allowed"(許可) "NotAllowed"(禁止) "countryCode": 国名コード(日本:JP,アメリカ:US等のISO3166準拠コード) "statesOrRegions":都道府県等の地域名、アメリカは2桁の州略号(WA, CA, IL...) "zipCodes": 郵便番号、日本の場合は【999-9999】

例:東京都および東京以外の特定の郵便番号の地域のみ配送可能とする場合

{"type": "Allowed", "restrictions": {
  "JP": {"statesOrRegions": ["東京都"],"zipCodes": ["260-8667"]}
}}

※配送先の都道府県には通常"千葉県","東京都"といった値が設定されますが、消費者の入力次第で「東京」「Tokyo-to」などの文字が設定されることもあります。上記の例では「東京」「Tokyo-to」といった"東京都"以外の表記は許可されなくなりますのでご注意ください。

payConfirmScreenType 決済確認画面種別 右記参照 "0":決済サーバー決済確認画面利用
"1":加盟店決済確認画面利用

※未指定の場合は、"0":決済サーバー決済確認画面利用となります。

payConfirmScreenUrl 決済確認画面URL URLに使用可能な半角文字
256桁以内
決済確認画面への遷移時に、店舗側サイトに画面遷移を戻すためのURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用。
※未指定かつMAP(Merchant Administrator Portal)から登録申請した値が存在しない場合はエラーとなります。
※決済確認画面種別が"1":加盟店決済確認画面利用の場合のみ、指定可能。
※本番取引の場合、HTTPSプロトコルを設定する必要があります。

extendExpiration 与信期限延長フラグ 右記参照 課金種別が都度決済の場合に、ChargePermissionの有効期限を180日から13ヶ月に延長するか指定
"true":延長する
"false":延長しない

※未指定の場合は、"false":延長しないとなります。
※オーソリの有効期限30日を延長するわけではありません。 「与信変更」コマンドを行える期間が180日から13ヶ月に延長されることとなります。

応答電文 : AmazonpayAuthorizeResponseDto
フィールド名 項目名 書式・制限 説明 設定
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桁 電文のバージョン
問題発生時などに用いますが、通常ご利用になることはありません。
responseContents レスポンスコンテンツ 文字列 加盟店側で消費者に対して応答するHTMLコンテンツです。
自動でAmazon Payの画面に遷移するためのJavaScriptを含みます。

消費者ブラウザから店舗側の決済完了画面へリダイレクトする時のリクエストパラメータ

リダイレクト受信内容:決済サーバーから消費者ブラウザ経由で店舗側へリダイレクト(POST)される内容
フィールド名 項目名 書式・制限 説明 設定
mstatus 処理結果コード 半角英数字
32文字以内
"success":正常終了
"failure":異常終了
"pending":保留
vResultCode 詳細結果コード 半角英数
4桁
処理の結果を詳細に表すコード
詳細は『結果コード一覧』を参照して下さい。
orderId 取引ID 半角英数字
100文字以内
決済要求時に店舗様にて任意に採番し送信された取引ID
centerOrderId 決済センターの管理ID 文字列
64 byte以内
決済センターが注文毎に発番するID。
Amazonから購入者へ送信するメールに、注文番号として表示されます。
centerTransactionId 決済センターのトランザクション管理ID 文字列
64 byte以内
決済センターがトランザクション毎に発番するID。
結果通知の内容とリダイレクト受信内容を紐づけるための情報として使用できます。

※決済申込、売上、キャンセルの応答時は、決済センターが同じ値を返戻します。また、再与信、再与信取引の売上、再与信取引のキャンセルの応答時は、元取引とは別に、決済センターが同じ値を返戻します。

centerResponseDatetime センター応答日時 文字列
14桁
決済センターが決済申込要求に応答した日時
正常終了時であれば、決済申込の成立日時となります。
要求時にwithCaptureにtrueを指定した場合の正常終了時は、売上の成立日時となります。

※YYYYMMDDhhmmssの形式

shippingName 配送先:氏名 文字列
50byte以内
購入者がAmazonに登録している値を返します。
shippingPhone 配送先:電話番号 文字列
20byte以内
購入者がAmazonに登録している値を返します。
半角、全角、ハイフンありなど、購入者の入力次第です。
shippingAddress1 配送先:住所1 文字列
180byte以内
購入者がAmazonに登録している値を返します。
住所1~住所3でどのように住所が登録されているかは、購入者の入力次第です。
shippingAddress2 配送先:住所2 文字列
60byte以内
購入者がAmazonに登録している値を返します。
shippingAddress3 配送先:住所3 文字列
60byte以内
購入者がAmazonに登録している値を返します。
通常、会社名やマンション名用に利用されています。
shippingPrefecture 配送先:都道府県 文字列
 50byte以内
購入者がAmazonに登録している値を返します。
住所1~住所3に都道府県を含めて登録されているかは、購入者の入力次第です。
shippingPostalCode 配送先:郵便番号 文字列
20byte以内
購入者がAmazonに登録している値を返します。
半角、全角、ハイフンありなど、購入者の入力次第です。
buyerId 購入者ID 半角英数記号 決済センターが発番した購入者AmazonアカウントのユニークIDを返します。文字数は可変となります。
buyerEmail 購入者メールアドレス 半角英数記号
 64 byte以内
購入者のメールアドレスを返します。
vAuthInfo 改ざんチェック用
ハッシュ値
文字列
右記参照
下記文字列を連結し、SHA-256によって算出したハッシュ値
  • マーチャントCCID
  • パラメータ値の連結文字列(authParamsが示す順序で連結)
  • パスワード
なお、パラメータ値を連結する際は、パラメータ名や区切り文字は含めず、パラメータ値のみを連結しています。連結した文字列をバイナリに変換する際の文字エンコーディングは、UTF-8を使用しています。
authParams ハッシュ値算出パラメータ順序 文字列
右記参照

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

例)
  "orderId,vResultCode,mstatus"
  "mstatus,orderId,vResultCode"
(順序は固定ではないため、リクエスト受信のたびに動的に処理する必要があります。)

(重要)

これらのパラメータはブラウザを経由して連携されるため、画面遷移が正常に行われないケースでは取得することができません。そのため、決済サーバーから直接送信される「5-3 結果通知電文」の受信と組み合わせて確実に結果を取得するようにしてください。

vAuthInfoおよびauthParamsを利用した改ざんチェックについて

決済サーバーから消費者ブラウザを経由して店舗側の決済完了画面に遷移(リダイレクト)しますが、ここで店舗側システムが受け取ったリクエストパラメータが改ざんされていないことを検証するためのパラメータが、vAuthInfoとauthParamsです。
店舗側システムで算出したハッシュ値が、リクエストパラメータより取得したvAuthInfoと一致している場合は、パラメータは改ざんされていない、とみなすことができます。

この改ざんチェックは、悪意を持った第三者によって、不正なリダイレクト電文を受信する可能性がありますので、実装を強く推奨しています。
実装方法の詳細につきましては、弊社より提供しているサンプルプログラムをご参照ください。

リクエストパラメータは将来的に追加される可能性がございます。上記に定義されたフィールド名以外のフィールドが連携された場合でもエラーとならないようご注意ください。

※処理の途中でキャンセルを行った場合は、リダイレクトされることなくGETでcancelUrlに遷移するため、リクエストパラメータはありません。cancelUrl設定時に直接クエリパラメータを設定していた場合は、その値のままcancelUrlに遷移します。

売上

要求電文 : AmazonpayCaptureRequestDto
フィールド名 項目名 書式・制限 説明 設定
orderId 取引ID 半角英数字
100桁以内
都度決済:決済申込時の取引IDを指定
随時決済:決済申込時、または再与信時の取引IDを指定
amount 売上金額 半角数字
8桁以内
与信時に設定した決済金額以下を指定
1~決済金額の間で指定できます。

※未指定の場合は、与信時に設定した決済金額が売上金額となります。

応答電文 : AmazonpayCaptureResponseDto
フィールド名 項目名 書式・制限 説明 設定
serviceType 決済サービスタイプ 半角英数字
10桁以内
要求電文を送信した決済サービスタイプ
mstatus 処理結果コード 半角英数字
32文字以内
"success":正常終了
"failure":異常終了
"pending":保留

※Amazon側で売上要求に対して処理を行うまで時間が掛かる場合があるため、売上の受付状況を処理結果として返戻します。"success"または"pending"の場合は、Amazon側の処理後に結果通知を行うため、そちらで処理結果を判断してください。Amazon側で即時に売上が成立した場合でも、結果通知は行います。

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桁
電文のバージョン
問題発生時などに用いますが、通常ご利用になることはありません。
centerResponseDatetime 決済センター応答日時 文字列
14桁
決済センターが売上要求に応答した日時
Amazon側で売上要求を受け付けた日時となります。

※売上が成立した日時は、結果通知をご参照ください。

※YYYYMMDDhhmmssの形式

centerOrderId 決済センターの管理ID 文字列
64 byte以内
決済センターが注文毎に発番するID。
Amazonから購入者へ送信するメールに、注文番号として表示されます。
centerTransactionId 決済センターのトランザクション管理ID 文字列
64 byte以内
決済センターがトランザクション毎に発番するID。
結果通知の内容とリダイレクト受信内容を紐づけるための情報として使用できます。

※決済申込、売上、キャンセルの応答時は、決済センターが同じ値を返戻します。また、再与信、再与信取引の売上、再与信取引のキャンセルの応答時は、元取引とは別に、決済センターが同じ値を返戻します。

キャンセル

要求電文 : AmazonpayCancelRequestDto
フィールド名 項目名 書式・制限 説明 設定
orderId 取引ID 半角英数字
100桁以内
都度決済:決済申込時の取引IDを指定
随時決済:決済申込時、または再与信時の取引IDを指定
応答電文 : AmazonpayCancelResponseDto
フィールド名 項目名 書式・制限 説明 設定
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桁
電文のバージョン
問題発生時などに用いますが、通常ご利用になることはありません。
centerResponseDatetime 決済センター応答日時 文字列
14桁
決済センターがキャンセル要求に応答した日時
正常終了であれば、Amazon側でキャンセル要求を受け付けた日時となります。

※YYYYMMDDhhmmssの形式

centerOrderId 決済センターの管理ID 文字列
64 byte以内
決済センターが注文毎に発番するID。
Amazonから購入者へ送信するメールに、注文番号として表示されます。
centerTransactionId 決済センターのトランザクション管理ID 文字列
64 byte以内
決済センターがトランザクション毎に発番するID。(※)

※決済申込、売上、キャンセルの応答時は、決済センターが同じ値を返戻します。また、再与信、再与信取引の売上、再与信取引のキャンセルの応答時は、元取引とは別に、決済センターが同じ値を返戻します。

返金

要求電文 : AmazonpayRefundRequestDto
フィールド名 項目名 書式・制限 説明 設定
orderId 取引ID 半角英数字
100桁以内
都度決済:決済申込時の取引IDを指定
随時決済:決済申込時、または再与信時の取引IDを指定
amount 返金金額 半角数字
8桁以内
返金金額を指定。

※未指定時は、返金可能金額全額

応答電文 : AmazonpayRefundResponseDto
フィールド名 項目名 書式・制限 説明 設定
serviceType 決済サービスタイプ 半角英数字
10桁以内
要求電文を送信した決済サービスタイプ
mstatus 処理結果コード 半角英数字
32文字以内
"success":正常終了
"failure":異常終了
"pending":保留

※Amazon側で返金要求に対して処理を行うまで時間が掛かるため、返金の受付状況を処理結果として返戻します。
"success"の場合は、Amazon側の処理後に結果通知を行うため、そちらで処理結果を判断してください。

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桁
電文のバージョン
問題発生時などに用いますが、通常ご利用になることはありません。
centerResponseDatetime 決済センター応答日時 文字列
14桁
決済センターが返金要求に応答した日時
Amazon側で返金要求を受け付けた日時となります。

※返金が成立した日時は、結果通知をご参照ください。

※YYYYMMDDhhmmssの形式

centerOrderId 決済センターの管理ID 文字列
64 byte以内
決済センターが注文毎に発番するID。
Amazonから購入者へ送信するメールに、注文番号として表示されます。
centerTransactionId 決済センターのトランザクション管理ID 文字列
64 byte以内
決済センターがトランザクション毎に発番するID。
結果通知の内容とリダイレクト受信内容を紐づけるための情報として使用できます。
refundableAmount 返金可能金額 半角数字
8桁以内
売上金額から返金要求中と返金済みの取引の金額を減算した値を返します。

※応答時点で部分返金が行える残りの金額となりますが、Amazon側の処理により、返金要求中の取引が不成立となった場合は、返戻時点の値よりも大きくなることがあります。

住所情報取得

要求電文 : AmazonpayGetAddressRequestDto
フィールド名 項目名 書式・制限 説明 設定
orderId 取引ID 半角英数字
100桁以内
都度決済:決済申込時の取引IDを指定
随時決済:決済申込時、または再与信時の取引IDを指定
addInfoRespFlag 追加情報応答フラグ 右記参照 応答電文に追加情報を含めるかどうかのフラグ
"0": 含めない
"1": 含める

※未指定の場合、"0": 含めないを設定する

応答電文 : AmazonpayGetAddressResponseDto
フィールド名 項目名 書式・制限 説明 設定
serviceType 決済サービスタイプ 半角英数字
10桁以内
要求電文を送信した決済サービスタイプ
mstatus 処理結果コード 半角英数字
32文字以内
"success":正常終了
"failure":異常終了
vResultCode 詳細結果コード 半角英数字
16文字
処理の結果を詳細に表すコード
4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は別途『結果コード一覧』を参照して下さい。
merrMsg エラーメッセージ 文字列
1024 byte以内
処理結果を日本語で表示
orderId 取引ID 半角英数字
100桁以内
決済要求時に店舗様にて任意に採番し送信された取引ID
txnVersion MDK バージョン 半角英数字
5桁
電文のバージョン
問題発生時などに用いますが、通常ご利用になることはありません。
centerResponseDatetime 決済センター応答日時 文字列
14桁
決済センターが住所情報取得要求に応答した日時

※YYYYMMDDhhmmssの形式

shippingName 配送先:氏名 文字列
50byte以内
購入者がAmazonに登録している値を返します。
shippingPhone 配送先:電話番号 文字列
20byte以内
購入者がAmazonに登録している値を返します。
shippingAddress1 配送先:住所1 文字列
180byte以内
購入者がAmazonに登録している値を返します。
住所1~住所3でどのように住所が登録されているかは、購入者の入力次第です。
shippingAddress2 配送先:住所2 文字列
60byte以内
購入者がAmazonに登録している値を返します。
shippingAddress3 配送先:住所3 文字列
60byte以内
購入者がAmazonに登録している値を返します。
shippingPrefecture 配送先:都道府県 文字列
50byte以内
購入者がAmazonに登録している値を返します。
住所1~住所3に都道府県を含めて登録されているかは、購入者の入力次第です。
shippingPostalCode 配送先:郵便番号 文字列
20byte以内
購入者がAmazonに登録している値を返します。
半角、全角、ハイフンありなど、購入者の入力次第です。
buyerId 購入者ID 半角英数記号 決済センターが発番した購入者AmazonアカウントのユニークIDを返します。文字数は可変となります。
buyerEmail 購入者メールアドレス 半角英数記号
 64 byte以内
購入者のメールアドレスを返します。
buyerName 購入者名 文字列
60byte以内
購入者の名前を返します。

※追加情報応答フラグが"1"の場合のみ連携されます。

buyerPhoneNumber 購入者電話番号 文字列
60byte以内
購入者の電話番号を返します。

※追加情報応答フラグが"1"の場合のみ連携されます。

paymentPreferences 購入者支払方法 文字列
60byte以内
購入者が指定した支払方法を返します。

※追加情報応答フラグが"1"の場合のみ連携されます。

billingAddress1 請求先:住所1 文字列
60byte以内
請求先でAmazonに登録している値を返します。
住所1~住所3でどのように住所が登録されているかは、請求先の入力次第です。

※追加情報応答フラグが"1"の場合のみ連携されます。

billingAddress2 請求先:住所2 文字列
60byte以内
請求先でAmazonに登録している値を返します。

※追加情報応答フラグが"1"の場合のみ連携されます。

billingAddress3 請求先:住所3 文字列
60byte以内
請求先でAmazonに登録している値を返します。

※追加情報応答フラグが"1"の場合のみ連携されます。

billingPrefecture 請求先:都道府県 文字列
60byte以内

請求先でAmazonに登録している値を返します。
住所1~住所3でどのように住所が登録されているかは、請求先の入力次第です。

※追加情報応答フラグが"1"の場合のみ連携されます。

billingPostalCode 請求先:郵便番号 文字列
60byte以内
請求先でAmazonに登録している値を返します。
半角、全角、ハイフンありなど、購入者の入力次第です。

※追加情報応答フラグが"1"の場合のみ連携されます。

payRedirectUrl 決済確定URL URLに使用可能な半角文字
256桁以内
Amazon Payで決済処理を行うためのURLを返します。

※決済申込処理で加盟店の決済確認画面を利用するパターンの途中で実施した場合のみ連携されます。

checkoutSessionId CheckoutSession識別子 文字列
60byte以内
配送先変更、支払方法変更等に利用するAmazon発行のIDを返します。
本番取引で加盟店の決済確認画面を表示する際に使用します。

※決済申込処理で加盟店の決済確認画面を利用するパターンの途中で実施した場合のみ連携されます。

再与信

要求電文 : AmazonpayReAuthorizeRequestDto
フィールド名 項目名 書式・制限 説明 設定
orderId 取引ID 半角英数字
100桁以内
店舗側で採番した取引IDを指定
上記「orderId(取引ID)について」参照
originalOrderId 元取引ID 半角英数字
100桁以内
随時決済の決済申込時の取引ID
amount 決済金額 半角数字
6桁以内
決済金額を指定
1~100000の間で指定できます。
withCapture 売上フラグ 右記参照 "true":与信同時売上
"false":与信のみ

※未指定の場合は、"false":与信のみとなります。

noteToBuyer 注文説明 文字列
 255byte以内
購入者のメールに表示される注文の説明

※未指定の場合、元取引で設定された値が使用されます。

authorizePushUrl 与信時プッシュ先URL URLに使用可能な半角文字
256桁以内

※localhostを含むURLは指定不可

再与信要求が成立(成功または失敗)した時に、結果通知電文をプッシュする先のURLを指定(クエリパラメータ指定可)

※未指定の場合は、元取引の与信時プッシュ先URLを使用。元取引側も未指定の場合はMAP(Merchant Administrator Portal)から登録申請した値を使用。

capturePushUrl 売上時プッシュ先URL URLに使用可能な半角文字
256桁以内

※localhostを含むURLは指定不可

売上要求の処理結果が確定(成功または失敗)した時に、結果通知電文をプッシュする先のURLを指定(クエリパラメータ指定可)

※未指定の場合は、元取引の売上時プッシュ先URLを使用。元取引側も未指定の場合はMAP(Merchant Administrator Portal)から登録申請した値を使用。

cancelPushUrl キャンセル時プッシュ先URL URLに使用可能な半角文字
256桁以内

※localhostを含むURLは指定不可

キャンセル要求、返金要求の処理結果が確定(成功または失敗)した時に、結果通知電文をプッシュする先のURLを指定(クエリパラメータ指定可)

※未指定の場合は、元取引のキャンセル時プッシュ先URLを使用。元取引側も未指定の場合はMAP(Merchant Administrator Portal)から登録申請した値を使用。

応答電文 : AmazonpayReAuthorizeResponseDto
フィールド名 項目名 書式・制限 説明 設定
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桁
電文のバージョン
問題発生時などに用いますが、通常ご利用になることはありません。
centerResponseDatetime 決済センター応答日時 文字列
14桁
決済センターが再与信要求に応答した日時
Amazon側で再与信要求を受け付けた日時となります。
※再与信が成立した日時は、結果通知をご参照ください。

※YYYYMMDDhhmmssの形式

centerOrderId 決済センターの管理ID 文字列
64 byte以内
決済センターが注文毎に発番するID。
Amazonから購入者へ送信するメールに、注文番号として表示されます。
centerTransactionId 決済センターのトランザクション管理ID 文字列
64 byte以内
決済センターがトランザクション毎に発番するID。

※再与信、再与信取引の売上、再与信取引のキャンセルの応答時は、元取引とは別に、決済センターが同じ値を返戻します。

解約

要求電文 : AmazonpayTerminateRequestDto
フィールド名 項目名 書式・制限 説明 設定
orderId 取引ID 半角英数字
100桁以内
随時決済の決済申込時の取引IDを指定
応答電文 : AmazonpayTerminateResponseDto
フィールド名 項目名 書式・制限 説明 設定
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桁
電文のバージョン
問題発生時などに用いますが、通常ご利用になることはありません。
centerResponseDatetime 決済センター応答日時 文字列
14桁
決済センターが解約要求に応答した日時
Amazon側で解約要求を受け付けた日時となります。

※解約が成立した日時は、結果通知をご参照ください。

※YYYYMMDDhhmmssの形式

centerOrderId 決済センターの管理ID 文字列
64 byte以内
決済センターが注文毎に発番するID。
Amazonから購入者へ送信するメールに、注文番号として表示されます。

承諾情報更新

要求電文 : AmazonpayUpdateConsentRequestDto
フィールド名 項目名 書式・制限 説明 設定
orderId 取引ID 半角英数字
100桁以内
随時決済の決済申込時の取引IDを指定
amount 決済金額 半角数字
6桁以内
変更後の決済金額を指定
1~100000の間で指定できます。

※未指定の場合、更新されません。

frequencyUnit 頻度(単位) 右記参照 変更後の随時決済の頻度の単位(例:2週間毎であれば、単位はWeek、値は2)
"Year":年
"Month":月
"Week":週
"Day":日

※頻度(値)を設定した場合は設定が必須となります。

frequencyValue 頻度(値) 右記参照 変更後の随時決済の頻度の値(例:2週間毎であれば、単位はWeek、値は2)
- 頻度(単位)毎に設定できる範囲が異なります。
"Year":1のみ
"Month":1~12
"Week":1~52
"Day":1~365

※頻度(単位)を設定した場合は設定が必須となります。

noteToBuyer 注文説明 文字列
 255byte以内
変更後の購入者のメールに表示される注文の説明
再与信要求時に未指定だった場合のデフォルト値が、随時決済の決済申込時に設定した値から指定した値に更新されます。
応答電文 : AmazonpayUpdateConsentResponseDto
フィールド名 項目名 書式・制限 説明 設定
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桁
電文のバージョン
問題発生時などに用いますが、通常ご利用になることはありません。
centerResponseDatetime 決済センター応答日時 文字列
14桁
決済センターが承諾情報更新要求に応答した日時
Amazon側で承諾情報更新要求を受け付けた日時となります。

※YYYYMMDDhhmmssの形式

centerOrderId 決済センターの管理ID 文字列
64 byte以内
決済センターが注文毎に発番するID。
Amazonから購入者へ送信するメールに、注文番号として表示されます。

与信変更

要求電文 : AmazonpayUpdateAuthorizeRequestDto
フィールド名 項目名 書式・制限 説明 設定
orderId 取引ID 半角英数字
100桁以内
都度決済の決済申込時の取引IDを指定
amount 決済金額 半角数字
8桁以内
変更後の決済金額を指定
指定できる金額の上限は、「70000円か最初の与信時の金額の900%のうち高い方-現在の与信金額」となります。
(最大で10000000円が上限となります)
例:
最初に100円で与信した場合 70000-100=69900円
最初に10000円で与信した場合90000-10000=80000円

※未指定の場合、現在の決済金額で与信の取り直しを行います。

応答電文 : AmazonpayUpdateAuthorizeResponseDto
フィールド名 項目名 書式・制限 説明 設定
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桁
電文のバージョン
問題発生時などに用いますが、通常ご利用になることはありません。
centerResponseDatetime 決済センター応答日時 文字列
14桁
決済センターが与信変更要求に応答した日時
Amazon側で与信変更要求を受け付けた日時となります。

※YYYYMMDDhhmmssの形式

centerOrderId 決済センターの管理ID 文字列
64 byte以内
決済センターが注文毎に発番するID。
Amazonから購入者へ送信するメールに、注文番号として表示されます。
centerTransactionId 決済センターのトランザクション管理ID 文字列
64 byte以内
決済センターがトランザクション毎に発番するID。
payRedirectUrl 決済確定URL URLに使用可能な半角文字
256桁以内
Amazon Payで決済処理を行うためのURLを返します。

※決済申込処理で加盟店の決済確認画面を利用するパターンの途中で実施した場合のみ連携されます。

共通

検索

  • 「設定」欄の内容は以下の通りとなります。

    要求電文 ...
    必須項目:○  任意項目:△  設定不可:×  その他条件付:※(条件は説明欄に記入)
    応答電文 ...
    必ず返戻:○  該当取引存在時に返戻:△  返戻なし:×  その他条件付:※
  • 複数指定は0~の添字を指定します。

    例)exparam.serviceTypeCd[0]=card&exparam.serviceTypeCd[1]=amazonpay
  • ワイルドカードは値の一部と"*"を組み合わせて検索します。"*"のみの指定はできません。

    例)exparam.searchParameters.common.orderId=123*
要求電文 : SearchRequestDto
※以下は、共通の検索要求フィールドです。
検索フィールド名 検索項目名 書式・制限 複数
指定
ワイルド
カード
説明 設定
requestId リクエストID 半角英数字記号128文字以内 リクエストIDを指定します。指定した場合は、それ以外のパラメータは指定できなくなります。
serviceTypeCd 決済サービスタイプ 右記参照 検索対象の決済を指定します。未指定の場合は、全決済が検索対象となります。
"amazonpay":Amazon Pay
newerFlag 最新トランザクションフラグ 右記参照 成功、失敗に関係なく、最新トランザクションのみを検索する場合に使用します。
"true": 1取引内の最新トランザクションのみ検索
"false":全てのトランザクションを検索

※指定しない場合は"false"になります。

containDummyFlag ダミー決済対象フラグ 右記参照 ダミー取引も検索する場合に使用します。
"true":ダミー取引も検索する
"false":ダミー取引は検索しない

※指定しない場合は"false"になります。

maxCount 検索最大件数 1~1000 取得したい検索結果の最大件数です。未指定の場合、最大値となります。

※短時間で大量の検索を繰り返すような処理は決済サーバーに負荷が掛かりますのでご遠慮頂けますようお願いします。

common  共通
orderId 取引ID 半角英数字100桁以内 検索したい取引IDを指定します。
orderStatus 取引決済状態 右記参照 以下のいずれかを指定します。
" initial":初期状態
" end":終了
" end_presentation":画面遷移正常終了
" pending":保留
" validation_error ":検証エラー
" expired":期限切れ
" error":エラー
command コマンド 右記参照 決済で使用するコマンドを指定します。
" Authorize ":申込(与信または与信+売上)
" Capture":売上
" Cancel":与信取消
" Refund ":返金
" ReAuthorize":再与信
" Terminate":解約
" UpdateConsent":承諾情報更新
" UpdateAuthorize":与信変更
" AuthorizationNotify":(Amazonからの)与信通知
" CaptureNotify":(Amazonからの)売上通知
" CancelNotify":(Amazonからの)キャンセル通知
" RefundNotify":(Amazonからの)返金通知
" TerminateNotify":(Amazonからの)解約通知
" DeregistrationNotify":(Amazonからの)抹消通知
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)を指定します。
※以下は、Amazon Pay固有の検索要求フィールドです。
amazonpay Amazon Pay
detailOrderType 詳細オーダー決済状態 右記参照 ※「detailOrderType」の詳細は7-2検索(Search)に関する補足(詳細コマンドタイプ/詳細オーダー決済状態)を参照
detailCommandType 詳細コマンドタイプ 右記参照 ※「detailCommandType」の詳細は7-2検索(Search)に関する補足(詳細コマンドタイプ/詳細オーダー決済状態)を参照
centerOrderId 決済センターの管理ID 文字列
64 byte以内
決済センターが注文毎に発番するIDを指定します。
centerTransactionId 決済センターのトランザクション管理ID 文字列
64 byte以内
決済センターがトランザクション毎に発番するIDを指定します。
accountingType 課金種別 右記参照 "0":都度決済
"1":随時決済
consentAuthType 承諾時決済タイプ 右記参照 "0":承諾のみ
"1":与信+承諾
consentStatus 承諾状態 右記参照 随時決済の利用承諾状態を指定します。
"Init":初期状態
"Consent":承諾
"ConsentTerminate":解約
"ConsentDeregistration":抹消
originalOrderId 元取引ID 半角英数字
100桁以内
随時決済の決済申込時の取引IDを指定します。
payConfirmScreenType 決済確認画面種別 右記参照 "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 決済サービスタイプ 右記参照 決済の種類が格納されます。
"amazonpay":Amazon Pay
orderId 取引ID 文字列 取引の取引IDが格納されます。
orderStatus 取引決済状態 右記参照 決済の状態が格納されます。
" initial":初期状態
" end":終了
" end_presentation":画面遷移正常終了
" pending":保留
" validation_error ":検証エラー
" expired":期限切れ
" 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-DDhh:mi:ss.mmm形式
amount 金額 半角数字12桁以内 決済した金額が格納されます。
properTransactionInfo 固有トランザクション情報 各決済サービスの固有トランザクション情報が格納されます。後述の一覧参照。
☆ 以下の情報は、上記 「固有オーダー情報」 「固有トランザクション情報」 内の階層にセットされます。
※以下は、Amazon Pay固有の検索結果フィールドです。
properOrderInfo Amazon Pay 固有オーダー情報
authorizeAmount 申込金額 半角数字8桁以内 決済申込時に指定した金額

※与信変更が成立していた場合は最新の与信変更成立時に指定した金額

captureAmount 売上金額 半角数字8桁以内 売上時に指定した金額

※売上要求時に指定しなかった場合は申込金額

refundableAmount 返金可能金額 半角数字8桁以内 現在の返金可能金額
balance 残高 半角数字8桁以内 現在の残高
authorizeDatetime 決済申込日時 文字列14桁 決済申込日時
YYYYMMDDhhmmss形式
centerOrderId 決済センターの管理ID 文字列64byte以内 決済センターが発番した注文単位のID
accountingType 課金種別 右記参照 "0":都度決済
"1":随時決済
consentStatus 承諾状態 右記参照 随時決済の利用承諾状態
"Init":初期状態
"Consent":承諾
"ConsentTerminate":解約
"ConsentDeregistration":抹消
frequencyUnit 頻度(単位) 右記参照 決済申込時に指定した随時決済の頻度の単位
詳細は5.1.1 申込 要求電文:AmazonpayAuthorizeRequestDtoの「frequencyUnit」を参照
frequencyValue 頻度(値) 半角数字 3桁以内 決済申込時に指定した随時決済の頻度の値
詳細は5.1.1 申込 要求電文 :AmazonpayAuthorizeRequestDtoの「frequencyValue」を参照
originalOrderId 元取引ID 文字列 随時決済の決済申込時の取引ID
odAmount 随時決済金額 半角数字8桁以内 再与信要求時に設定するべき金額
payConfirmScreenType 決済確認画面種別 右記参照 "0":決済サーバー決済確認画面利用
"1":加盟店決済確認画面利用
properTransactionInfo Amazon Pay 固有トランザクション情報
centerTransactionId 決済センターのトランザクション管理ID 文字列64byte以内 決済センタートランザクション単位に発番するID
centerResultCode 決済センター結果コード 文字列 決済センターが返却する結果コード
centerStateCode 決済センター状態 文字列 決済センターが返却する状態
centerReasonCode 決済センター理由コード 文字列 決済センターが返却する状態の理由コード
detailCommandType 詳細コマンドタイプ 文字列

※「detailCommandType」の詳細は7-2検索(Search)に関する補足(詳細コマンドタイプ/詳細オーダー決済状態)を参照

centerRequestDatetime 決済センターへの要求日時 文字列14桁 決済センターへの要求日時が格納されます。
YYYYMMDDhhmmss形式
centerResponseDatetime 決済センターからの返戻日時 文字列14桁 決済センターからの返戻日時が格納されます。
YYYYMMDDhhmmss形式
frequencyUnit 頻度(単位) 右記参照 決済申込時に指定した随時決済の頻度の単位
詳細は5.1.1 申込 要求電文:AmazonpayAuthorizeRequestDtoの「frequencyUnit」を参照
frequencyValue 頻度(値) 半角数字 3桁以内 決済申込時に指定した随時決済の頻度の値
詳細は5.1.1 申込 要求電文:AmazonpayAuthorizeRequestDtoの「frequencyValue」を参照

結果通知電文

結果通知電文の概要

実装方法の詳細につきましては、弊社より提供しているサンプルプログラムをご参照ください。

機能概要

決済サーバーから店舗様システムへ決済の結果通知を行います。
通知は、HTTPのPOSTを利用します。

※プロトコルはHTTP(Port:80)、HTTPS(Port:443)に対応しています。
処理の概要については「結果通知受信処理」をご参照ください。

HMACについて

POSTにてデータを通知するとき、リクエストヘッダーにHMACを設定します。
また、HMAC値は、リクエストボディから算出します。
アルゴリズムは「HmacSHA256」が設定されます。

表 5.1 リクエストヘッダーに設定するHMACフィールド
フィールド名 設定値
content-hmac h={アルゴリズム名};s={CCID};v={HMAC値}

結果通知受信処理結果について

決済サーバーからの通知に対して店舗様システムがHTTPステータスコード"200"を返戻した場合、受信処理が正常に終了したものと判断します。"200"以外のコードを返した場合は、受信失敗と判断し、一定期間、通知を繰り返します。

※ 返戻した場合、受信処理が正常に終了したものと判断します。
※ 決済サーバー側で"200"のコードを受信できなかった場合には、通知を繰り返すことがあります。
同じ通知が複数回届いた場合でも受信処理が正常に行われるように実装してください。

Amazon Payの結果通知電文

Amazon Payにおける結果通知電文の通知タイミングは、下記となります。

表 5.2 Amazon Payの結果通知機能
No. 通知機能 通知タイミング 注意事項
1 決済申込結果通知
(Authorize)
決済申込が成立(成功または失敗)したタイミングで送信します。
決済申込が中断した場合は、成功または失敗が確定したタイミングで通知を行います。
購入前にブラウザを閉じた場合など、Amazonへの決済申込が行われなかった場合は、送信しません。
2 売上結果通知
(Capture)
売上要求の処理結果が確定(成功または失敗)したタイミングで送信します。
3 キャンセル結果通知
(Cancel)
キャンセル要求の処理結果が確定(成功または失敗)したタイミングで送信します。
4 返金結果通知
(Refund)
返金要求の処理結果が確定(成功または失敗)したタイミングで送信します。 複数回の返金要求を行った場合は、それぞれの確定時点で送信します。
5 再与信結果通知
(ReAuthorize)
再与信要求が成立(成功または失敗)したタイミングで送信します。
6 解約結果通知
(Terminate)
解約要求の処理結果が確定(成功または失敗)したタイミングで送信します。
7 抹消通知
(Deregistration)
決済サーバーがAmazon Payから抹消通知を受信したタイミングで送信します。 「抹消」通知を受信した場合は、当該消費者の承諾終了となりますので、注意が必要です。
8 与信変更結果通知
(UpdateAuthorize)
与信変更要求の処理結果が確定(成功または失敗)したタイミングで送信します。

以下に、Amazon Payの結果通知項目を示します。

表 5.3 Amazon Payの結果通知項目
項番 フィールド名 項目名 書式・制限 説明
1 numberOfNotify 通知件数 半角数字4桁以内 1度に通知可能な件数は100件、
101件以上は次回通知
2 pushTime 送信時刻 半角数字14桁 決済サーバーから通知した時刻
yyyyMMddHHmmss形式
3 pushId 識別ID 半角数字8桁 プッシュ処理を行うたびに採番されるID。

注) 他の決済サービスで使用されたIDと重複する場合があります。

通知件数分下記の項番(4~16)を繰り返す。なお、フィールド名の後ろに4ケタの連番(0000~0999)を付与する。
4 orderId 取引ID 半角英数字100桁以内 取引ID
5 txnType トランザクションタイプ ※右記の説明を参照 "Authorize":決済申込結果通知
"Capture":売上結果通知
"Cancel":キャンセル結果通知
"Refund":返金結果通知
"ReAuthorize":再与信結果通知
"Terminate":解約結果通知
"Deregistration":抹消通知
"UpdateAuthorize":与信変更結果通知
6 txnTime 処理日時 半角数字14桁 yyyyMMddHHmmss形式
7 vResultCode 詳細結果コード 半角英数字4桁 処理結果コードの詳細は、
結果コード一覧』をご参照して下さい。
8 mstatus 処理ステータス 半角英数字8桁以内 "success":正常終了
"failure":異常終了
9 centerOrderId 決済センターの管理ID 文字列64byte以内 決済センターが発番した注文単位のID
10 centerTransactionId 決済センターのトランザクション管理ID 文字列64byte以内 決済センターが発番したトランザクション単位のID
11 refundableAmount 返金可能金額 半角数字8桁以内 売上金額から返金要求中と返金済みの取引の金額を減算した値を返します。

※与信同時売上時の決済申込結果通知/売上結果通知/返金結果通知の場合に返します。

12 balance 残高 半角数字8桁以内 売上金額から返金済みの金額を減算した値を返します。

※与信同時売上時の決済申込結果通知/売上結果通知/返金結果通知の場合に返します。

13 dummy ダミー決済フラグ 半角数字1桁 ダミー取引を示す場合は"1"を設定する。
14 accountingType 課金種別 ※右記の説明を参照 "0":都度決済
"1":随時決済
以下は、随時決済利用時の場合に連携される項目です。
15 originalOrderId 元取引ID 半角英数字100桁以内 随時決済の決済申込時の取引ID
16 consentAuthType 承諾時決済タイプ ※右記の説明を参照 "0":承諾のみ
"1":与信+承諾
(注意事項)
  • pushId(識別ID)は、他の決済サービスで使用されたIdと重複する場合がありますので、ユニークキーとして処理しないようにしてください。
  • 項目の並び順は、必ずしも表の順序とは一致しません。
  • 結果通知は将来的にフィールドが追加される可能性がございます。上記に定義されたフィールド名以外のフィールドが連携された場合でもエラーとならないようご注意ください。

ご利用上の注意事項

ご利用前の設定

Amazon Payサービスのご利用にあたり、以下の設定を必ず行ってください。

証明書の設定

決済サーバーとAmazonの通信のため、証明書を設定していただきます。
設定されていない場合、結果コード:6H03が返戻されます。
以下のページをご参照いただき、Public Key IDとPrivate Keyファイルを作成・取得します。
Amazon Pay FAQ(v2) QA-59 http://amazonpay-integration.amazon.co.jp/amazonpay-faq-v2/detail.html?id=QA-59

※VeriTrans4GではSANDBOX環境をご利用いただけません。本番環境用の証明書を作成してください。

なお、手順に記載されている「ソリューションプロバイダもしくは、自社開発を選択」のドロップダウンでは「VeriTrans4G」を選択してください。

取得後、MAP(Merchant Administrator Portal)にログインし、「ツール」の「Amazon Pay 証明書管理」から証明書としてPublic Key IDとPrivate Keyファイルを登録します。

注)出品者IDが同じ場合は、Amazon Payの証明書が共有されます。複数のマーチャントIDで同じ出品者IDをご利用の場合、1つのマーチャントIDで証明書を登録すると、他のマーチャントIDにも証明書が同時に適用されます。

インスタント支払通知の設定

決済サーバーがAmazonから決済処理の結果通知を受信するため、インスタント支払通知の設定をしていただきます。
設定されていない場合、弊社とAmazonとの間での決済不整合の発生につながります。
また、5.3.2 Amazon Payの結果通知電文が通知されなくなる恐れがあります。
以下のページをご参照いただき、Amazon Pay(本番環境)のインスタント支払通知の設定を行います。

Amazon Pay FAQ(v2) QA-116 http://amazonpay-integration.amazon.co.jp/amazonpay-faq-v2/detail.html?id=QA-116

通知のエンドポイントは以下の通りです。

エンドポイント:https://api3.veritrans.co.jp/tercerog/webinterface/GWStreamRcv/amazonpay/Notify

売上要求、返金要求、中断について

Amazon Payサービスでは、Amazonとクレジットカード会社の間で返金処理を非同期で行うため、加盟店からの要求に対して、ある程度の時間が経過してから、処理結果が決定することになります。(直ちに処理されることもあります。)
決済サーバー側の処理としては、加盟店からの返金要求に対して、Amazonで要求を受け付けたことが確認できた時点で、受付成功(結果コードが6G01)の応答を返戻します。直ちに処理が完了した場合は、受付成功ではなく、処理成功(結果コードが6001)の応答を返戻します。
売上要求については、与信取得から約一週間経過した後に売上を行った場合には、Amazonで受付成功の応答を返戻することがあります。
また、各コマンドで決済サーバーがAmazonからの応答を受信できなかった場合や応答内容から取引結果が判別できずに取引状況が不明となった場合は、取引は中断状態となります。

処理結果が決定した場合には、決済サーバーから加盟店に結果通知を行います。

※パラメータ誤りなど、コマンドがAmazonへの要求前に失敗相当となった場合は、決済サーバーから加盟店への結果通知は行いません。

受付成功の後、失敗となる可能性があるため、受付成功の時点では要求は成立していないものとして扱ってください。
また、結果通知による処理結果は、通信状況によってはコマンド返戻より先に加盟店に届くことがある他、複数回同じ内容の結果通知が届くことがあります。このような場合にも加盟店側の処理として問題とならないようにご対応ください。

要求可能期間

Amazon Payサービスにおける、要求可能期限は下記となります。

表 6.1 要求可能期間
要求種類 要求可能期間
売上 都度決済の場合、与信取得または最新の与信変更から30日間
随時決済の場合、与信取得から30日間

※与信変更時は最長でも与信取得から180日以内(与信時にextendExpiration=trueを指定した取引は与信取得から13ヶ月以内)

例:
最新の与信変更日:与信取得から170日目⇒売上期限:与信取得から180日目
都度決済の売上で結果コード6G02が発生した際は要求可能期間外となっている可能性がありますので、与信変更の実施をご検討ください。

キャンセル 都度決済の場合、与信取得または最新の与信変更から30日間
随時決済の場合、与信取得から30日間
返金 売上(与信同時売上)から400日間

※Amazonとしては期限はありませんが、決済サーバー側で取引情報を保持している期間内(400日間)に限ります

住所情報取得 都度決済の場合、与信取得から180日間
随時決済の場合、与信取得から解約後30日間まで
再与信 最新の再与信から13か月

※再与信を行っていない場合は与信(承諾)取得から13か月

解約 最新の再与信から13か月

※再与信を行っていない場合は与信(承諾)取得から13か月

承諾情報更新 最新の再与信から13か月

※再与信を行っていない場合は与信(承諾)取得から13か月

与信変更 与信取得から180日間(与信時にextendExpiration=trueを指定した取引は与信取得から13ヶ月)

随時決済の頻度について

随時決済の決済申込の際に再与信を行う頻度(単位)と頻度(値)を設定していただきますが、設定した頻度と異なるタイミングで再与信を実施しても再与信は成立します。ただし、決済申込時の設定と実際の再与信の頻度が頻繁に異なる場合は、Amazon側の判断でアカウントを閉鎖される可能性がございます。可能な限り、設定した頻度で再与信を実施するようにご注意ください。
設定した頻度を変更したい場合、承諾情報更新を実施してください。 頻度の設定方法に関しては5.1.1 申込 要求電文:AmazonpayAuthorizeRequestDtoの「frequencyUnit」、「frequencyValue」をご参照ください。

Amazon Pay管理画面(セラーセントラル)について

Amazon Pay管理画面(セラーセントラル)では取引状態を変更しないでください。弊社とAmazonとの間での決済不整合の発生につながります。

Amazonマーケットプレイス保証について

Amazon Payサービスに登録された配送先について、加盟店と購入者が直接連絡して配送先を変更した場合はAmazonマーケットプレイス保証が適用されないリスクがあります。
Amazonマーケットプレイス保証の詳細につきましては、Amazon Payのサポートページ(https://pay.amazon.co.jp/help/201212410)よりご確認ください。

決済申込での加盟店の決済確認画面の利用について

決済申込で加盟店の決済確認画面を利用する場合、決済申込完了までに以下の処理を実装する必要があります。

  1. MDKの決済申込(Authorize)コマンド実施
    要求電文で決済確認画面種別(payConfirmScreenType)および決済確認画面URL(payConfirmScreenUrl)を設定する必要があります。
  2. 決済確認画面表示処理
    決済サーバーから加盟店が指定したURLにリダイレクトを行います。
    改ざんチェックのパラメータとして、リクエストパラメータで取引ID(orderId), ハッシュ値(orderHash)を付与します。

    ※決済確認画面表示後に配送先を変更したパターンなどで、本処理は複数回実施されることがございます。2回目以降の場合はAmazon Payにより上記以外のパラメータが付与されることがございますが、無視して問題ありません。

    決済確認画面に表示する内容、および配送先や支払い方法を変更するための実装は、Amazon Payのインテグレーションガイドを参照してください。
    なお、変更時に必要となるamazonCheckoutSessionIdは、
    住所情報取得(GetAddress)コマンド応答のcheckoutSessionIdの値をご使用ください。 https://developer.amazon.com/ja/docs/amazon-pay-checkout/display-shipping-payment-info.html

    配送先情報および支払い方法の情報取得に関しては、MDKの住所情報取得(GetAddress)コマンドを実施してください。取得した配送先住所を確認し、送料変更による金額変更が発生する場合は、決済確認画面には変更後の表示を実施し、「3.金額変更処理」で与信変更のコマンドを実施してください。
    また、応答電文で取得した決済確定URL(payRedirectUrl)は後の処理で必要になるため、取引と紐づけて保存する必要があります。

    [ハッシュ値による改ざんチェックについて]

    ハッシュ値の計算は以下の式で実施し、リクエストパラメータの値と一致するかご確認ください。merchantCcIdおよびパスワードは加盟店サーバーに保存されている値をご利用ください。
    「merchantCcId + 取引ID + パスワードをSHA-1でハッシュ化」

    ダミー取引で「お届け先修正」と「支払い方法変更」の遷移を確認する場合はダミー取引専用の処理が必要になりますので、「8-1決済申込時の画面遷移をシミュレートする」の「加盟店の決済確認画面を利用する場合」のセクションをご確認ください。

  3. 金額変更処理

    「2.決済確認画面表示処理」で金額変更が必要な場合は、与信変更(UpdateAuthorize)コマンドを実施して金額変更の電文を決済サーバーに送信してください。金額変更がない場合は与信変更コマンドの実施は不要です。
    与信変更コマンド実施後、「2.決済確認画面表示処理」で保存した決済確定URL、もしくは与信変更コマンドで取得した決済確定URLのうち新しいURLにリダイレクトするように処理してください。

  4. これ以降の処理は決済サーバーの決済確認画面を利用した場合と同様になります。

返金要求の失敗について

返金要求が失敗(結果コードが6G02)だった場合、購入者のAmazonアカウントが削除されていないか確認をしてください。 確認方法として、Amazon Pay管理画面(セラーセントラル)から対象の取引を確認した際に、購入者氏名の欄が「削除された購入者アカウント」と表示されているかどうかで確認することができます。

決済要求から24時間経過しても処理が確定しない場合について

決済要求(結果コードが6G01)が発生した取引に関して、24時間経過しても結果が確定しない場合、クレジットカード会社で処理が長引いている可能性がございます。 処理状況についての詳細はAmazon Pay管理画面(セラーセントラル)からAmazon側へ直接お問い合わせください。

通信プロトコルについて

Amazon Payは、安全な通信を確保するためにTLS1.0を使用して行われたリクエストをブロックします。 Amazon PayへのリクエストにはTLS1.1以降を使用する必要があります。

その他 補足事項

Amazon Payサービスの参考情報

選択可能な支払い方法や対象ブラウザその他、Amazon Payサービスの仕様につきましては、開発者向けページ対象ブラウザをご参照ください。

Amazon Payサービスのロゴ・マーク・バナーのご利用につきましてはAmazon Pay販売事業者様向けマーケティングガイドをご参照ください。

検索(Search)に関する補足(詳細コマンドタイプ/詳細オーダー決済状態)

決済サーバーでは、システム内部データとして詳細コマンド(処理要求の種類)と詳細な決済状態(その取引がどのような状態にあるか)を管理しています。
通常の運用では、店舗様システムではこれらの内部情報を利用する必要はありませんが、店舗様システムにおいて取引の状態検索が必要なケースや、障害等のお問い合わせ時の参照情報として、これらの内部データをSearchコマンドで公開しています。
下表にSearchコマンドにて利用可能な内部データの一覧を示します。

表 7.1 詳細コマンドタイプと詳細オーダー決済状態
詳細コマンドタイプ 詳細オーダー決済状態
論理名 論理名
認可 PreAuth 初期状態 Init
与信 Auth 与信 Auth
売上要求 PostAuthReq 与信 Auth
売上 PostAuth 売上 PostAuth
返金要求 RefundPostAuthReq 売上 PostAuth
返金 RefundPostAuth 売上 PostAuth
取消要求 VoidPostAuthReq 売上 PostAuth
取消 VoidPostAuth 取消 VoidPostAuth
売上(与信売上) AuthCapture 与信売上 AuthCapture
返金要求(与信売上) RefundAuthCaptureReq 与信売上 AuthCapture
返金(与信売上) RefundAuthCapture 与信売上 AuthCapture
取消要求(与信売上) VoidAuthCaptureReq 与信売上 AuthCapture
取消(与信売上) VoidAuthCapture 取消(与信売上) VoidAuthCapture
与信取消 VoidAuth 与信取消 VoidAuth
承諾 Consent 承諾 Consent

注) 一覧に記載していないコマンドタイプと状態も存在します。

決済サーバーの決済確認画面イメージ

決済サーバーが提供する決済確認画面を用いる場合、消費者には下記のような画面が表示されます。
決済確認画面では、消費者の選択した配送先、支払い方法、取引情報(取引ID、取引金額、お支払いサイクル)を表示します。
消費者は、「お届け先修正」ボタンと「支払い方法修正」ボタンにより、購入手続き前に配送先や支払い方法を変更できます。
配送先、支払い方法の変更処理の詳細を確認する場合は、Amazon Payのインテグレーションガイドをご参照ください。
https://developer.amazon.com/ja/docs/amazon-pay-checkout/display-shipping-payment-info.html

※配送先と「お届け先修正」ボタンは、配送先表示抑止フラグで非表示と指定した場合は表示しません。
※お支払いサイクルは都度決済の場合は表示しません。
※決済確認画面のイメージは2022年11月時点の内容となります。今後、予告なしに変更させていただく場合がございます。

図 7.1 決済サーバーの決済確認画面
図 7.1 決済サーバーの決済確認画面

導入・テストに関する補足

決済サーバーに接続し、テストを実施するための各種手続き・手順の詳細につきましては、『導入テストガイド 』を参照してください。

決済申込時の画面遷移をシミュレートする

弊社では、Amazon Payのテストのための疑似環境を提供しております。
Authorizeコマンドの結果として返戻されたレスポンツコンテンツ(AmazonpayAuthorizeResponseDto.responseContents)によって消費者のブラウザを遷移させると、以下の疑似環境が表示されます。
Amazon Payの認証画面のイメージが表示されますのでそのまま「ログイン」ボタンをクリックして次の画面に遷移します。

図 8.1 疑似環境(ダミーAmazon Pay-ログイン画面)
図 8.1 疑似環境(ダミーAmazon Pay-ログイン画面)

Amazon Payのお支払方法・お届け先選択画面が表示されます。
「続行」ボタンをクリックすることで以降の遷移を確認でき、「ログアウト」ボタンを押すことでログイン画面に戻ります。

図 8.2疑似環境(ダミーAmazon Pay-お支払方法・お届け先選択画面)
図 8.2疑似環境(ダミーAmazon Pay-お支払方法・お届け先選択画面)

加盟店の決済確認画面を利用する場合、
「お届け先修正」などのAmazon Payの画面に戻る遷移をシミュレートする場合は以下のように遷移するボタンを実装することで実現可能です。

要素:form
URL:https://api3.veritrans.co.jp/dummy-amazonpay/SelectAddressAndPaymentMethod
パラメータ:
名前:checkoutResultReturnUrl
値:[決済確認画面URL]?order_id=[ORDER_ID]&order_hash=[ORDER_HASH]
  決済確認画面URLは、申込要求電文で決済確認画面URLに設定した値
  ORDER_IDとORDER_HASHは、決済確認画面URLに遷移した際のクエリパラメータの値
例)https://example.com/payConfirmScreenUrl?order_id=testOrderId&order_hash=aaaaaaaabbbbbbbbccccccccddddddddeeeeeeee

コマンドのエラーをシミュレートする

Authorize、Capture、Refund、ReAuthorize、UpdateConsent、UpdateAuthorizeコマンドの要求金額("amount")の一の位の値を調整することで、意図的にエラーを発生させることができます。
Cancel、GetAddressコマンドは、対象取引の決済金額が要求金額に相当します。
(Captureコマンドで金額を指定しない場合は、対象取引の決済金額が要求金額に相当します。)
(Refundコマンドで金額を指定しない場合は、対象取引の返金可能金額が要求金額に相当します。)

Terminateコマンドは、対象取引の決済金額の千の位の値を調整することで、意図的にエラーを発生させることができます。
決済金額が1000未満の場合、千の位は"0"として処理されます。
要求金額の一の位と、返戻されるvResultCodeの対応表を以下に記載します。

要求金額の一の位 Authorize(決済申込)後、
確認画面移行時点
Authorize(決済申込)後の
消費者による操作完了時点 ※1
Authorize
の結果通知 ※2
ReAuthorize
(再与信)
Capture
(売上)
Capture(売上)
の結果通知
0 6001(成功) 6001(成功) - 6001(成功) 6001(成功) -
1 6GD1(失敗) - 6GD1(失敗) 6G01(受付) 6001(成功)
2 6001(成功) 6GD1(失敗) 6GD1(失敗)
3 6ED1(中断) 6GD1(失敗) 6ED1(中断) 6GD1(失敗) -
4 6001(成功) - 6001(成功) 6ED1(中断) 6GD1(失敗)
5 6ED2(中断) 6001(成功) 6ED2(中断) 6001(成功) -
6 6GD1(失敗) 6ED2(中断) 6001(成功)
7 6001(成功) - 6001(成功) 6GD1(失敗)
8 6001(成功) -
9

※1:Authorizeコマンドの返戻ではなく、消費者が操作完了した後に返戻する結果コードを記載しております。
  決済申込で加盟店の決済確認画面を利用するパターンにおいて、決済申込処理の途中でコマンドを実施した際の結果コードは下記の通りになります。
  金額の一の位が7の取引でGetAddressを実施 ... 6GD1(失敗)
  金額の一の位が9の取引でUpdateAuthorizeを実施 ... 6GD1(失敗)
  上記以外 ... 6001(成功)
※2:「決済申込の中断」「売上の受付」に対する結果通知を行う前に、後続処理の要求を行った場合は6C01(失敗)となります。

要求金額の一の位 Cancel
(キャンセル)
Cancel
(キャンセル)の結果通知
Refund
(返金)
Refund
(返金)の結果通知
GetAddress
(住所情報取得)※5
UpdateConsent
(承諾情報更新)
UpdateAuthorize
(与信変更)※6
0 6001(成功) - 6G01(受付) 6001(成功) 6001(成功) 6001(成功) 6001(成功)
1 - - 6GD1(失敗) 6GD1(失敗)
2 6GD1(失敗)
3 6GD1(失敗) - 6ED3(失敗)
4 6GD1(失敗) 6ED1(中断) 6GD1(失敗) 6001(成功) 6001(成功)
5 6001(成功) 6G01(受付) 6001(成功)
6 - - 6ED3(失敗) 6ED2(中断)
7 6ED2(中断) 6001(成功) 6ED2(中断) - 6001(成功) 6001(成功) 6001(成功)
8 6GD1(失敗) 6G01(受付) 6001(成功)
9 6001(成功) - 6001(成功) -

※3:決済申込、 ReAuthorizeコマンド、Captureコマンド、Cancelコマンド、Refundコマンド、UpdateAuthorizeコマンドで成功もしくは失敗となったダミー取引について、直ちに結果通知を行います。
※4:「決済申込の中断」「売上の受付」「売上の中断」「返金の受付」「キャンセルの中断」となったダミー取引について、下記の通り結果通知を行います。
金額の一の位が6の返金の取引 ... コマンド返戻の約30秒後に結果通知を行います。
金額の一の位が6、9以外の返金、9以外の売上、7のキャンセルの取引 ... コマンド返戻の約10秒後に結果通知を行います。
金額の一の位が3、5、6の決済申込、8のキャンセルの取引 ... コマンド返戻から数分後に結果通知を行います。(返戻までの間隔は不定となります。)
※5,6:決済申込処理の途中で実施するコマンドの結果コードにおいては、※1を参照してください。

返戻されるエラーコード(vResultCode)につきましては、今後、予告なしに変更させていただく場合がございます。

要求金額の千の位と返戻されるvResultCodeの対応表を以下に記載します。

要求金額の千の位 Terminate
(解約)
Terminate(解約)
の結果通知 ※2
Deregistration(抹消)
の通知 ※3
0 6001(成功) - -
1
2
3
4
5
6 6GD1(失敗)
7 6ED2(中断) 6001(成功)
8 6GD1(失敗)
9 6001(成功) - 6G14(失敗)

※1:Terminateコマンドで成功もしくは失敗となったダミー取引について、直ちに結果通知を行います。
※2:「解約の中断」となったダミー取引について、コマンド返戻の約10秒後に結果通知を行います。
※3:随時決済の「決済申込の成功」となったダミー取引について、金額の千の位が9の場合、コマンド返戻から約5分後に抹消通知を行います。

返戻されるエラーコード(vResultCode)につきましては、今後、予告なしに変更させていただく場合がございます。