Digital Goods インテグレーションガイド – エクスプレス チェック アウト編

Digital Goods
インテグレーションガイド –
エクスプレス チェック
アウト編
最終更新日: 2011年3月15日
Digital Goodsインテグレーションガイド – エクスプレス チェックアウト編
文書番号:10118.en_US-201103
© 2010 - 2011 PayPal, Inc. All rights reserved. PayPalはPayPal, Inc.の登録商標です。PayPalロゴはPayPal, Inc.の商標です。その他の商標およびブランドはそれ
ぞれ各社に帰属します。
本書に記載の情報はPayPal, Inc.に帰属します。PayPal, Inc.の書面による承認なしに情報を使用、複製、開示することはできません。Copyright © PayPal. All rights
reserved. PayPal S.à r.l. et Cie, S.C.A.、Société en Commandite par Actions登録住所:22-24 Boulevard Royal, L¬ 2449, Luxembourg, R.C.S. Luxembourg
B 118 349
消費者の皆様へのご注意- PayPal のストアドバリュー設備の保有者である PayPal Pte. Ltd. は、シンガポール通貨金融庁(Monetary Authority of Singapore)の承
認を必要としません。ご利用の際には、契約条件をよくご確認ください。
免責の告知:
PayPal,Inc.は、本書の内容を「現状有姿」で提供しており、その内容については一切保証しないものとします。PayPal, Inc.は本書の内容に関していかなる種類の(明示
的、暗示的、法的)保証もいたしません。PayPal, Inc.は、誤りや不備に起因する、あるいは本書または本書の内容を使用した結果生じる、あるいは本書に記載の製品また
はサービスの適用または使用の結果生じる(直接的または間接的)損害に対していかなる責任も負わないものとします。PayPal, Inc.は、本書に記載のいかなる情報も予告
なしに変更できる権利を有します。
目次
······················································································ 7
はじめに
本ガイドについて ························································································ 7
対象········································································································· 7
改訂履歴 ··································································································· 7
詳細情報の記載場所 ····················································································· 7
本書に対するフィードバック ·········································································· 7
Chapter 1
エクスプレス チェックアウトを利用したデジタルコンテンツ用
決済の紹介 ········································································ 9
デジタルコンテンツ用決済の紹介 ····································································· 9
エクスプレス チェックアウト ボタン ························································ 10
デジタルコンテンツ用決済の詳細 ······························································ 10
Digital Goodsが対応している支払い機能 ···················································· 14
デジタルコンテンツの取引後の処理 ··························································· 14
Digital Goodsが対応していない機能 ························································· 15
Digital Goodsに関する注意事項 ······························································· 16
Digital Goodsインテグレーションの概要 ························································· 16
デジタルコンテンツ用決済とエクスプレス チェックアウトの統合 ··························· 18
デジタルコンテンツの支払い取引の設定 ······················································ 19
買い手をペイパルにリダイレクトする························································· 21
ペイパルが買い手をお客様のウェブページにリダイレクトした後のアクション ······· 22
Digital Goods取引の完了 ······································································· 22
デジタルコンテンツ用決済フローを開始するウェブページの設定 ························ 23
Chapter 2
払戻しの実行 ··································································· 27
Chapter 3
定期支払いの処理 ······························································ 29
定期支払いのしくみ ··················································································· 29
制限事項 ···························································································· 30
定期支払いに関する用語 ·············································································· 30
定期支払い個人設定を作成する場合のオプション ················································ 31
正規支払い期間の指定 ············································································ 31
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
3
目次
オプションの試用期間の指定 ··································································· 32
初回支払いの指定 ················································································· 33
支払い不履行回数の上限 ········································································· 33
未払い金額の請求 ················································································· 34
デジタルコンテンツと有形商品の識別························································· 34
エクスプレス チェックアウトAPIを利用した定期支払い ······································· 34
SetExpressCheckoutを使用した処理フローの開始 ······································· 34
買い手をペイパルにリダイレクトする························································· 35
GetExpressCheckoutDetailsを使用して買い手の詳細情報を取得する ················ 35
CreateRecurringPaymentsProfileを使用して個人設定を作成する ····················· 36
定期支払い個人設定のステータス ··································································· 37
定期支払い個人設定情報の取得 ······································································ 37
定期支払い個人設定の変更 ··········································································· 38
請求金額の更新 ···················································································· 39
個人設定の未払い金額の請求 ········································································ 39
定期支払いの通知 ······················································································ 39
Chapter A
iframe終了オプション ······················································ 41
特定のURLに親ページを再読み込みする ··························································· 41
フレームを削除して親ページを再読み込みする··················································· 42
Chapter B
Digital GoodsをFlashに統合する方法 ································· 43
Digital GoodsをFlashに統合する ·································································· 43
Digital GoodsをFlashに統合する - サードパーティマーチャント ······························ 43
Chapter C
Digital Goodsが対応しているエクスプレス チェックアウト
APIフィールド ································································· 45
Digital Goodsが対応しているエクスプレス チェックアウトNVP APIフィールド ········· 45
SetExpressCheckout NVPリクエストフィールド ········································· 45
SetExpressCheckout NVPレスポンスフィールド ········································· 46
GetExpressCheckoutDetails NVPリクエストフィールド ······························· 46
GetExpressCheckoutDetails NVPレスポンスフィールド ······························· 46
DoExpressCheckoutPayment NVPリクエストフィールド ······························ 47
DoExpressCheckoutPayment NVPレスポンスフィールド ······························ 48
Digital Goodsが対応しているエクスプレス チェックアウトSOAP APIフィールド ······· 48
SetExpressCheckout SOAPリクエストフィールド ······································· 48
SetExpressCheckout SOAPレスポンスフィールド ······································· 49
4
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
目次
GetExpressCheckoutDetails SOAPリクエストフィールド······························ 49
GetExpressCheckoutDetails SOAPレスポンスフィールド······························ 49
DoExpressCheckoutPayment SOAPリクエストフィールド ···························· 50
DoExpressCheckoutPayment SOAPレスポンスフィールド ···························· 50
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
5
目次
6
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
はじめに
本ガイドについて
Digital Goodsインテグレーションガイド–エクスプレス チェックアウト編では、PayPal for Digital
Goodsの実装方法について説明します。
対象
本書は、エクスプレス チェックアウトAPIを使用してPayPal for Digital Goodsの実装を行うデベロッ
パーを対象としています。
改訂履歴
Digital Goodsインテグレーションガイド – エクスプレス チェックアウト編の改定履歴を以下に示し
ます。
発行日
改訂内容
2011/03/15
設定項目詳細の変数に関するメモをSetExpressCheckoutおよび
DoExpressCheckoutPaymentに追加し、デジタルコンテンツに対する割引を受けら
れるように修正した。
2011/03/08
バージョン69.0の情報に更新。定期支払いおよび参照取引を行うデジタルコンテンツの
ベストレートの取得方法についての説明を追加した。
2011/01/26
第一版発行
詳細情報の記載場所
z
マーチャント設定・管理ガイド
本書に対するフィードバック
本書の改良のために以下の宛先にフィードバックをお送りください。
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
7
はじめに
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
documentationfeedback@paypal.com
8
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
1
Chapter 1
エクスプレス チェックアウトを利用
したデジタルコンテンツ用決済の紹介
エクスプレス チェックアウトを利用したデジタルコンテンツ用決済(Digital Goods for Express
Checkout)は、買い手の決済処理を簡略化し、買い手がサイトから移動せずに商品を購入できるように
します。
z
9ページ「デジタルコンテンツ用決済の紹介」
z
16ページ「Digital Goodsインテグレーションの概要」
z
18ページ「デジタルコンテンツ用決済とエクスプレス チェックアウトの統合」
デジタルコンテンツ用決済の紹介
デジタルコンテンツ用決済は、JavaScriptとエクスプレス チェックアウトAPIを統合して、買い手のデ
ジタルコンテンツの決済処理を簡略化します。
デジタルコンテンツとは、電子形式で配信される電子書籍、音楽ファイル、デジタル画像などの商品です。
通常デジタルコンテンツの価格は数百円程度です。買い手はサイトを移動したり、オンライン操作を中
断したりすることなく、最小限のクリック操作で決済を行い、簡単にデジタルコンテンツを購入するこ
とができます。
デジタルコンテンツ用決済の概要を以下の図に示します。
PayPal for digital goods による支払いpayments
買い手は以下の操作を行います。
1. [Pay With PayPal] (PayPalで支払い)ボタンをクリックします。
ボタンをクリックすると、SetExpressCheckout API操作が呼び出されます。ペイパルがお客様の
サイトの上にポップアップウィンドウを表示し、このウィンドウに買い手をリダイレクトします。
2. [Pay](支払い)ボタンをクリックして注文を確定します。
JavaScriptコードが実行され、ポップアップウィンドウを閉じます。
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
9
エクスプレス チェックアウトを利用したデジタルコンテンツ用決済の紹介
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
3. ウィンドウが閉じたら、お客様のサイトで注文の確認を行います。
4. お客様のサイトで操作を再開します。
エクスプレス チェックアウト ボタン
デジタルコンテンツ用決済を実装するには、下の図のボタンをウェブページにインストールしてください。
ボタンは次のURLで入手できます。
https://www.paypal.com/en_US/i/btn/btn_dg_pay_w_paypal.gif
注: PayPal画像のコピーをお客様のローカルサーバー上にホストしないでください。古いPayPal 画像を
使用するとサイトへの信頼性が低下する可能性があります。
デジタルコンテンツ用決済の詳細
デジタルコンテンツ用決済画面は、買い手にはお客様のサイトの一部のように見えます。ペイパルの
JavaScriptがフローを買い手のブラウザのiframeに設定し、お客様のサイトの上にミニブラウザをポッ
プアップ表示します。
買い手はお客様のサイトで[Pay with PayPal]ボタンをクリックし支払いを開始します。
ペイパルはフローを開始するJavaScriptに応答します。買い手が初めてペイパルによる支払いを利用す
る場合、または買い手がログインする必要があるとペイパルが判断した場合、[Log In](ログイン)ボ
タンがiframeに表示されます。
10
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
エクスプレス チェックアウトを利用したデジタルコンテンツ用決済の紹介
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
買い手はペイパルアカウントを取得するか、ログインが不要なゲストとして決済するかを選択できます。
注: ゲストとして決済することはデジタルコンテンツ決済において表示画面がわかりやすくなることで
す。決済手順が少なくなるわけではありません。
ログインをクリックすると、
「Log in to your PayPal account」
(PayPalアカウントにログインし
ます。
)のページ()がミニブラウザに表示されます。買い手はメールアドレスとパスワードを入力します
が、チェックボックスにチェックを入れて次回から入力を省略することも可能です。
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
11
エクスプレス チェックアウトを利用したデジタルコンテンツ用決済の紹介
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
上記のチェックボックスでログイン情報の保存を制御しています。アカウントが不正に利用される危険
がないと判断された場合、この保存機能によって買い手はログイン手順を省略できます。
重要: ログイン情報の保存機能を設定していても、ログインを要求される場合があります。
ログイン後、ミニブラウザに「You are about to pay」(お客様の購入アイテムは次のとおりです。
)
のページが表示されます。
12
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
エクスプレス チェックアウトを利用したデジタルコンテンツ用決済の紹介
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
買い手が[Cancel](キャンセル)ボタンを選択した場合は、SetExpressCheckout APIオペレーショ
ンのリクエストメッセージで指定したキャンセルURLにリダイレクトします。[Pay]ボタンを選択した
場合、
「Thank you for using PayPal 」
(PayPalをご利用いただきありがとうございます)のペー
ジがミニブラウザに表示されます。
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
13
エクスプレス チェックアウトを利用したデジタルコンテンツ用決済の紹介
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
買い手が[Close](閉じる)ボタンをクリックすると、SetExpressCheckout APIオペレーションのリ
クエストメッセージで指定した復帰URLへリダイレクトします。
ログイン情報が保存されている場合、次回からミニブラウザでのログイン操作を省略します。お客様に
よるフローの開始およびiframeを閉じるアクションには変更ありません。
Digital Goodsが対応している支払い機能
Digital Goodsでは以下の支払い機能を使用できます。
z
定期支払い。デジタルコンテンツが対応していない機能もあります。詳細は15ページ「Digital Goods
が対応していない機能」を参照してください。
デジタルコンテンツの取引後の処理
デジタルコンテンツの支払い取引を行った後、ペイパルAPIオペレーションを使用して以下のバックオ
フィス処理を行うことができます。
z
14
払戻しの実行
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
エクスプレス チェックアウトを利用したデジタルコンテンツ用決済の紹介
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
z
取引詳細の取得
z
取引の検索
Digital Goodsが対応していない機能
Digital Goodsは、次のガイドに記載のエクスプレス チェックアウト機能のうち、以下に挙げる機能に
対応していません。
エクスプレス チェックアウト応用機能ガイド
z
有形商品
デジタルコンテンツは、買い手がオンラインでダウンロードまたはアクセスを行うデジタルメディア
です。
z
配送先住所
電子メディアをダウンロードするだけなら配送先住所は不要です。
z
即時更新API
ペイパルサーバーがお客様のコールバックサーバーを呼び出し、買い手が変更した配送オプションに
基づきペイパルページの即時更新を行います。
z
並行支払い
パラメータフィールドに10件までの支払い処理の詳細を記述できます。Digital Goodsでは1件の支
払い処理の値しか記述できません。
z
即時支払い
即時支払いは、買い手が商品を購入した時点で支払いを受領します(即時支払いメソッドのみ)
。
z
与信APIと回収API
z
SetCustomerBillingAgreement API
z
Giropay
z
インセンティブ
Digital Goodsは以下の表に示す定期支払いAPIフィールドに対応していません。ペイパルNVPおよび
SOAP APIの各参照文書では以下のフィールドを使用しないでください。
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
15
エクスプレス チェックアウトを利用したデジタルコンテンツ用決済の紹介
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
Digital Goodsに関連しない定期支払いおよび参照取引のNVP APIフィールド
SHIPTONAME
SHIPTOSTREET
SHIPTOSTREET2
SHIPTOCITY
SHIPTOSTATE
SHIPTOZIP
SHIPTOCOUNTRY
SHIPTOCOUNTRYCODE
SHIPTOPHONENUM
SHIPPINGAMT
REGULARSHIPPINGAMT
Digital Goodsに関連しない定期支払いおよび参照取引のSOAP APIフィールド
Name
Street1
Street2
CityName
StateOrProvince
PostalCode
Country
Phone
ShippingAmount
Digital Goodsに関する注意事項
Digital Goodsの統合に関して、以下の注意事項をお読みください。
z
サイトに直接Digital Goodsを統合しない場合はP3Pヘッダーが必要となります。
他のマーチャントのカートを使用している場合はP3Pヘッダーが必要となります。P3Pの詳細は、以
下のリンクを参照してください。
P3P説明書
z
Digital Goodsの取引では、必須のエクスプレス チェックアウトAPIパラメータフィールドをすべて
設定してください。詳細は、18ページ「デジタルコンテンツ用決済とエクスプレス チェックアウト
の統合」を参照してください。
Digital Goodsインテグレーションの概要
デジタルコンテンツ用決済フローのインテグレーション手順を以下の図にまとめました。
16
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
エクスプレス チェックアウトを利用したデジタルコンテンツ用決済の紹介
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
図中の数字は以下の手順の番号に対応しています。
注: 呼び出しを行うペイパルAPIのAPIバージョンが65.1以上であることを確認してください。
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
17
エクスプレス チェックアウトを利用したデジタルコンテンツ用決済の紹介
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
1. [Pay With PayPal]ボタンをお客様のウェブページにインストールします。
2. JavaScriptをお客様のウェブページに追加し、ウェブページのiframeに表示するペイパルデジタル
コンテンツ支払いフローを作成します。
3. 買い手が[Pay With PayPal]ボタンをクリックすると、SetExpressCheckout APIオペレーショ
ンを呼び出します。購入品目の詳細とデジタルコンテンツ取引に必要なパラメータフィールドを渡し
ます。詳細は、19ページ「デジタルコンテンツの支払い取引の設定」を参照してください。
4. 取引が正常に終了した場合は、デジタルコンテンツ取引を識別するトークンが返されます。この取引
に関連するエクスプレス チェックアウトAPIオペレーションを行う場合は、このトークンを渡し
ます。
5. Digital Goodsフローに買い手をリダイレクトします。SetExpressCheckoutレスポンスで返された
トークンをリダイレクト先のURLに付加します。
買い手がデジタルコンテンツを初めて購入する場合は、iframeにミニブラウザが表示されます。買
い手はペイパルにログインし、支払いの承認を開始します。
6. 買い手が[Pay]ボタンをクリックして支払いを承認するか、支払いをキャンセルすると、ペイパル
が買い手をサイトの復帰URLページまたはキャンセルURLページにリダイレクトします。リダイレク
ト時にペイパルがトークンと買い手の支払者IDを渡します。
7. 買い手が支払いを承認した場合、オプションでGetExpressCheckoutDetailsを呼び出し、ウェブ
ページに表示する買い手の詳細情報を取得します。
8. 買い手が支払いを承認した場合、購入品目の詳細を含めてDoExpressCheckoutPaymentを呼び出
し、支払いを終了します。
9. 復帰URLページとキャンセルURLページにJavaScriptコードを追加してiframeを閉じます。
10. お客様のサイトで買い手の注文処理を行います。
デジタルコンテンツをダウンロードし、購入確認を表示します。
注: サイトの運用開始前に必ずインテグレーションテストを行ってください。
デジタルコンテンツ用決済とエクスプレス チェックアウトの統合
ペイパルデジタルコンテンツ用決済をエクスプレス チェックアウトAPIに統合するには、
SetExpressCheckout APIオペレーションとDoExpressCheckoutPaymentAPIオペレーションの実装
が必要です。オプションで、GetExpressCheckoutDetailsの実装も可能です。
18
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
エクスプレス チェックアウトを利用したデジタルコンテンツ用決済の紹介
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
デジタルコンテンツの支払い取引の設定
デジタルコンテンツの支払い取引を設定するには、SetExpressCheckout APIリクエストオペレーショ
ンを呼び出します。デジタルコンテンツ用決済フローを開始し、買い手をフローにリダイレクトするた
めに必要な情報を入力します。
ここでは、ペイパルサーバーとの通信に使用する仕組みを設定済みで、ペイパルビジネスアカウントお
よびAPI信用証明書を保有しているものとします。また、支払いアクションはSaleとします。
注: デジタルコンテンツ用決済で呼び出すAPIはすべてバージョン65.1以上のものを使用してください。
取引を設定するには、SetExpressCheckoutリクエストで値を指定して、APIを呼び出してください。
指定した値によって、お客様および買い手が使用するオプションを制御します。
注: SetExpressCheckoutの呼び出しには、買い手が購入処理中の各デジタルコンテンツの値を渡し、
品目カテゴリーフィールドにDigitalを設定する必要があります。これらのパラメータの詳細は、設
定手順の手順7を参照してください。デジタルコンテンツの割引を受ける場合にも、
DoExpressCheckoutPaymentの呼び出しにこれらのパラメータと値を渡す必要があります。
取引を設定するには、以下の操作を行います。
1. PAYMENTREQUEST_0_AMTの値として支払いの合計金額を渡します。通貨が米ドル以外の場合に
は通貨も指定します。
取引の合計金額を指定します。指定の通貨にかかわらず、合計金額には小数点を挿入してください。
小数点の右側は2桁で、左側はオプションで3桁ずつコンマで区切っても構いません。
たとえば、€ 2.000,00は 2000.00または2,000.00と指定します。使用する通貨に関係なく、指定
される金額は$10,000.00を超えてはいけません。
PAYMENTREQUEST_0_AMT=amount
PAYMENTREQUEST_0_CURRENCYCODE=currencyID
2. 品目ごとに税額を渡す場合には、PAYMENTREQUEST_0_TAXAMTに税金の合計額を設定してくだ
さい。
3. お客様のサイトのページを復帰URLとして指定します。
RETURNURL=https://...
復帰URLは、買い手が支払いを承認した後、ペイパルが買い手をリダイレクトするページです。
通常、お客様のサイト内の保護されたページ(https://...)です。
注: 復帰URLを使用して、お客様のサイトのページ間でパラメータを受け渡すことができます。たと
えば、https://www.yourcompany.com/page.html?param=value...構文を使用して、復帰
URLを設定し、追加パラメータを指定できます。指定したパラメータは、復帰URLで指定された
ページのリクエストパラメータとして利用できるようになります。
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
19
エクスプレス チェックアウトを利用したデジタルコンテンツ用決済の紹介
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
買い手がお客様の確認ページで明示的に支払いの確認および確定を行う必要がない場合は、ペイパル
上で支払いを確定できます。この場合、以下のようにトークンとcommitを設定したuseraction値を
name-value pairとして復帰URLに追加します。
https://www.paypal.com/incontext?token=TOKENReturned&useraction=commit
4. キャンセルURLを指定します。
キャンセルURLは、買い手が支払いを承認しなかった場合にペイパルが買い手をリダイレクトする
ページです。通常、キャンセルURLはお客様のサイト内の保護されたページ(https://...)で、買い
手をペイパルのデジタルコンテンツ用決済フローにリダイレクトする前のページです。
注: ペイパルが買い手をお客様のURLにリダイレクトした後で必要に応じて利用できるように
SetExpressCheckoutリクエストの値をお客様のURLのパラメータとして渡すことができます。
CANCELURL=cancel_url
5. PAYMENTREQUEST_0_PAYMENTACTIONに値を設定する場合、Sale(デフォルト)を設定して
ください。
6. 注文の合計金額をPAYMENTREQUEST_0_ITEMAMTに設定します。
7. 買い手が購入する品目ごとに以下のパラメータ値を設定します。
- L_PAYMENTREQUEST_0_NAMEn
- L_PAYMENTREQUEST_0_AMTn
- L_PAYMENTREQUEST_0_QTYn
- L_PAYMENTREQUEST_0_ITEMCATEGORYn (Digitalを設定してください )
注: DoExpressCheckoutPaymentリクエストおよびSetExpressCheckout内の各品目の
L_PAYMENTREQUEST_0_ITEMCATEGORYにDigitalを設定してください。
Digitalが設定されていない場合、正しい手数料の計算ができません。
8. REQCONFIRMSHIPPINGを0に設定します。
9. NOSHIPPINGを1に設定します。
10. SetExpressCheckout APIオペレーションを実行し、エクスプレス チェックアウト取引を設定
します。
11. SetExpressCheckout APIオペレーションに対するレスポンスが成功したことを確認します。
成功した場合には、SetExpressCheckout APIオペレーションがトークンを返します。ペイパルは
このトークンを使用して、APIオペレーションとコマンドの実行をチェックアウト体験の特定のイン
スタンスに関連付けます。
20
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
エクスプレス チェックアウトを利用したデジタルコンテンツ用決済の紹介
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
12. SetExpressCheckout APIの呼び出しが成功した場合、以下に示すリダイレクトURLのデジタルコ
ンテンツ用決済フローに買い手をリダイレクトします。URLには、次のようにSetExpressCheckout
レスポンスで返されたトークンを付加します。
Digital GoodsのSetExpressCheckout例
以下にデジタルコンテンツの支払い取引のSetExpressCheckoutパラメータと値の例を示します。
リクエストパラメータ
[requiredSecurityParameters]
&METHOD=SetExpressCheckout
&RETURNURL=http://...
&CANCELURL=http://...
&PAYMENTREQUEST_0_CURRENCYCODE=USD
&PAYMENTREQUEST_0_AMT=300
&PAYMENTREQUEST_0_ITEMAMT=200
&PAYMENTREQUEST_0_PAYMENTACTION=Sale
&L_PAYMENTREQUEST_0_ITEMCATEGORY0=Digital
&L_PAYMENTREQUEST_0_ITEMCATEGORY1=Digital
&L_PAYMENTREQUEST_0_NAME0=Kitty Antics
&L_PAYMENTREQUEST_0_NAME1=All About Cats
&L_PAYMENTREQUEST_0_QTY0=1
&L_PAYMENTREQUEST_0_QTY1=1
&L_PAYMENTREQUEST_0_AMT0=100
&L_PAYMENTREQUEST_0_AMT1=100
レスポンスパラメータ
[successResponseFields]
&TOKEN=EC-17C76533PL706494P
買い手をペイパルにリダイレクトする
買い手をペイパルのデジタルコンテンツ用決済フローにリダイレクトするには、SetExpressCheckout
APIオペレーションから返されるトークンと以下のURLを指定します。
https://www.paypal.com/incontext?token=TOKENReturned
買い手が支払いを承認またはキャンセルした場合、ペイパルは買い手を復帰URLまたはキャンセルURL
にリダイレクトします。
z
復帰URL - 買い手が支払いを承認した場合、ペイパルへのリダイレクト時に渡されたトークンと買
い手の一意な識別子(支払者ID)を付けて、ペイパルが買い手を復帰URLにリダイレクトします。
z
キャンセルURL - 買い手が支払いをキャンセルした場合、ペイパルへのリダイレクト時に渡された
トークンを付けて、ペイパルが買い手をキャンセルURLにリダイレクトします。
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
21
エクスプレス チェックアウトを利用したデジタルコンテンツ用決済の紹介
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
ペイパルが買い手をお客様のウェブページにリダイレクトした後のアクション
ペイパルが買い手をお客様のウェブページにリダイレクトした後のアクションは、買い手が注文を承認
したかキャンセルしたかによって異なります。
買い手が注文を承認しデジタルコンテンツの支払いを行う場合、以下の操作を行います。
1. オプションで、GetExpressCheckoutDetails APIオペレーションを呼び出し、お客様のウェブペー
ジに表示する買い手の詳細情報を取得します。
2. DoExpressCheckoutを呼び出して支払いを完了します。
Digital Goods取引の完了
買い手が注文を承認後、Digital Goods取引を完了するには、DoExpressCheckoutPayment APIオペ
レーションを呼び出します。
DoExpressCheckoutPaymentを呼び出す際は、次の操作を行います。
1. ペイパルが買い手をお客様のサイトにリダイレクトした際に返したトークンと支払者IDを渡します。
TOKEN=tokenValue
PAYERID=payerId
2. PAYMENTREQUEST_0_AMTに支払い合計金額を設定します。米ドル以外の場合は通貨も指定して
ください。
取引の合計金額を指定します。指定の通貨にかかわらず、合計金額には小数点を挿入してください。
小数点の右側は2桁で、左側はオプションで3桁ずつコンマで区切っても構いません。
たとえば、€ 2.000,00は 2000.00または2,000.00と指定します。使用する通貨に関係なく、指定
される金額は$10,000.00を超えないようにしてください。
PAYMENTREQUEST_0_AMT=amount
PAYMENTREQUEST_0_CURRENCYCODE=currencyID
3. 品目ごとに税額を渡す場合には、PAYMENTREQUEST_0_TAXAMTに税金の合計額を設定します。
4. PAYMENTREQUEST_0_PAYMENTACTIONに値を設定する場合、Sale(デフォルト)を設定して
ください。
5. 注文の全品目の合計金額をPAYMENTREQUEST_0_ITEMAMTに設定します。
6. 買い手が購入する品目ごとに以下のパラメータ値を設定します。
注 : SetExpressCheckout の 呼 び 出 し で 以 下 の パ ラ メ ー タ に 値 を 設 定 し た 場 合 で も 、
DoExpressCheckoutPaymentの呼び出しで再度値を設定する必要があります。値を設定しな
いと、デジタルコンテンツ決済向けの手数料率が適用されません。
22
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
エクスプレス チェックアウトを利用したデジタルコンテンツ用決済の紹介
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
-
L_PAYMENTREQUEST_0_NAMEn
L_PAYMENTREQUEST_0_AMTn
L_PAYMENTREQUEST_0_QTYn
L_PAYMENTREQUEST_0_ITEMCATEGORYn (Digitalを設定してください)
7. 取引が正常に終了したかどうか返された値で確認してください。
デジタルコンテンツ用決済フローを開始するウェブページの設定
デジタルコンテンツ用決済フローを開始するには、以下の手順に従ってJavaScriptをウェブページに追
加します。
1. JavaScriptファイルdg.jsのパスを挿入します。
https://www.paypalobjects.com/js/external/dg.js
ページの閉じる</body>要素の直前にJavaScriptファイルのパスを挿入すると、最適なパフォーマ
ンスが得られます。
2. 次のコードをカスタマイズして、JavaScriptファイルの後ろに挿入します。”submitBtn”をHTML
のフォームボタンのIDに置き換えます。
<script>
var dg = new PAYPAL.apps.DGFlow({
// the HTML ID of the form submit button which calls setEC
trigger: "submitBtn"
});
</script>
注: ボタンクリックによるリダイレクトのターゲットを設定しないでください。
3. 復帰URLとキャンセルURLページに以下のJavaScriptコードを記述します。これによりiframeのデ
ジタルコンテンツ用決済フローを閉じて、買い手を適切なページにリダイレクトします。
注: 買い手がブラウザでJavaScriptを無効にしている場合に表示するコンテンツを必ず記述してください。
購入が正常に完了した場合にコンテンツを配信するリンクを記述してください。
<script>
top.dg.closeFlow();
</script>
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
23
エクスプレス チェックアウトを利用したデジタルコンテンツ用決済の紹介
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
再読み込みせずに非同期にページを更新するには、以下に示す例のようにAjax呼び出しを行う必要があ
ります。この方法でデジタルコンテンツ用決済フローを終了することを推奨します。ほかのオプション
に関しては、iframe終了オプションを参照してください。
<!-- Use result of DoEC to send the buyer to the correct page -->
<!DOCTYPE html>
<html>
<head>
<title></title>
<script>
// Sample AJAX code using jQuery (any AJAX
// library works)
$.ajax({
url: 'http://example.com/path_to_fulfillment_content',
type: 'GET',
error: function () {
// Handle error cases
},
success: function (response){
// Replace content on page, initiate
// download, etc.
}
});
</script>
</head>
<body>
<!-- Include non-JavaScript content here -->
If this page does not redirect <a href="[page to deliver content
to non-JS customer]">Click Here</a>
</body>
</html>
デジタルコンテンツ用決済で使用するJavaScript機能
デ ジ タ ル コ ン テ ン ツ 用 決 済 フ ロー を開 始 または 終了 す るペー ジに dg.js を記述 し ます。 dg.js の
JavaScript機能でiframeおよびペイパルのミニブラウザの設定および制御を行います。
24
機能と署名
内容
PAYPAL.apps.DGFlow = function
({trigger:
HTML_id_of_event_triggering_flow})
デジタルコンテンツ用決済フローを設定します。
setTrigger: function (id)
イベントのHTML IDをidに設定し、フローのトリガーを追加します。
最初にPAYPAL.apps.DGFlowを呼び出してフローの設定を行って
ください。
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
エクスプレス チェックアウトを利用したデジタルコンテンツ用決済の紹介
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
機能と署名
内容
startFlow: function (url)
フローを起動するURLをurlに設定し、Digital Goodsフローを明示
的に開始します。
注: フローを起動するイベントがない場合のみ、フローを明示的に
開始する必要があります。たとえばデジタルコンテンツ用決済
をFlash動画の再生に関連付ける場合などが該当します。
closeFlow: function ()
フローに関連付けられたミニブラウザやlightboxを閉じます。
この機能は、買い手が支払いを完了またはキャンセルした後に使用
します。
isOpen: function ()
フローが起動中かどうか確認します。
Digital Goods用JavaScriptを記述したマーチャントのページ例
マーチャントのページのHTMLコード例を以下に示します。
<html>
<head>
<meta charset="utf-8" />
<title></title>
<style type="text/css"></style>
</head>
<body>
<!-- Custom merchant code (path to merchant app, etc.) -->
<h1>El Jefe's Tours</h1>
<form action="path to setECURL" method="post">
<p>
<input id="submitBtn" type="submit"
value="Pay with PayPal" />
<input type="hidden" name="success_url"
value="path to successURL" />
<input type="hidden" name="cancel_url"
value="path to cancelURL">
</p>
</form>
<!--End custom merchant code -->
<script
src="https://paypalobjects.com/js/external/dg.js">
</script>
<script>
var dg = new PAYPAL.apps.DGFlow({
// HTML ID of form submit buttons that call setEC
trigger:"submitBtn"
});
</script>
</body>
</html>
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
25
エクスプレス チェックアウトを利用したデジタルコンテンツ用決済の紹介
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
26
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2
払戻しの実行
Chapter 2
RefundTransactionペイパルAPIオペレーションで払戻しを実行できます。
RefundTransaction APIを使用して、支払いの回収によって作成された取引などに関連する1件以上の
払戻しを実行します。支払いの回収時にペイパルが割り当てた取引IDで取引を識別します。
注: 払戻し期間の経過後に発生した取引に対しては払戻しはできません。通常の払戻し期間は60日間で
す。
払戻し金額の上限は、元の取引の合計金額です。全額払戻しを指定した場合、全額を払戻します。一部
払戻しを指定した場合、払戻し金額および通貨を指定し、メモに払戻し内容を記載する必要があります。
RefundTransaction APIを呼び出すと、(元の取引ではなく)払戻しに関連付けられた別の取引IDと払
戻しに関する追加情報をペイパルが返します。追加情報には以下の項目が含まれます。
z
支払者に返金される払戻し総額
z
お客様に返金される、元の取引手数料に関連する払戻し額
z
お客様の残高から差し引かれる払戻し額
払戻しを実行するには以下の手順に従ってください。
1. RefundTransactionリクエストで、払戻しを行う支払いの取引IDを指定します。
TRANSACTIONID=transaction_id
2. 全額(Full)または一部(Partial)いずれかの払戻し方法を指定します。
REFUNDTYPE=Full
または
REFUNDTYPE=Partial
3. 一部払戻しを指定した場合は、通貨と払戻し額を指定します。
AMT=amount
CURRENCYCODE=currencyID
4. 一部払戻しを指定した場合は、メモに内容を記述します。
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
27
払戻しの実行
NOTE=description
5. RefundTransactionオペレーションを実行します。
6. RefundTransactionレスポンスの確認応答ステータスをチェックし、オペレーションが成功したこ
とを確認します。
28
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
3
Chapter 3
定期支払いの処理
決まったスケジュールで発生する購読およびそのほかの支払いを処理するには、定期支払いを設定し
ます。
z
定期支払いのデモ
z
定期支払いのしくみ
z
定期支払いに関する用語
z
定期支払い個人設定を作成する場合のオプション
z
エクスプレス チェックアウトAPIを利用した定期支払い
z
定期支払い個人設定のステータス
z
定期支払い個人設定情報の取得
z
定期支払い個人設定の変更
z
個人設定の未払い金額の請求
z
定期支払い通知
定期支払いのしくみ
買い手に対して定期支払いサービスを提供するには、定期支払い個人設定を作成します。個人設定には、
オプションの試用期間および通常の支払い期間の詳細等、定期支払いに関する情報が含まれます。各期
間には、支払い頻度と支払い金額、該当する場合には配送料と税金の情報が含まれます。
個人設定が作成されると、請求開始日、請求頻度、請求額をもとにペイパルが自動的に支払いをキュー
に入れます。個人設定の期限が切れた場合、支払い失敗が複数回続いた場合、またはお客様が個人設定
をキャンセルした場合を除き、繰り返し支払いが行われます。
ペイパルは、買い手のペイパルアカウントに設定されている通常の支払い方法を用いてキュー内の支払
いを行います。
定期支払い個人設定を作成後、お客様のペイパルアカウントから個人設定の詳細を確認したり、個人設
定をキャンセルしたりできます。ペイパルの「 Business Overview」
(ビジネスの概要)ページから定
期支払い報告書を閲覧することも可能です。
また、定期支払い個人設定作成後は、定期支払いAPIを利用して以下の作業を行うことができます。
z
定期支払い個人設定の詳細情報の取得
z
定期支払い個人設定のステータス変更
z
定期支払い個人設定の詳細更新
z
定期支払い個人設定の未払い金額の請求
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
29
定期支払いの処理
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
制限事項
定期支払いAPIの現リリース版には以下の制限事項があります。
z
個人設定にはオプションの試用期間と通常の支払い期間をそれぞれ1つしか設定できない。
z
個人設定開始日には個人設定作成日より前の日を設定できない。
エクスプレス チェックアウトを利用して定期支払いを行う場合には以下の制限事項があります。
z
買い手の定期支払い個人設定を作成するには、買い手のペイパルアカウントに有効なクレジットカー
ド情報が入力されていなければならない。
z
決済中に作成できる定期支払い個人設定は最大10件までである。
z
個人設定の作成後、増額できる設定金額は180日ごとに20%のみである。
定期支払いに関する用語
定期支払いに関してペイパルで一般的に使用する用語を以下に示します。
30
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
定期支払いの処理
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
定期支払いに関する用語
用語
定義
定期支払い個人設定
1人の買い手の定期取引に関する記録です。個人設定には、一定の間隔で一定の金額
を買い手に対して自動請求するために必要なすべての情報が含まれています。
請求サイクル
請求サイクルごとに1回の支払いを行います。各請求サイクルは2つの要素で構成さ
れます。
z 請求期間は、請求サイクルの計算に使用される単位を指定します(日、月など)
。
z 請求頻度は、請求サイクルを構成する請求期間の回数を指定します。
たとえば、請求期間が月で、請求頻度が2の場合、請求サイクルは2ヶ月になります。
請求期間が週で、請求頻度が6の場合、請求サイクルは6週間になり、6週間ごとの
支払いがスケジュールされます。
通常支払い期間
個人設定の主要な定期支払い期間であり、各請求サイクルについての支払い金額を
定義します。個人設定で試用期間が指定されている場合、試用期間の終了後に通常
支払い期間を開始します。
試用期間
通常支払い期間を開始する前のオプションの定期支払い期間です。
試用期間には、通常支払い期間と同一の請求サイクルおよび支払い金額を設定する
ことはできません。
支払い金額
請求サイクルごとに買い手によって支払われる金額です。
未払い残高
何らかの理由で支払いが失敗した場合、その金額が個人設定の未払い残高に追加さ
れます。
個人設定ID
(ペイパルが生成する) 英数字の文字列で、定期支払い個人設定を一意に識別しま
す。TransactionSearch APIオペレーションで個人設定IDを指定し、当該個人設定
に関連付けられたすべての支払いを取得できます。
定期支払い個人設定を作成する場合のオプション
定期支払い個人設定を作成し、通常支払い期間、オプションの試用期間、初回の支払い、およびそのほ
かのオプションを設定できます。
通常支払い期間の指定
各定期支払い個人設定には、支払いの金額と頻度を定義する通常支払い期間があります。通常支払い期
間の指定に必要なフィールドを以下の表に示します。
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
31
定期支払いの処理
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
通常支払い期間の指定に必要なフィールド
NVP
SOAP
内容
PROFILESTARTDATE
RecurringPaymentsProfileDet
ails.BillingStartDate
個人設定の請求開始日
注: 個人設定が有効になるまで最長24時間
必要です。
BILLINGPERIOD
ScheduleDetails.
PaymentPeriod.BillingPeriod
請求サイクル単位。
次のいずれかを設定します。
z Day(日)
z Week(週)
z SemiMonth(半月)
z Month(月)
z Year(年)
BILLINGFREQUENCY
ScheduleDetails.
PaymentPeriod.BillingFreque ncy
1つの請求サイクルを構成する請求期間の数
注: 請求頻度と請求期間の組み合わせは
1年以内になるようにしてください。
注: 請求期間がSemiMonth(半月)の場合、
請求頻度は1でなければなりません。
AMT
ScheduleDetails.
PaymentPeriod.Amount
請求サイクルごとに請求する金額
オプションで、通常支払い期間内の請求サイクルの合計数を指定するTOTALBILLINGCYCLES(SOAP
フィールド ScheduleDetails.PaymentPeriod.TotalBillingCycles)の値を設定できます。値を指定し
ない場合、または0を指定した場合は、ペイパル(または買い手)が個人設定をキャンセルまた一時停止
した場合を除き、繰り返し支払いが行われます。値が0より大きい場合、指定された請求サイクル数にな
るまで通常支払い期間を継続します。
オプションで、通常支払い期間に対して配送金額や税額を指定することもできます。
オプションの試用期間の指定
オプションで個人設定に試用期間を指定するには、CreateRecurringPaymentsProfileリクエストで以
下のフィールドを指定します。オプションの試用期間の作成に必要なフィールドを以下の表に示します。
32
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
定期支払いの処理
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
試用期間の指定に必要なフィールド
NVP
SOAP
TRIALBILLINGPERIOD
ScheduleDetails.TrialPeriod.BillingPeriod
TRIALBILLINGFREQUENCY
ScheduleDetails.TrialPeriod.BillingFrequency
TRIALAMT
ScheduleDetails.TrialPeriod.Amount
TRIALTOTALBILLINGCYCLES
ScheduleDetails.TrialPeriod.TotalBillingCycles
初回支払いの指定
オプションで、定期支払い個人設定の作成時にCreateRecurringPaymentsProfileリクエストに次の
フィールドを設定し、最初の非定期支払いを指定できます。
初回支払いの指定に必要なフィールド
NVP
SOAP
INITAMT
ScheduleDetails.ActivationDetails.InitialAmount
FAILEDINITAMTACTION
ScheduleDetails.ActivationDetails.FailedInitAmountAction
デフォルトで、初回支払い金額の決済が成立しないと個人設定が有効にならない設定になっています。
このデフォルト設定を変更するには、FAILEDINITAMTACTIONフィールドにContinueOnFailureを設
定します。これにより、初回支払いの決済が成立しなかった場合、不成立の決済金額が定期支払い個人
設定の未払い残高に追加されます。
FAILEDINITAMTACTIONフィールドを設定していない場合、またはフィールドにCancelOnFailureを
設定していない場合でも、ペイパルは定期支払い個人設定を作成します。ただし初回支払いの決済が完
了するまで、個人設定は保留になります。初回支払いの決済が完了すると、ペイパルが保留の個人設定
を有効にし、お客様にその旨をIPNで通知します。支払いが成立しない場合、保留の個人設定をキャンセ
ルし、その旨をIPNで通知します。
エクスプレス チェックアウトを利用して個人設定を作成した場合、ペイパルによって初回支払いの決済
が行われた旨、または保留の個人設定がキャンセルされた旨を買い手にメールで通知します。
支払い不履行回数の上限
CreateRecurringPaymentsProfileリクエストにMAXFAILEDPAYMENTSフィールドを記述して、ペイ
パルが自動的に個人設定を一時停止にするまでに許容される支払い不履行回数の上限を指定します。支
払い不履行の回数が指定された上限に達すると、お客様にIPNメッセージが送信されます。
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
33
定期支払いの処理
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
未払い金額の請求
何らかの理由で支払いが成立しない場合、請求金額(該当する場合は配送料金や税金も含む) が個人設
定の未払い残高に追加されます。
CreateRecurringPaymentsProfileリクエストのAUTOBILLOUTAMTフィールドを使用して、次の請求
サイクルの決済金額に未決済金額を追加するかどうかを指定します。
未決済金額を次の請求サイクルの支払いに追加するかどうかの指定にかかわらず、
BillOutstandingAmount APIを使用して、随時プログラムで未決済金額を回収できます。
デジタルコンテンツと有形商品の識別
以下の表に記載の支払い詳細品目フィールド全部をCreateRecurringPaymentsProfileリクエストに設
定します。品目がすべてデジタルコンテンツの場合は、品目カテゴリーフィールドをDigitalに設定し、
デジタルコンテンツに対する手数料率の適用を受けてください。
品目詳細の指定に必要なフィールド
NVP
SOAP
内容
L_PAYMENTREQUEST_0_
ITEMCATEGORYn
ItemCategory
デジタルコンテンツの場合はDigitalを設定してくだ
さい。
z Digital
z Physical
L_PAYMENTREQUEST_0_
NAMEn
Name
品名
L_PAYMENTREQUEST_0_
AMTn
Amount
価格
L_PAYMENTREQUEST_0_
QTYn
Quantity
商品数量
エクスプレス チェックアウトAPIを利用した定期支払い
決済フローで1件以上の定期支払いを作成したり、定期支払いとほかの購入操作を組み合わせたりでき
ます。
決済中に定期支払いを作成する一般的な処理フローを以下の図に示します。
図中の丸で囲まれた数字は次の手順に対応しています。
SetExpressCheckoutを使った処理フローの開始
エクスプレス チェックアウト フローと同様、SetExpressCheckoutリクエストによってペイパルに以
下のことが通知されます。
34
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
定期支払いの処理
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
z
お客様による1度限りの購入(ワンタイムの購入)
、10回までの定期支払い、1度限りの購入と定期支
払いの組み合わせのいずれかの注文の開始
z
1度限りの購入および定期支払いのどちらにも関連付けられていない定期支払いに関する1件以上の
請求処理規約の作成処理フローの開始
通常SetExpressCheckoutリクエストの呼び出し時に、エクスプレス チェックアウト取引の支払い金額
を 設 定 し ま す 。 DoExpressCheckoutPayment リ ク エ ス ト で 金 額 を 確 認 し ま す 。 た だ し 、
SetExpressCheckoutリクエストで支払い金額を0に設定すると、支払いを開始せずに請求処理規約を
作成できます。
定期支払いに対して1件以上の請求処理規約を設定するには、SetExpressCheckoutリクエストを次の
ように変更します。
1. 作成する請求処理規約ごとに、L_BILLINGTYPEnフィールドを追加します。nには0から9 までの値
を設定します。各フィールドの値をRecurringPaymentsに設定します。
L_BILLINGTYPE0=RecurringPayments
2. L_BILLINGAGREEMENTDESCRIPTIONnフィールドを、L_BILLINGTYPEnフィールドごとに追加
します。nには0から9までの値を設定します。以下に示す例のように、各フィールドに請求処理規約
に関連する商品やサービスの説明を設定します。
L_BILLINGAGREEMENTDESCRIPTION0=Time Magazine subscription
3. 関連する購入がない場合は、PAYMENTREQUEST_0_AMTを0に設定します。
PAYMENTREQUEST_0_AMT=0
4. (オプション)平均予想取引額をMAXAMTに設定します。
お客様が設定した値を使用して、ペイパルが定期支払いに対する買い手の支払い方法を有効にします。
値の指定がない場合は、デフォルトの25.00を使用します。
SetExpressCheckoutレスポンスは、以降のリダイレクトおよびAPIコールに使用する取引を一意に識
別するトークンを返します。
買い手をペイパルにリダイレクトする
SetExpressCheckoutからレスポンスを受信した後、SetExpressCheckoutレスポンスから受け取った
TOKENをname-value pairとして次のURLに追加し、買い手をリダイレクトします。
GetExpressCheckoutDetailsを使用して買い手の詳細情報を取得する
GetExpressCheckoutDetailsリクエストには、SetExpressCheckoutレスポンスで返されるTOKENが
必要です。
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
35
定期支払いの処理
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
CreateRecurringPaymentsProfileを使用して個人設定を作成する
お客様の確認ページで買い手が定期支払い請求処理規約に合意した後、CreateRecurringPaymentsProfile
を呼び出して、個人設定を作成する必要があります。複数の定期支払い個人設定を作成する場合、作成
する個人設定ごとにCreateRecurringPaymentsProfileを呼び出してください。
1度限りの購入と定期支払いの両方を含む取引の場合は、まずDoExpressCheckoutPaymentを呼び出
して1度限りの購入取引を完了します。
次に、作成する定期支払い個人設定ごとにCreateRecurringPaymentsProfileを呼び出します。
重要: CreateRecurringPaymentsProfile呼び出しで正常終了のレスポンスを受信するまで、定期支払
い個人設定は作成されません。
デジタルコンテンツの手数料率の適用を受けるには、以下の必須支払い詳細品目フィールドに値を設定
してください。
z
L_PAYMENTREQUEST_0_NAMEn
z
L_PAYMENTREQUEST_0_AMTn
z
L_PAYMENTREQUEST_0_QTYn
z
L_PAYMENTREQUEST_0_ITEMCATEGORYn(Digitalとの設定が必須)
注: 支払い詳細品目フィールドは、バージョン69.0以降のCreateRecurringPaymentsProfile APIで提
供されています。
CreateRecurringPaymentsProfileレスポンスには、定期支払い個人設定を一意に識別する符号化文字
列である個人設定IDが含まれます。
以下に示す例のようにCreateRecurringPaymentsProfileを設定すると、デジタルコンテンツの手数料
率が適用されます。
リクエストパラメータ
[requiredSecurityParameters]
&METHOD=CreateRecurringPaymentsProfile
TOKEN=EC-13W99099UU817504D
&PROFILESTARTDATE:20XX-03-05T03:00:00
&DESC=Movie clips
&BILLINGPERIOD=Month
&BILLINGFREQUENCY=12
&AMT=1.00
&CURRENCYCODE=USD
&EMAIL=payername@bbb.net
&L_PAYMENTREQUEST_0_ITEMCATEGORY0=Digital
&L_PAYMENTREQUEST_0_NAME0=Kitty Antics
&L_PAYMENTREQUEST_0_AMT0=1.00
&L_PAYMENTREQUEST_0_QTY0=1
レスポンスパラメータ
36
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
定期支払いの処理
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
定期支払い個人設定のステータス
実行可能な定期支払いアクションは、個人設定のステータスによって異なります。定期支払い個人設定
のステータスは次のいずれかの値となります。
z
ActiveProfile
z
PendingProfile
z
ExpiredProfile
z
SuspendedProfile
z
CancelledProfile
個人設定が正しく作成された場合、ステータスはActiveProfileとなります。ただし、定期の初回支払い
決 済 が 成 立 せ ず 、 CreateRecurringPaymentsProfile リ ク エ ス ト の FAILEDINITAMTACTION が
CancelOnFailureの場合、個人設定のステータスはPendingProfileになります。初回支払いの決済が正
常に完了するか不履行になるまでステータスは変更されません。
オプションの試用期間と通常支払い期間のすべての請求サイクルが完了した場合、個人設定のステータ
スはExpiredProfileになります。
ManageRecurringPaymentsProfileStatus APIを使用して、個人設定を一時停止またはキャンセルで
きます。一時停止中の個人設定の再開も可能です。ただし、すでに支払い不履行回数の上限に達してい
る場合は、個人設定を再開する前に、支払い不履行回数の上限を増やす必要があります。
注: 定期支払い個人設定の一時停止、キャンセル、再開は、ペイパルのウェブサイトからも実行でき
ます。
エクスプレス チェックアウトAPIを利用して定期支払い個人設定が作成された場合、定期支払いのス
テータスが変更されると、その旨を買い手にメールで通知します。
定期支払い個人設定情報の取得
GetRecurringPaymentsProfileDetails APIを使用して、個人設定に関する情報を取得します。
注: 定期支払い設定に関する情報はペイパルのウェブサイトからも取得できます。
GetRecurringPaymentsProfileDetailsは、CreateRecurringPaymentsProfileリクエストに指定され
た情報に加えて、個人設定に関する以下の概要情報も返します。
z
個人設定ステータス
z
次回請求予定日
z
有効な定期支払い期間のうち完了した請求サイクル回数
z
有効な定期支払い期間のうち残りの請求サイクル回数
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
37
定期支払いの処理
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
z
現在の未払い残高
z
支払い不履行になった請求サイクルの合計回数
z
前回支払い受領日
z
前回支払い受領金額
定期支払い個人設定の変更
UpdateRecurringPaymentsProfile APIを使用して、定期支払い個人設定を変更します。
注: 定期支払い個人設定の変更はペイパルのウェブサイトからも実行できます。
有効な個人設定または一時停止中の個人設定について、次の情報のみ変更できます。
z
支払者の名前または住所
z
期日を経過した金額または未払い金額
z
未払い金額を次の請求サイクルで請求するかどうか
z
支払い不履行許容回数の上限
z
個人設定についての記述および参照情報
z
追加請求サイクル数
z
請求金額、税額、または配送料金
注: 個人設定の請求頻度や請求期間は変更できません。請求サイクル数は変更可能です。
注: エクスプレス チェックアウトAPIを使用した定期支払いの場合、請求予定日の3日前以降は請求金額
など特定の情報を更新できません。
試用期間または通常支払い期間中、以下の個人設定情報を変更できます。
z
請求金額
z
請求サイクル数
個人設定の変更は、個人設定更新の呼び出し後、次の支払い時に反映されます。たとえば、買い手が合
計 3 回 の 試 用 支 払 い の う ち の 1 回 を 実 行 し た と し ま す 。 そ の 後 、 お 客 様 が
UpdateRecurringPaymentsProfileを呼び出し、請求サイクル数を5回に増やしたとします。この結果、
買い手の試用支払い回数が4 回増えます。通常の支払い期間にUpdateRecurringPaymentsProfileを呼
び出すと、買い手の次の通常支払い予定日に変更が反映されます。
詳細は、
『Name-Value Pair (NVP) APIデベロッパーガイドおよびリファレンス』 または『SOAP API
リファレンス』を参照してください。
38
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
定期支払いの処理
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
請求金額の更新
たとえば合計金額が$100の個人設定を3月10日に作成した場合、3月10日から9月6日までの180日間は、
最大$120($100の120%)まで支払い金額を増額できます。
最初の180日の間に、支払い金額を$110に増額した場合、次の180日間(この例では9月7日から始まる
期間)には、132ドル($110の120%)までしか支払い金額を増額できません。
個人設定の未払い金額の請求
BillOutstandingAmount APIを使用して、現時点での定期支払い個人設定の期日経過金額や未払い金額
をただちに買い手に請求できます。
注: ペイパルのウェブサイトからも、現時点での定期支払い設定の期日経過金額や未払い金額を買い手
に請求できます。
未払い金額を請求するには、以下の条件が必要です。
z
個人設定ステータスが有効であるか、一時停止である必要があります。
注: BillOutstandingAmount APIは、一時停止された個人設定を再開しません。再開するには
ManageRecurringProfileStatusを呼び出してください。
z
個人設定にゼロでない未払い金額がある必要があります。
z
支払い金額は個人設定の未払い金額以下である必要があります。
z
BillOutstandingAmount呼び出しは、該当の個人設定に対して定期的に行われる支払いから24時間
以内に行うことはできません。
注: 別の未払い金額の支払いがすでにキューにある場合、APIエラーが返されます。
定期支払いの通知
定期支払いイベントについて、ペイパルがIPNおよびメールでお客様に通知します。通常はお客様ご自身
でGetTransactionDetailsを呼び出して、必要な情報を取得することができます。
特定のイベントに関しては、ペイパルがIPNでお客様に通知します。エクスプレス チェックアウトを利
用して定期支払い個人設定が作成された場合、買い手に対してもメールで特定のイベントの通知を行い
ます。ペイパルがIPNおよびメールを作成する場合を以下の表に示します。
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
39
定期支払いの処理
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
定期支払いのIPNメッセージおよびメール
イベント
IPN
買い手へのメール通知
個人設定の作成に成功した
あり
あり
個人設定の作成に失敗した
あり
あり
paypal.comのインターフェイスによって個人設定がキャ
ンセルされた
あり
あり
APIを使用して個人設定ステータスが変更された
なし
あり
APIを使用して個人設定が更新された
なし
あり
初回の支払いに成功または失敗した
あり
あり
支払いに成功または失敗した(試用期間または通常支払い
期間中)
あり
あり
未払い金額の支払いに成功または失敗した
あり
あり
支払い不履行許容回数の上限に達した
あり
なし
注: ManangeRecurringPaymentsProfileStatusなどのAPI取引では、IPN通知は行われません。APIレ
スポンスによって呼び出しの成否が即時に返されます。
40
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
A
Chapter A
iframe終了オプション
以下のiframe終了オプションを使用して親ページを再読み込みします。
z
41ページ「特定のURLに親ページを再読み込みする」
z
42ページ「フレームを削除して親ページを再読み込みする」
特定のURLに親ページを再読み込みする
iframe終了オプションで、特定のURLに親ページを再読み込みすることができます。
特定のURLに親ページを再読み込みするには、以下の手順にしたがってください。
1. オプションで、GetExpressCheckoutDetails APIオペレーションを呼び出して、ウェブページに表
示する買い手の詳細情報を取得します。
2. DoExpressCheckoutを呼び出して、支払いを完了します。22ページ「Digital Goods取引の完了」
を参照してください。
3. 以下に示す例のように、復帰URLおよびキャンセルURLページにJavaScriptコードを記述します。
<!-- Use result of DoEC to send the buyer to the correct page -->
<!DOCTYPE html>
<html>
<head>
<title></title>
<script>
top.location.href=’http://example.com/path_to_fulfillment_page’;
</script>
</head>
<body>
If this page does not redirect <a href="[page to deliver content
to non-JS customer]">Click Here</a>
</body>
</html>
買い手が注文をキャンセルした場合は、注文を完了せずにiframeを閉じます。
トップウィンドウはブラウザウィンドウです。上記のコードで、トップウィンドウの内容を指定したURL
のページの内容に置換します。
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
41
Iframe終了オプション
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
フレームを削除して親ページを再読み込みする
iframe終了のオプションで、フレームを削除して親ページを再読み込みすることができます。
フレームを削除して親ページの再読み込みを行うには、以下の手順にしたがってください。
1. オプションで、GetExpressCheckoutDetails APIオペレーションを呼び出して、ウェブページに買
い手の詳細情報を表示します。
2. DoExpressCheckoutを呼び出します。22ページ「Digital Goods取引の完了」を参照してください。
注: iframeの制御中に上記の2つの手順を実施してください。
3. 以下の例に示すようなJavaScriptコードを復帰URLページとキャンセルURLページに記述します。
<!-- Use result of DoEC to send the buyer to the correct page -->
<!DOCTYPE html>
<html>
<head>
<title></title>
<script>
if (window != top) {
top.location.replace(document.location);
}
</script>
</head>
<body>
<!-- Include non-JavaScript content here -->
If this page does not redirect <a href="[page to deliver content
to non-JS customer]">Click Here</a>
</body>
</html>
買い手が注文をキャンセルした場合は、注文を完了せずにiframeを閉じます。
トップウィンドウはブラウザウィンドウです。上記のコードで、トップウィンドウの内容を指定したURL
のページの内容に置換します
42
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
B
Chapter B
Digital GoodsをFlashに統合する
方法
Digital GoodsをFlashファイルに統合することが可能です。
z
43ページ「Digital GoodsをFlashに統合する - サードパーティマーチャント」
43ページ「Digital GoodsをFlashに統合する」
Digital GoodsをFlashに統合する
お客様がご自身でDigital GoodsをFlashに統合する例を以下に示します。
Digital GoodsをFlashに統合するには、以下の操作を行ってください。
1. Digital Goods用のJavaScriptライブラリをHTMLページgame.htmlに挿入します。このページには
Flash動画ファイルgame.swfも含まれています。
2. 以下のActionScriptをFlash動画ファイルgame.swfに記述し、Digital Goodsオブジェクトを初期
化します。
dg_button.addEventListener(
MouseEvent.MOUSE_UP,
function(evt:MouseEvent):void {
var payment_URL:String = "<Merchant URL to initiate API call>";
// use ExternalInterface to call the JavaScript method dg.startFlow
var result:uint =
ExternalInterface.call("dg.startFlow",payment_URL);
}
);
function paymentComplete(responseText):void {
// use responseText to do any customizations
}
// register the callback method so it can be called via JavaScript
ExternalInterface.addCallback("paymentCompleteExt", paymentComplete);
Digital GoodsをFlashに統合する - サードパーティマーチャント
サードパーティマーチャントがDigital GoodsをFlashに統合する例を以下に示します。
以下の例では、ActionScript 3.0のLocalConnectionをFlash動画ファイルgame.swfに使用し、支払い
に対応します。
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
43
Digital GoodsをFlashに統合する方法
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
1. 以 下 の コ ー ド を 記 述 し た Flash 動 画 フ ァ イ ル game.swf を 作 成 し ま す 。 以 下 の コ ー ド で は 、
dg_buttonのボタンクリックで支払いを開始することを前提としています。
// create local connection
var conn:LocalConnection;
conn = new LocalConnection();
// allow cross domain connection
conn.allowDomain('*');
// identify this movie as the receiver (i.e. client)
conn.client = this;
dg_button.addEventListener(
MouseEvent.MOUSE_UP,
function(evt:MouseEvent):void {
// following URL will begin the DG API call
var payment_URL:String =
"<Merchant URL to initiate API call>";
// following JS opens a new window to the appropriate size
// for DG checkout
var jscommand:String = "window.open('"+payment_URL+"','win',
'height=550,width=400,toolbar=no,scrollbars=no');";
var url:URLRequest = new URLRequest("javascript:" +
jscommand + "
void(0);");
navigateToURL(url, "_self");
//initiate listening on connection
conn.connect('paymentConn');
});
function paymentComplete(responseText):void {
//use responseText to do any customizations
//close the LocalConnection
conn.close();
}
2. 別のFlash動画ファイルreturn.swfをAPIコールの復帰URLに指定します。
3. Return.swf中のFlashVarsまたはExternalInterfaceを利用して、APIレスポンスから必要な値を取
得します。
4. 手順1のLocalConnectionをreturn.swfで使用し、game.swfと通信します。以下に例を示します。
var sendingLC:LocalConnection = new LocalConnection();
// do anything required to get API response parameters into
// the ‘response’ variable
// connect to game.swf and call paymentComplete
sendingLC.send('paymentConn', 'paymentComplete', response);
44
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
C
Chapter C
Digital Goodsが対応しているエクス
プレス チェックアウトAPIフィールド
Digital Goodsのインテグレーションで関係するエクスプレス チェックアウトAPIパラメータフィール
ドのサブセットをここに記載します。
z
45ページ「Digital Goodsが対応しているエクスプレス チェックアウトNVP APIフィールド」
z
48ページ「Digital Goodsが対応しているエクスプレス チェックアウトSOAP APIフィールド」
Digital Goodsが対応しているエクスプレス チェックアウトNVP API
フィールド
SetExpressCheckout NVPリクエストフィールド
SetExpressCheckoutリクエストフィールド
METHOD
must be SetExpressCheckout
TOKEN
RETURNURL
CANCELURL
REQCONFIRMSHIPPING
NOSHIPPING
ALLOWNOTE
LOCALECODE
PAYMENTDETAILS
支払い詳細タイプフィールド
PAYMENTREQUEST_n_AMT
PAYMENTREQUEST_n_CURRENCYC
ODE
PAYMENTREQUEST_n_ITEMAMT
PAYMENTREQUEST_n_TAXAMT
PAYMENTREQUEST_n_DESC
PAYMENTREQUEST_n_INVNUM
PAYMENTREQUEST_n_NOTIFYURL
PAYMENTREQUEST_n_PAYMENTAC
TION
支払い詳細品目タイプフィールド
PAYMENTREQUEST_n_NAMEm
PAYMENTREQUEST_n_DESCm
PAYMENTREQUEST_n_AMTm
PAYMENTREQUEST_n_NUMBERm
PAYMENTREQUEST_n_QTYm
PAYMENTREQUEST_n_TAXAMTm
PAYMENTREQUEST_n_ITEMCATEG
ORYm
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
45
Digital Goodsが対応しているエクスプレス チェックアウトAPIフィールド
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
SetExpressCheckout NVPレスポンスフィールド
SetExpressCheckoutレスポンスフィールド
TOKEN
GetExpressCheckoutDetails NVPリクエストフィールド
GetExpressCheckoutDetailsリクエストフィールド
METHOD
must be
GetExpressCheckoutDetails
TOKEN
GetExpressCheckoutDetails NVPレスポンスフィールド
GetExpressCheckoutDetailsレスポンスフィールド
TOKEN
INVNUM
PHONENUM
NOTE
REDIRECTREQUIRED
CHECKOUTSTATUS
EMAIL
PAYERID
PAYERSTATUS
COUNTRYCODE
BUSINESS
支払者情報フィールド
支払者名フィールド
SALUTATION
FIRSTNAME
LASTNAME
SUFFIX
MIDDLENAME
支払い詳細タイプフィールド
46
PAYMENTREQUEST_n_AMT
PAYMENTREQUEST_n_CURRENCYC
ODE
PAYMENTREQUEST_n_ITEMAMT
PAYMENTREQUEST_n_TAXAMT
PAYMENTREQUEST_n_DESC
PAYMENTREQUEST_n_INVNUM
PAYMENTREQUEST_n_NOTIFYURL
PAYMENTREQUEST_n_TRANSACTI
ONID
PAYMENTREQUEST_n_PAYMENTRE
QUESTID
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
Digital Goodsが対応しているエクスプレス チェックアウトAPIフィールド
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
支払い詳細品目タイプフィールド
L_PAYMENTREQUEST_n_NAMEm
L_PAYMENTREQUEST_n_DESCm
L_PAYMENTREQUEST_n_AMTm
L_PAYMENTREQUEST_n_NUMBERm
L_PAYMENTREQUEST_n_QTYm
L_PAYMENTREQUEST_n_TAXAMT
m
L_PAYMENTREQUEST_n_ITEMCAT
EGORYm
NVP GetExpressCheckoutDetailsレスポンスフィールド
TOKEN
INVNUM
PHONENUM
NOTE
REDIRECTREQUIRED
CHECKOUTSTATUS
DoExpressCheckoutPayment NVPリクエストフィールド
DoExpressCheckoutPaymentリクエストフィールド
METHOD
must be
DoExpressCheckoutPayment
TOKEN
RETURNURL
CANCELURL
NOSHIPPING
ALLOWNOTE
LOCALECODE
支払い詳細タイプフィールド
PAYMENTREQUEST_n_AMT
PAYMENTREQUEST_n_CURRENCYC
ODE
PAYMENTREQUEST_n_ITEMAMT
PAYMENTREQUEST_n_TAXAMT
PAYMENTREQUEST_n_DESC
PAYMENTREQUEST_n_INVNUM
PAYMENTREQUEST_n_NOTIFYURL
PAYMENTREQUEST_n_PAYMENTAC
TION
PAYMENTREQUEST_n_PAYMENTRE
QUESTID
支払い詳細品目タイプフィールド
PAYMENTREQUEST_n_NAMEm
PAYMENTREQUEST_n_DESCm
PAYMENTREQUEST_n_AMTm
PAYMENTREQUEST_n_NUMBERm
PAYMENTREQUEST_n_QTYm
PAYMENTREQUEST_n_TAXAMTm
PAYMENTREQUEST_n_ITEMCATEG
ORYm
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
47
Digital Goodsが対応しているエクスプレス チェックアウトAPIフィールド
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
DoExpressCheckoutPayment NVPレスポンスフィールド
DoExpressCheckoutPaymentレスポンスフィールド
TOKEN
NOTE
REDIRECTREQUIRED
支払い詳細タイプフィールド
PAYMENTREQUEST_n_AMT
PAYMENTREQUEST_n_CURRENCYC
ODE
PAYMENTREQUEST_n_ITEMAMT
PAYMENTREQUEST_n_TAXAMT
PAYMENTREQUEST_n_DESC
PAYMENTREQUEST_n_INVNUM
PAYMENTREQUEST_n_NOTIFYURL
PAYMENTREQUEST_n_PAYMENTAC
TION
PAYMENTREQUEST_n_PAYMENTRE
QUESTID
PAYMENTINFO_n_TRANSACTIONI
D
PAYMENTINFO_n_TRANSACTIONT
YPE
PAYMENTINFO_n_ORDERTIME
PAYMENTINFO_n_CURRENCYCODE
PAYMENTREQUEST_n_FEEAMT
PAYMENTINFO_n_SETTLEAMT
PAYMENTINFO_n_TAXAMT
PAYMENTINFO_n_EXCHANGERATE
PAYMENTINFO_n_PAYMENTSTATU
S
PAYMENTINFO_n_PENDINGREASO
N
PAYMENTINFO_n_REASONCODE
PAYMENTINFO_n_FMFfilterIDm
支払い情報フィールド
PAYMENTINFO_n_FMFfilterNAMEm
Digital Goodsが対応しているエクスプレス チェックアウトSOAP
APIフィールド
SetExpressCheckout SOAPリクエストフィールド
SetExpressCheckoutリクエストフィールド
Token
ReturnURL
CancelURL
ReqConfirmShipping
NoShipping
AllowNote
LocaleCode
PaymentDetails
支払い詳細タイプフィールド
OrderTotal
48
ItemTotal
TaxTotal
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
Digital Goodsが対応しているエクスプレス チェックアウトAPIフィールド
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
OrderDescription
InvoiceID
NotifyURL
PaymentDetailsItem
PaymentAction
支払い詳細品目タイプフィールド
Name
Description
Amount
Number
Quantity
Tax
ItemCategory
SetExpressCheckout SOAPレスポンスフィールド
SetExpressCheckoutレスポンスフィールド
Token
GetExpressCheckoutDetails SOAPリクエストフィールド
GetExpressCheckoutDetailsリクエストフィールド
Token
GetExpressCheckoutDetails SOAPレスポンスフィールド
GetExpressCheckoutDetailsレスポンスフィールド
Token
InvoiceID
ContactPhone
Note
RedirectRequired
CheckoutStatus
Payer
PayerID
PayerStatus
PayerCountry
PayerBusiness
PaymentDetails
支払者情報フィールド
支払者名フィールド
Salutation
FirstName
LastName
Suffix
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
MiddleName
49
Digital Goodsが対応しているエクスプレス チェックアウトAPIフィールド
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
支払い詳細タイプフィールド
OrderTotal
ItemTotal
TaxTotal
OrderDescription
InvoiceID
NotifyURL
PaymentDetailsItem
TransactionId
PaymentRequestID
支払い詳細品目タイプフィールド
Name
Description
Amount
Number
Quantity
Tax
ItemCategory
DoExpressCheckoutPayment SOAPリクエストフィールド
DoExpressCheckoutPaymentリクエストフィールド
Token
PayerID
PaymentDetails
ReturnFMFDetails
支払い詳細タイプフィールド
OrderTotal
ItemTotal
TaxTotal
OrderDescription
InvoiceID
NotifyURL
PaymentAction
PaymentDetailsItem
PaymentRequestID
支払い詳細品目タイプフィールド
Name
Description
Amount
Number
Quantity
Tax
ItemCategory
DoExpressCheckoutPayment SOAPレスポンスフィールド
DoExpressCheckoutPaymentレスポンスフィールド
Token
50
Note
RedirectRequired
2011年3月15日
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
Digital Goodsが対応しているエクスプレス チェックアウトAPIフィールド
Error! Use the Home tab to apply 見出し 2 to the text that you want to appear
here.
支払い情報フィールド
TransactionID
TransactionType
PaymentDate
GrossAmount
FeeAmount
SettleAmount
TaxAmount
ExchangeRate
PaymentStatus
PendingReason
ReasonCode
Digital Goodsインテグレーションガイド –
エクスプレス チェックアウト編
2011年3月15日
51