PayPal
本ガイドについて
本ガイドの内容
本ガイドは、(株)DGフィナンシャルテクノロジーが提供するVeriTrans4Gを利用するための専用ソフトウェアMDK(Merchant Development Kit)をインターネット店舗などに導入する開発者向けのガイドです。VeriTrans4G PayPal決済にて使用する電文のインターフェース詳細について記載しています。
VeriTrans4Gの詳細については、『VeriTrans4G 開発ガイド』を参照して下さい。
尚、インターフェース詳細は、決済サービス毎に提供していますので、当該決済サービスのインターフェース詳細を参照して下さい。
インターフェース詳細
本章では、各決済にて使用する電文(Dto)について説明します。以下の表に記載されているフィールドは、店舗様にて利用可能なフィールドです。
各電文(Dto)には、以下の表に記載されていないフィールドが定義されている場合がありますが、以下の表に記載されていないフィールドは店舗様では使用することはできません。
共通
-
「設定」欄の内容は以下の通りです。
- 要求電文 ...
- 必須項目:○ 任意項目:△ 設定不可:× その他条件付:※、※n(条件は説明欄、または欄外に記入)
- 応答電文 ...
- 必ず返戻:○ 処理成功時のみ返戻:△ 返戻なし:× その他条件付:※
-
orderId(取引ID)について
店舗で任意に採番してください。申込処理毎に付ける必要があります。他の取引IDと重複しないよう採番してください。他決済サービスとも重複できません。
また、テスト取引で使用した取引IDを、本番取引で再度使用することはできません。
取引IDには、半角英数字以外に"-"(ハイフン)、"_"(アンダースコア)も使用可能です。
与信
要求電文 : PaypalAuthorizeRequestDto
要求電文 : PaypalAuthorizeRequestDto | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 | ||||||||||
set | get | do | ||||||||||||
orderId | 取引ID | 半角英数字100桁以内 | 「2-1 共通」の「orderId(取引ID)について」参照 | ○ | × | × | ||||||||
amount | 決済金額 | 半角数字7桁以内 | 日本円 ※日本円で1,000,000円を上限とした金額を指定します。 |
○ | × | × | ||||||||
action | アクションタイプ | 右記参照 | "set": 与信請求処理 "get": 与信請求確認処理 "do ": 与信請求完了処理 |
○ | ○ | ○ | ||||||||
returnUrl | 戻り先URL | 半角英数字1024桁以内 | 消費者がPayPal上での操作が完了したときの遷移する店舗サイトのURLを指定 URLとして使用できる文字も使用可能です。 |
○ | × | × | ||||||||
cancelUrl | 取消URL | 半角英数字1024桁以内 | 消費者がPayPal上で支払いをキャンセルした場合に遷移する店舗サイトのURLを指定 URLとして使用できる文字も使用可能です。 |
○ | × | × | ||||||||
headerImageUrl | ヘッダーイメージURL | 半角英数字127桁以内 | PayPal画面のヘッダーに表示する画像のURLを指定画像サイズは最大750pixel×90pixelです。 URLとして使用できる文字も使用可能です。 |
△ | × | × | ||||||||
orderDescription | オーダー説明 | 文字列127バイト以内 | 商品の説明を指定 ※文字コードは"UTF-8"です。 |
△ | × | × | ||||||||
shippingFlag | 配送先フラグ | 半角数字1桁 右記参照 |
要求電文(PaypalAuthorizeRequestDto)の配送先情報(※1)をPayPalへ連携するか否かを指定 また、配送先情報を連携しない場合は、消費者のPayPalアカウントに登録されている自宅住所等の情報を利用するか否かを指定します。
※1:要求電文(PaypalAuthorizeRequestDto)の配送先情報 |
○ | × | × | ||||||||
shipName | 配送先氏名 | 文字列32バイト以内 |
※文字コードは"UTF-8" ※shippingFlag="1"の場合は必須項目 ※ShippingFlag="0"または"2"の場合は設定不可項目 |
※ | × | × | ||||||||
shipStreet1 | 配送先住所1 | 文字列100バイト以内 |
※文字コードは"UTF-8" ※shippingFlag="1 "の場合は必須項目 ※ShippingFlag="0"または"2"の場合は設定不可項目 |
※ | × | × | ||||||||
shipStreet2 | 配送先住所2 | 文字列100バイト以内 |
※文字コードは"UTF-8" ※shippingFlag="1 "の場合は任意項目 ※ShippingFlag="0"または"2"の場合は設定不可項目 |
△ | × | × | ||||||||
shipCity | 配送先市区町村名 | 文字列40バイト以内 |
※文字コードは"UTF-8" ※shippingFlag="1"の場合は必須項目 ※ShippingFlag="0"または"2"の場合は設定不可項目 |
※ | × | × | ||||||||
shipState | 配送先州名 | 文字列40バイト以内 |
※文字コードは"UTF-8" ※shippingFlag="1 "の場合は必須項目 ※ShippingFlag="0"または"2"の場合は設定不可項目 |
※ | × | × | ||||||||
shipCountry | 配送先国コード | 半角英数字2桁以内 |
※shippingFlag="1"の場合は必須項目 ※ShippingFlag="0"または"2"の場合は設定不可項目 |
※ | × | × | ||||||||
shipPostalCode | 配送先郵便番号 | 半角英数字20桁以内 | 半角英数字のほかに、"-"(ハイフン)も使用可能 ※shippingFlag="1 "の場合は必須項目 ※ShippingFlag="0"または"2"の場合は設定不可項目 |
※ | × | × | ||||||||
shipPhone | 配送先電話番号 | 半角英数字20桁以内 | 半角英数字のほかに、"-"(ハイフン)も使用可能 ※shippingFlag="1 "の場合は任意項目 ※ShippingFlag="0"または"2"の場合は設定不可項目 |
△ | × | × | ||||||||
payerId | 顧客番号 | 半角英数字13桁以内 | 顧客番号を指定します。PayPalから処理が戻ってきたとき、URL(戻り先URL)に付加されています。 | × | × | ○ | ||||||||
token | トークン | 半角英数字20桁以内 | 決済サーバーから返される値を指定します。 | × | ○ | ○ |
応答電文 : PaypalAuthorizeResponseDto
応答電文 : PaypalAuthorizeResponseDto | ||||||
---|---|---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 | ||
set | get | do | ||||
serviceType | 決済サービスタイプ | 半角英数字10文字以内 | 要求電文を送信した決済サービスタイプ | ○ | ○ | ○ |
mstatus | 処理結果コード | 半角英数字32文字以内 | "success" : 正常終了 "failure" : 異常終了 "pending" : 保留 ※"pending"はアクションタイプ(action)="do"の場合のみ返戻されます。 |
○ | ○ | ○ |
vResultCode | 詳細結果コード | 半角英数字16文字 | 処理の結果を詳細に表すコード 4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。 詳細は『結果コード一覧』を参照下さい。 |
○ | ○ | ○ |
merrMsg | エラーメッセージ | 文字列1024 バイト以内 | 処理結果を日本語で表示します。 | ○ | ○ | ○ |
marchTxn | 電文ID | 文字列100桁以内 | 決済サーバーにて決済処理電文(内部処理も含む)毎に付与するID 1つの取引IDに対して、複数のIDが付与されます。 |
○ | ○ | ○ |
orderId | 取引ID | 半角英数字100文字以内 | 決済要求時に店舗様にて任意に採番し送信された取引ID | ○ | △ | △ |
custTxn | 取引毎に付くID | 文字列100桁以内 | 決済サーバーがオーダー(取引ID)と紐付ける為に採番するID | ○ | ○ | ○ |
txnVersion | MDK バージョン | 半角英数字5 桁 | 電文のバージョン 問題発生時などに用いますが、通常ご利用になることはありません。 |
○ | ○ | ○ |
loginUrl | ログインURL | 文字列 | PayPalのログイン画面URL | △ | × | × |
token | トークン | 半角英数字20文字以内 | クエリストリングとしてログインURLに付加するトークン | △ | △ | △ |
invoiceId | 請求番号 | 半角英数字127文字以内 | 決済サーバーが発番するID | △ | △ | △ |
payerId | 顧客番号 | 半角英数字13文字以内 | PayPal側の消費者識別ID | × | △ | △ |
amount | 取引金額 | 半角数字 | 決済要求時に設定した金額 | × | △ | △ |
feeAmount | 手数料 | 半角数字 | 決済手数料 | × | × | △ |
settleAmount | 決済金額 | 半角数字 | 決済金額 | × | × | △ |
exchangeRate | 外貨換算レート | 半角英数字17文字以内 | 決済時に適用された外貨換算レート。消費者のメイン通貨は日本円以外のみ。 | × | × | △ |
paymentDate | 支払時刻 | 半角英数字14文字 | 支払時刻 | × | × | △ |
paymentStatus | 支払ステータス | 半角英数字 | 支払ステータス | × | × | △ |
centerAuthId | 決済センタ承認ID | 半角英数字17文字以内 | PayPalが発番するユニークなID | × | × | △ |
shipName | 配送先氏名 | 文字列 | shippingFlagによって返戻内容が変わります。 "0":成功時のみPayPalアカウントの配送先が返戻 "1":成功時のみ要求電文に設定した配送先が返戻 "2":返戻なし |
× | ※ | × |
shipStreet1 | 配送先住所1 | 文字列 | shippingFlagによって返戻内容が変わります。 "0":成功時のみPayPalアカウントの配送先が返戻 "1":成功時のみ要求電文に設定した配送先が返戻 "2":返戻なし |
× | ※ | × |
shipStreet2 | 配送先住所2 | 文字列 | shippingFlagによって返戻内容が変わります。 "0":成功時のみPayPalアカウントの配送先が返戻 "1":成功時のみ要求電文に設定した配送先が返戻(要求電文で設定した場合のみ返戻) "2":返戻なし |
× | ※ | × |
shipCity | 配送先市区町村名 | 文字列 | shippingFlagによって返戻内容が変わります。 "0":成功時のみPayPalアカウントの配送先が返戻 "1":成功時のみ要求電文に設定した配送先が返戻 "2":返戻なし |
× | ※ | × |
shipState | 配送先州名 | 文字列 | shippingFlagによって返戻内容が変わります。 "0":成功時のみPayPalアカウントの配送先が返戻 "1":成功時のみ要求電文に設定した配送先が返戻 "2":返戻なし |
× | ※ | × |
shipCountry | 配送先国コード | 半角英数字2文字以内 | shippingFlagによって返戻内容が変わります。 "0":成功時のみPayPalアカウントの配送先が返戻 "1":成功時のみ要求電文に設定した配送先が返戻 "2":返戻なし |
× | ※ | × |
shipPostalCode | 配送先郵便番号 | 半角英数字20文字以内 | shippingFlagによって返戻内容が変わります。 "0":成功時のみPayPalアカウントの配送先が返戻 "1":成功時のみ要求電文に設定した配送先が返戻 "2":返戻なし |
× | ※ | × |
shipPhone | 配送先電話番号 | 半角英数字20文字以内 | shippingFlagによって返戻内容が変わります。 "0":成功時のみPayPalアカウントの配送先が返戻 "1":成功時のみ要求電文に設定した配送先が返戻(要求電文で設定した場合のみ返戻) "2":返戻なし |
× | ※ | × |
売上
要求電文 : PaypalCaptureRequestDto
要求電文 : PaypalCaptureRequestDto | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 | |||||||||||
set | get | do | capture | ||||||||||||
orderId | 取引ID | 半角英数字100文字以内 | 決済請求、予信完了時に採番した取引IDを指定 | ○ | × | × | ○ | ||||||||
amount | 取引金額 | 半角数字7桁以内 | 日本円
※日本円で1,000,000円を上限とした金額を指定します。 |
○ | × | × | ○ | ||||||||
action | アクションタイプ | 半角英数字10文字以内 | "set": 売上請求処理 "get": 売上請求確認処理 "do" : 売上請求完了処理 "capture" : 売上請求完了処理 ※"capture"は与信を行った場合にのみ、実行可能 |
○ | ○ | ○ | ○ | ||||||||
returnUrl | 戻り先URL | 半角英数字1024文字以内 | 消費者がPayPal上での操作が完了したときの遷移する店舗サイトのURLを指定 URLとして使用できる文字も使用可能です。 |
○ | × | × | × | ||||||||
cancelUrl | 取消URL | 半角英数字1024文字以内 | 消費者がPayPal上で支払いをキャンセルした場合に遷移する店舗サイトのURLを指定 URLとして使用できる文字も使用可能です。 |
○ | × | × | × | ||||||||
headerImageUrl | ヘッダーイメージURL | 半角英数字127文字以内 | PayPal画面のヘッダーに表示する画像のURLを指定 画像サイズは最大750pixel×90pixelです。 URLとして使用できる文字も使用可能です。 |
△ | × | × | × | ||||||||
orderDescription | オーダー説明 | 文字列127Byte以内 | 商品の説明を指定 ※文字コードは"UTF-8"です。 |
△ | × | × | × | ||||||||
shippingFlag | 配送先フラグ | 半角英数字1文字以内 | 要求電文(PaypalCaptureRequestDto)の配送先情報(※1)をPayPalへ連携するか否かを指定 また、配送先情報を連携しない場合は、消費者のPayPalアカウントに登録されている自宅住所等の情報を利用するか否かを指定します。
※1:要求電文(PaypalCaptureRequestDto)の配送先情報 |
○ | × | × | × | ||||||||
shipName | 配送先氏名 | 文字列32Byte以内 |
※文字コードは"UTF-8" ※shippingFlag="1 "の場合は必須項目 ※ShippingFlag="0"または"2"の場合は設定不可項目 |
※ | × | × | × | ||||||||
shipStreet1 | 配送先住所1 | 文字列100Byte以内 |
※文字コードは"UTF-8" ※shippingFlag="1 "の場合は必須項目 ※ShippingFlag="0"または"2"の場合は設定不可項目 |
※ | × | × | × | ||||||||
shipStreet2 | 配送先住所2 | 文字列100Byte以内 |
※文字コードは"UTF-8" ※shippingFlag="1 "の場合は任意項目 ※ShippingFlag="0"または"2"の場合は設定不可項目 |
△ | × | × | × | ||||||||
shipCity | 配送先市区町村名 | 文字列40Byte以内 |
※文字コードは"UTF-8" ※shippingFlag="1 "の場合は必須項目 ※ShippingFlag="0"または"2"の場合は設定不可項目 |
※ | × | × | × | ||||||||
shipState | 配送先州名 | 文字列40Byte以内 |
※文字コードは"UTF-8" ※shippingFlag="1 "の場合は必須項目 ※ShippingFlag="0"または"2"の場合は設定不可項目 |
※ | × | × | × | ||||||||
shipCountry | 配送先国コード | 半角英数字2文字以内 |
※shippingFlag="1 "の場合は必須項目 ※ShippingFlag="0"または"2"の場合は設定不可項目 |
※ | × | × | × | ||||||||
shipPostalCode | 配送先郵便番号 | 半角英数字20文字以内 | 全角文字を除く文字列を設定 ※shippingFlag="1 "の場合は必須項目 ※ShippingFlag="0"または"2"の場合は設定不可項目 |
※ | × | × | × | ||||||||
shipPhone | 配送先電話番号 | 半角英数字20文字以内 | 全角文字を除く文字列を設定 ※shippingFlag="1 "の場合は任意項目 ※ShippingFlag="0"または"2"の場合は設定不可項目 |
△ | × | × | × | ||||||||
payerId | 顧客番号 | 半角英数字13文字以内 | PayPalから処理が戻ってきたとき、URL(戻り先URL)に付加されています。 | × | × | ○ | × | ||||||||
token | トークン | 半角英数字20文字以内 | トークンを設定 | × | ○ | ○ | × |
応答電文 : PaypalCaptureResponseDto
応答電文 : PaypalCaptureResponseDto | |||||||
---|---|---|---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 | |||
set | get | do | capture | ||||
serviceType | 決済サービスタイプ | 半角英数字10文字以内 | 要求電文を送信した決済サービスタイプ | ○ | ○ | ○ | ○ |
mstatus | 処理結果コード | 半角英数字32文字以内 | "success" : 正常終了 "failure" : 異常終了 "pending" : 保留 ※"pending"はアクションタイプ(action)="do "又は"capture"の場合のみ返戻されます。 |
○ | ○ | ○ | ○ |
vResultCode | 詳細結果コード | 半角英数字16文字 | 処理の結果を詳細に表すコード 4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。 詳細は『結果コード一覧』を参照下さい。 |
○ | ○ | ○ | ○ |
merrMsg | エラーメッセージ | 文字列1024 バイト以内 | 処理結果を日本語で表示します。 | ○ | ○ | ○ | ○ |
marchTxn | 電文ID | 文字列100桁以内 | 決済サーバーにて決済処理電文(内部処理も含む)毎に付与するID 1つの取引IDに対して、複数のIDが付与されます。 |
○ | ○ | ○ | ○ |
orderId | 取引ID | 半角英数字100文字以内 | 決済要求時に店舗様にて任意に採番し送信された取引ID | ○ | △ | △ | ○ |
custTxn | 取引毎に付くID | 文字列100桁以内 | 決済サーバーがオーダー(取引ID)と紐付ける為に採番するID | ○ | ○ | ○ | ○ |
txnVersion | MDK バージョン | 半角英数字5 桁 | 電文のバージョン 問題発生時などに用いますが、通常ご利用になることはありません。 |
○ | ○ | ○ | ○ |
loginUrl | ログインURL | 文字列 | PayPalのログイン画面URL | △ | × | × | × |
token | トークン | 半角英数字20文字以内 | クエリストリングとしてログインURLに付加するトークン | △ | △ | △ | × |
invoiceId | 請求番号 | 半角英数字127文字以内 | 決済サーバーが発番するID | △ | △ | △ | △ |
payerId | 顧客番号 | 半角英数字13文字以内 | PayPal側の消費者識別ID | × | △ | △ | × |
amount | 取引金額 | 半角数字 | 決済要求時に設定した金額 | × | △ | △ | △ |
feeAmount | 手数料 | 半角数字 | 決済手数料 | × | × | △ | △ |
settleAmount | 決済金額 | 半角数字 | 決済金額 | × | × | △ | △ |
exchangeRate | 外貨換算レート | 半角英数字17文字以内 | 決済時に適用された外貨換算レート。消費者のメイン通貨は日本円以外のみ。 | × | × | △ | △ |
paymentDate | 支払時刻 | 半角英数字14文字 | 支払時刻 | × | × | △ | △ |
paymentStatus | 支払ステータス | 半角英数字 | 支払ステータス | × | × | △ | △ |
centerTxnId | 決済センタ取引ID | 半角英数字19文字以内 | PayPalが発番するユニークなID | × | × | △ | △ |
shipName | 配送先氏名 | 文字列 | shippingFlagによって返戻内容が変わります。 "0":成功時のみPayPalアカウントの配送先が返戻 "1":成功時のみ要求電文に設定した配送先が返戻 "2":返戻なし |
× | ※ | × | × |
shipStreet1 | 配送先住所1 | 文字列 | shippingFlagによって返戻内容が変わります。 "0":成功時のみPayPalアカウントの配送先が返戻 "1":成功時のみ要求電文に設定した配送先が返戻 "2":返戻なし |
× | ※ | × | × |
shipStreet2 | 配送先住所2 | 文字列 | shippingFlagによって返戻内容が変わります。 "0":成功時のみPayPalアカウントの配送先が返戻 "1":成功時のみ要求電文に設定した配送先が返戻(要求電文で設定した場合のみ返戻) "2":返戻なし |
× | ※ | × | × |
shipCity | 配送先市区町村名 | 文字列 | shippingFlagによって返戻内容が変わります。 "0":成功時のみPayPalアカウントの配送先が返戻 "1":成功時のみ要求電文に設定した配送先が返戻 "2":返戻なし |
× | ※ | × | × |
shipState | 配送先州名 | 文字列 | shippingFlagによって返戻内容が変わります。 "0":成功時のみPayPalアカウントの配送先が返戻 "1":成功時のみ要求電文に設定した配送先が返戻 "2":返戻なし |
× | ※ | × | × |
shipCountry | 配送先国コード | 半角英数字2文字以内 | shippingFlagによって返戻内容が変わります。 "0":成功時のみPayPalアカウントの配送先が返戻 "1":成功時のみ要求電文に設定した配送先が返戻 "2":返戻なし |
× | ※ | × | × |
shipPostalCode | 配送先郵便番号 | 半角英数字20文字以内 | shippingFlagによって返戻内容が変わります。 "0":成功時のみPayPalアカウントの配送先が返戻 "1":成功時のみ要求電文に設定した配送先が返戻 "2":返戻なし |
× | ※ | × | × |
shipPhone | 配送先電話番号 | 半角英数字20文字以内 | shippingFlagによって返戻内容が変わります。 "0":成功時のみPayPalアカウントの配送先が返戻 "1":成功時のみ要求電文に設定した配送先が返戻(要求電文で設定した場合のみ返戻) "2":返戻なし |
× | ※ | × | × |
- 消費者のPayPalアカウントが制限またはロックされている場合
- 店舗様のアカウントの制限レベルが高い場合(リスクが高いアカウントの場合)
結果
リダイレクト受信内容:PayPalから消費者ブラウザ経由で店舗へリダイレクト(GET)される内容
PayPalから消費者ブラウザを経由して店舗様サイトへ送信される項目となります。このリダイレクトを受信し、getまたはdoを行います。
リダイレクト受信内容:PayPalから消費者ブラウザ経由で店舗へリダイレクト(GET)される内容 | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
token | トークン | 半角英数字20文字以内 | クエリストリングとしてログインURLに付加するトークン | ○ |
PayerId | 顧客番号 | 半角英数字13桁以内 | 顧客番号を指定。PayPalから処理が戻ってきたとき、URL(戻り先URL)に付加されています。 | ○ |
キャンセル
※キャンセル処理は与信を実施した取引(PaypalAuthorizeRequestDtoにてaction="do "(与信請求完了処理))のみに実行可能です。
また、与信後に売上まで実施した取引(PaypalCaptureRequestDtoにてaction="capture"(売上請求完了処理))には実行できません。
キャンセルが可能な期間は、与信を実施した日から30日間となります。30日以内に売上処理されなかった与信は自動的にキャンセルになります。
要求電文 : PaypalCancelRequestDto
要求電文 : PaypalCancelRequestDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
orderId | 取引ID | 半角英数字100桁以内 | 決済請求、与信完了時に採番した取引ID | ○ |
応答電文 : PaypalCancelResponseDto
応答電文 : PaypalCancelResponseDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
serviceType | 決済サービスタイプ | 半角英数字10文字以内 | 要求電文を送信した決済サービスタイプ | ○ |
mstatus | 処理結果コード | 半角英数字32文字以内 | "success" : 正常終了 "failure" : 異常終了 "pending" : 保留 |
○ |
vResultCode | 詳細結果コード | 半角英数字16文字 | 処理の結果を詳細に表すコード 4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。 詳細は『結果コード一覧』を参照下さい。 |
○ |
merrMsg | エラーメッセージ | 文字列1024 バイト以内 | 処理結果を日本語で表示します。 | ○ |
marchTxn | 電文ID | 文字列100桁以内 | 決済サーバーにて決済処理電文(内部処理も含む)毎に付与するID 1つの取引IDに対して、複数のIDが付与されます。 |
○ |
orderId | 取引ID | 半角英数字100文字以内 | 決済要求時に店舗様にて任意に採番し送信された取引ID | ○ |
custTxn | 取引毎に付くID | 文字列100桁以内 | 決済サーバーがオーダー(取引ID)と紐付ける為に採番するID | ○ |
txnVersion | MDKバージョン | 半角英数字5 桁 | 電文のバージョン 問題発生時などに用いますが、通常ご利用になることはありません。 |
○ |
返金
※返金処理は与信後に売上まで実施した取引(PaypalCaptureRequestDtoにてaction="capture"(売上請求完了処理))にのみ実行可能です。
返金が可能な期間は、売上実施日から180日間となります。
要求電文 : PaypalRefundRequestDto
要求電文 : PaypalRefundRequestDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
orderId | 取引ID | 半角英数字100桁以内 | 決済請求、与信完了時に採番した取引ID | ○ |
amount | 取引金額 | 半角数字7桁以内 | 返金する金額を指定 ※一部キャンセルも可能 |
○ |
応答電文 : PaypalRefundResponseDto
応答電文 : PaypalRefundResponseDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
serviceType | 決済サービスタイプ | 半角英数字10文字以内 | 要求電文を送信した決済サービスタイプ | ○ |
mstatus | 処理結果コード | 半角英数字32文字以内 | "success" : 正常終了 "failure" : 異常終了 "pending" : 保留 |
○ |
vResultCode | 詳細結果コード | 半角英数字16文字 | 処理の結果を詳細に表すコード 4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。 詳細は『結果コード一覧』を参照下さい。 |
○ |
merrMsg | エラーメッセージ | 文字列1024 バイト以内 | 処理結果を日本語で表示します。 | ○ |
marchTxn | 電文ID | 文字列100桁以内 | 決済サーバーにて決済処理電文(内部処理も含む)毎に付与するID 1つの取引IDに対して、複数のIDが付与されます。 |
○ |
orderId | 取引ID | 半角英数字100文字以内 | 決済要求時に店舗様にて任意に採番し送信された取引ID | ○ |
custTxn | 取引毎に付くID | 文字列100桁以内 | 決済サーバーがオーダー(取引ID)と紐付ける為に採番するID | ○ |
txnVersion | MDKバージョン | 半角英数字5 桁 | 電文のバージョン ※問題発生時などに用いますが、通常ご利用になることはありません。 |
○ |
feeRefundAmount | 払い戻し手数料 | 半角数字 | △ | |
refundAmount | 返金金額 | 半角数字 | △ | |
netRefundAmount | 純返金金額 | 半角数字 | △ | |
principalAmount | 元金額 | 半角数字 | △ | |
settlementBalance | 決済残高 | 半角数字 | △ | |
invoiceId | 請求番号 | 半角英数字127文字以内 | 決済サーバーが発番するID | △ |
centerTxnId | 決済センタ取引ID | 半角英数字19文字以内 | △ |
結果通知
PayPal決済の結果通知には、速報と確報の2種類があります。
速報通知: 売上/返金の要求に対し、PayPalから成功応答を受信した直後に店舗様に送信します。(成功時のみ送信)
確報通知: 売上/返金の翌日以降にPayPalが作成する取引明細レポートの結果を、確定情報として店舗様に送信します。(成功、失敗を問わず送信)
- 確報通知は、原則としてN+1日に、N日0時~24時の取引明細を元に送信します。
- 速報の結果とは異なるステータスを通知する場合があります。
- 確報通知の処理結果コードが「保留」の場合は、その後「成功」または「失敗」に変更されます。その際は確報通知が再度送信されます。
- 消費者から異議申立てを受けた取引等は、N+1日以降の取引明細レポートで結果が確定する場合がありますので、確報通知はN+1日以降に送信される可能性があります。
結果通知に関するサービス共通の仕様については、『開発ガイド』を併せてご参照ください。
項番 | フィールド名 | 項目名 | 書式・制限 | 説明 |
---|---|---|---|---|
1 | numberOfNotify | 通知件数 | 半角数字4桁以内 | 1度に通知可能な件数は1,000件 (1,001件以上は次回通知) |
2 | pushTime | 送信時刻 | 半角数字14桁 | 決済サーバーから通知した時刻 (YYYYMMDDhhmmss形式) |
3 | pushId | 識別ID | 半角数字8桁 |
プッシュ処理を行うたびに採番されるID
注) 他の決済サービスで使用されたIDと重複する場合があります。 |
4 | fixed | 速報・確報フラグ | 半角数字1桁 | "0":速報データ "1":確報データ |
通知件数分下記の項番(5~12)を繰り返す。尚、フィールド名の後ろに4ケタの連番(0000~0999)を付与する。 | ||||
5 | orderId | 取引ID | 半角英数字100桁以内 | |
6 | mstatus | 処理結果コード | 半角英数字32文字以内 | "success":成功 "failure":失敗 "pending":保留 |
7 | txnType | トランザクションタイプ | 半角英数字32桁以内 | "Capture":売上 "Refund":返金 |
8 | receivedDatetime | 受付日時 | 半角数字14桁 | YYYYMMDDhhmmss形式 |
9 | amount | 金額 | 半角数字10桁以内 | 決済要求時に設定した金額または返金金額 |
10 | payerId | お客様番号 | 半角英数字13桁以内 | PayPal側の消費者識別ID |
11 | centerTxnId | 取引識別子 | 半角英数字19桁以内 | |
12 | dummy | ダミー決済フラグ | 半角数字1桁 | ダミーデータを示す場合は"1"を設定 |
- pushId(識別ID)は、他の決済サービスで使用されたIdと重複する場合がありますので、ユニークキーとして処理しないようにしてください。
- 項目の並び順は、必ずしも表の順序とは一致しません。
その他
売り手保護制度について
「売り手保護制度」とは、消費者がPayPal決済を利用し商品を購入した際、「未承認取引」や「商品未受領」等を理由とした消費者からのクレーム、チャージバック、支払いの取り消しが発生した場合に、店舗様が保護されるプログラムです。
尚、「売り手保護制度」はPayPal社が提供する保護プログラムであり、その保護を受けるためにはPayPal社が定める適用条件を満たす必要があります。
「売り手保護制度」の対象とするためには、与信時(Authorizeコマンド)、与信同時売上時(Captureコマンド)とも、アクションタイプが"get"で送信された要求電文(PaypalAuthorizeRequestDto/PaypalCaptureRequestDto)に対応する応答電文(PaypalAuthorizeResponseDto/PaypalCaptureResponseDto)にて返戻される配送先情報※1へ配送するようお願いいたします。
※1:応答電文(PaypalAuthorizeResponseDto/PaypalCaptureResponseDto)にて返戻される配送先情報
配送先氏名(shipName)、配送先住所1(shipStreet1)、配送先住所2(shipStreet2)、配送先市区町村名(shipCity)、配送先州名(shipState)、配送先国コード(shipCountry)、
配送先郵便番号(shipPostalCode)、配送先電話番号(shipPhone)
ただし、上記配送先情報へ配送した場合でも、必ず「売り手保護制度」の対象になるとは限りませんので、ご注意ください。 詳細につきましては、以下をご参照ください。
https://www.paypal.com/jp/webapps/mpp/ua/useragreement-full?locale.x=ja_JP#bus_premier_9 https://www.paypal.jp/jp/contents/support/faq/faq-060/また、与信時(Authorizeコマンド)、与信同時売上時(Captureコマンド)とも、要求電文(PaypalAuthorizeRequestDto/PaypalCaptureRequestDto)にて「配送先フラグ(shippingFlag)」に"2"(配送先の設定を連携・表示しない)を設定していた場合は、「売り手保護制度」の対象とはなりません。
処理結果コードが「pending(保留)」の取引について
決済要求の結果、PayPal側で保留判定となった場合は、処理結果コード「pending(保留)」を返します。保留となった取引については、その後、PayPal側で「成功」または「失敗」の判定に変更されたら、弊社よりマーチャント様に確報通知を送信します。
保留判定となった原因につきましては、弊社よりPayPal社に確認いたしますので、弊社にお問い合わせください。
tokenの有効期限について
tokenの有効期限は発行後3時間です。
有効期限を超過するとPayPal社にて決済の継続が拒否されます。
注)2017年7月現在の仕様です。この仕様は、PayPal社にて予告なしに変更される可能性があります。