楽天ペイV2 都度決済
概要
楽天ペイ(オンライン決済)V2(以下「楽天ペイV2」)は、楽天会員を対象としたオンライン決済サービスです。
お客様は楽天IDに登録したクレジットカードや楽天ポイントの残高を利用して、クレジットカード情報をその都度入力することなく、安全かつ簡単に決済できます。楽天会員基盤を活用した広範なユーザー層へのリーチが可能です。
楽天ペイV2(都度決済)を始めるには
-
契約の確認・申込
ご利用には楽天ペイ(オンライン決済)V2の契約が必要です。未契約の場合は営業担当へご連絡ください。サービスリリース前に楽天レギュレーションの対応状況を確認する表記審査・システムチェックがございます。
実装前に楽天レギュレーションをご確認ください。詳細は楽天ペイメント株式会社へお問い合わせください。 -
テスト環境での動作確認
テスト環境に関する情報はこちらを確認してください。 -
本番稼働開始
動作確認完了後、本番運用を開始します。 テスト環境⇒本番環境への切り替えチェックリストはこちら
接続方式のサポート
| 接続方式 | サポート状況 | 関連リンク |
|---|---|---|
| OpenAPIタイプ | ✔ 対応 | API仕様 |
| プロトコルタイプ | ✔ 対応 | API仕様(idPass) API仕様(json) |
| リンクタイプ Plus | ✔ 対応 | API仕様/決済識別子 |
取引状態
楽天ペイV2(都度決済)で取り得る取引状態は以下の通りです。
| 取引状態 | コード | 説明 |
|---|---|---|
| 未決済 | UNPROCESSED | 決済が完了していない状態(お客様のご注文途中の離脱が主な原因) |
| 要求成功 | REQSUCCESS | 決済準備が整った状態(まだお客様は支払っていません) |
| 認証処理中 | AUTHPROCESS | 楽天ペイでの支払い中の状態 |
| 仮売上 | AUTH | 決済が正常に完了し、ご利用枠を確保した状態(お客様への請求は発生しません) |
| 実売上 | SALES | 仮売上後に売上が確定した状態 |
| 即時売上 | CAPTURE | 売上が確定した状態 |
| キャンセル | CANCEL | 仮売上の取引がキャンセルされた状態 |
| 返品 | RETURN | 実売上/即時売上の取引がキャンセルされた状態 |
| 決済失敗 | PAYFAIL | お客様のクレジットカード状態や、システムトラブル等の何らかの原因で決済、利用承諾に失敗した状態 |
| 期限切れ | EXPIRED | 要求成功および認証処理中の状態を一定時間経過した状態 |
実売上
実売上可能期間
実売上は最後の仮売上日※1から30日後まで、かつ初回の仮売上日から365日後※2まで可能です。
※1 「最後の仮売上日」:仮売上、金額変更、仮売上有効期限延長の最終実施日
※2 対象取引の更新が無い場合は原則180日でデータが削除され、以降は処理ができなくなります。
金額変更、仮売上有効期限延長により取引を更新した場合の最大日数が365日後となりますのでご注意ください。
期限を超過した場合はエラー(期限切れ)となり、売上確定できません。
仮売上有効期限の延長
同額で金額変更のAPIを実行することで、仮売上有効期限の延長が可能です。
再オーソリを行うため、お客様の限度額を超えた場合は失敗する可能性があります。
- 仮売上有効期限延長 可能回数:一つの取引に対し、成功・失敗合わせて15回までです。
可能回数を超えた場合は「RP1000006」エラーが返却されます。 - 仮売上有効期限延長 可能期間:初回の仮売上日から365日後※1まで
かつ最後の仮売上日※2から160日後まで
※1 対象取引の更新が無い場合は原則180日でデータが削除され、以降は処理ができなくなります。
金額変更、仮売上有効期限延長により取引を更新した場合の最大日数が365日後となりますのでご注意ください。
※2 「最後の仮売上日」とは、仮売上、金額変更、仮売上有効期限延長の最終実施日を指します。
返金
キャンセル操作は取引状態によりキャンセル可能期間が異なります。
| 取引状態 | キャンセル可能期間 |
|---|---|
| 仮売上 | 初回の仮売上日から365日後※まで |
| 実売上 | 初回の仮売上日から365日後※まで かつ実売上日から30日後まで |
| 即時売上 | 即時売上日から30日後まで |
金額変更、仮売上有効期限延長により取引を更新した場合の最大日数が365日後となりますのでご注意ください。
キャンセル可能期限を過ぎた場合、楽天ポイント/キャッシュは返還されません。
お客様とのトラブル防止のため、各処理期限までに実売上処理、またはキャンセル/返品を実施してください。
既定の期限を超過し実売上処理、またはキャンセル/返品をともに行えなくなった場合、楽天ポイント/キャッシュについては加盟店様にてお客様へ直接返金を実施してください。
決済後に在庫の引き当てが出来なかった場合は、速やかにキャンセルを実施してください。
(お客様が期間限定ポイントを使用していた場合、トラブルに発展する可能性があるため。)
金額変更
- 増額・減額ともに可能です。
- 金額変更の回数に制限はありません。
- 取引状態により金額変更可能期間が異なります。
| 取引状態 | 金額変更可能期間 |
|---|---|
| 仮売上 | 初回の仮売上日から365日後※1まで かつ最後の仮売上日※2から30日後まで |
| 実売上 | 初回の仮売上日から365日後※1まで かつ実売上日から30日後まで |
| 即時売上 | 即時売上日から30日後まで |
※1 対象取引の更新が無い場合は原則180日でデータが削除され、以降は処理ができなくなります。
金額変更、仮売上有効期限延長により取引を更新した場合の最大日数が365日後となりますのでご注意ください。
※2 「最後の仮売上日」とは、仮売上、金額変更、仮売上有効期限延長の最終実施日を指します。
期限切れ
支払い可能期間
決済実行後、30分以内にお客様が楽天ペイ決済画面にログインする必要があります。
また、ログイン後、60分以内に決済を完了する必要があります。
この期間を超過した場合、取引状態は期限切れとなります。
期限切れになるタイミング
状態が要求成功(REQSUCESS)または認証処理中(AUTHPROCESS)のまま処理期限が過ぎた取引については、毎日夜間に取引状態を期限切れ(EXPIRED)に更新します。
その他留意事項
楽天の管理画面(Dashboard)での操作
楽天の管理画面(Dashboard)にて実売上、キャンセル、金額変更処理を実施しないでください。
処理内容が当サービスへ反映されないため、楽天と弊社間で状態不整合が発生し、トラブルの原因となります。
必ず当サービスを利用して処理を実施してください。
支払いボタンのレギュレーション
楽天ペイ選択後、楽天ログイン画面へ遷移させる遷移元画面に設置いただくボタンは楽天指定のソースコードである必要があります。
実装前に楽天レギュレーションをご確認ください。
詳細は楽天ペイメント株式会社へお問い合わせください。
お客様へのメール通知
以下の処理タイミングで楽天からお客様にメールが送信されます。
- 決済成功時
- 金額変更時(同額は含まない)
- キャンセル時
決済リトライ機能
決済実行にて決済リトライ可能回数を指定すると、お客様の選択したクレジットカードに不備があり決済に失敗した際に、再度クレジットカードを選び直し決済していただくことが可能です。
決済に成功するか、指定した回数分失敗すると加盟店様へ結果が返却されます。
楽天の判定により、指定した回数未満で結果が返却されることもあります。
3Dセキュアの挙動
注文/申込時に3Dセキュア認証を行っていたとしても、お客様が支払画面を経由しないオーソリ取得については3Dセキュアが無効となります。
(例:購入後の金額変更、再オーソリ処理、汎用決済の注文)
ただし、例外として実売上状態の注文に対する減額の金額変更処理については、オーソリの再取得を行っていないため3Dセキュアは有効のままです。
ロゴ画像
ロゴ
必ずロゴマーク利用ガイドラインを確認の上ご利用ください。
ロゴはデザイン、カラーを変更せず十分な余白を用意し、そのままの状態で利用ください。
注文ボタン(「楽天IDでお支払い」ボタン)
注文ボタンを設置可能です。JavaScriptコードを支払ページに埋め込んで、ボタンを表示させてください。
「楽天IDでお支払い」というボタンが表示されます。
JavaScriptはボタンを表示させる機能のみを提供しており、Submit等の動作をする機能は提供していません。
注文ボタンを押下後に決済実行を呼び出すことを推奨しております。
注文ボタンの仕様の詳細は楽天ペイメント株式会社へお問い合わせください。
設定パラメータ
| 設定値 | データ型 | 必須 | 説明 |
|---|---|---|---|
src | 文字列 | Y | 注文ボタンを作成するための設定値。 固定値: https://contents.online.checkout.rakuten.co.jp/live/button/v1/rakuten-pay.js |
class | 文字列 | Y | 注文ボタン作成するための設定値。 固定値: rakuten-checkout-button |
data-button-type | 文字列 | N | 注文ボタンのデザインを指定する設定値。 現在提供しているデザインは defaultのみ。 |
data-button-width | 数字 | N | 注文ボタンのサイズを指定する設定値 指定できる範囲:165~640 指定されていない場合は240になる。 範囲外の値が指定された場合は、限界値のサイズになる。 |
サンプルコード
<button id="purchase" style="border: none; background:transparent">
<script src='https://contents.online.checkout.rakuten.co.jp/live/button/v1/rakuten-pay.js' class='rakuten-checkout-button' data-button-type='default' data-button-width='200'></script>
<noscript>Rakuten Payで購入する</noscript>
</button>