こちらのサイトではOmni Payment Gatewayの決済機能を簡単に実装するための手順がご覧いただけます。

オムニチャネル決済業務の概要は以下の通りです。

下記機能は利用される決済手段によらず、利用可能です。

上記機能以外は決済手段ごとに提供している機能が異なります。各決済事業者ごとの提供機能のマッピングは以下の通りです。

※1 利用者が直接、決済事業者のWebページやアプリにアクセスして支払(オーソリ)を行います。詳しくは処理シーケンスをご覧ください。
※2 支払・同時売上時のadviceTransactionの要否は決済手段によって異なります。詳しくは各決済手段の処理シーケンスをご覧ください。
※3 d払いは支払・同時売上・売上確定・返金に対してのみ障害取消が可能です。
※4 楽天ペイは支払・同時売上に対してのみ障害取消が可能です。
※5 Bank Payは同時売上に対してのみ障害取消が可能です。
※6 オーソリ金額の変更については、correctAmountTransaction（金額補正） をご利用ください。

決済手段ごとに取引期限が異なります。各決済手段ごとの取引期限は以下の通りです。
加盟店様のサービス利用状況（決済手段の停止・加盟店様の解約ステータス）によって取引期限が変わります。詳細はサービス仕様書をご参照ください。

※1 クレジットカードの期限はあくまで、本サービスのシステム上の期限です。また、障害取消に関しては、売上データ連携（日次、夜間実行）が既に行われた取引については期限内であっても障害取消不可となっています。
※2 d払いの障害取消に関しては上記期限とは別に、売上データ連携（日次、夜間実行）が既に行われた取引（売上確定、同時売上、返金が該当）に対しても障害取消不可となっています。
※3 楽天ペイの場合は、予約商品や受注生産商品を扱う加盟店様で、初回支払もしくは再支払から160日経過以降に売上確定/金額変更ありの再オーソリを実施する際は、金額変更なしの再オーソリを利用して与信の再取得を行ってください。処理期限が延長されます。
※4 PayPayとの契約によっては売上確定期限・支払キャンセル期限を30日から延ばすことも可能です。売上確定期限・支払キャンセル期限は紐づいており、個別に設定することはできないのでご注意ください。
また売上確定期限・支払キャンセル期限を30日から延ばしており、利用者がPayPay後払いを利用している場合に期限内に支払（オーソリ）が成功したとしても売上確定・支払キャンセルが失敗する場合があります。売上確定が失敗したが商品を提供してしまった場合についてPayPay及び決済代行事業者（PSP）による補償はありません。
※5 コンビニ決済(番号払い)の支払期限日時は、最大で89日後の23:59:59まで指定可能です。
※6 初回オーソリ日から3ヶ月経過後、最初に迎える月末までが期限日です。期限日翌日に決済事業者側で対象取引の強制キャンセルが行われます。
※7 銀行ネット決済の支払期限日時は、最大で60日後の23:59:59まで指定可能です。
※8 Bank Payは同時売上に対しての取引期限となっています。

各処理シーケンスの一覧は以下です。

決済手段に依らない共通の処理シーケンスは以下の通りです。

認証

決済グループ情報取得

決済手段の情報取得（一覧）

決済手段の情報取得（詳細）

取引情報取得

サブスクライブ

※1 Callbacksに対して、HTTPステータスコードを返却されない場合、最大3回（2回リトライ）POSTされます。
※2 サブスクライブの設定が完了した際と、取引が更新された場合、指定されたcallbackUrlにCallbacksがPOSTされます。詳しくはsubscribeTransactionをご参照ください。
※3 HTTPステータスコードは202もしくは204を返してください。詳しくはsubscribeTransactionをご参照ください。

決済取引の情報取得（一覧）

決済事業者取引参照

クレジットカード決済における処理シーケンスを以下に記載します。

支払（オーソリ・3Dセキュア認証なし）+売上確定

売上確定後、翌日に決済事業者へ精算用のファイルが送信されます。
セキュリティコード認証でも同様のフローとなり、API実行時に関連する情報を設定する必要があります。

※1リクエスト時、captureNowにtrueを設定すると支払（オーソリ）と売上確定のタイミングが同時になります。取引のactionは"CAPTURE"となり、シーケンス上の売上確定判断以降を行う必要はありません。

支払（オーソリ・3Dセキュア認証あり）+売上確定

支払(トークン決済)

トークンを用いて決済を行うことで、加盟店様はカード情報の保持が不要です。利用者は決済実施前にカード情報を登録する必要があります。

支払（3Dセキュア認証なし）+決済情報預かり手段登録

事前に決済情報預かりの顧客登録を実施しておく必要があります。
支払が失敗した場合は、決済手段は登録されません。

支払（3Dセキュア認証あり）+決済情報預かり手段登録

事前に決済情報預かりの顧客登録を実施しておく必要があります。
payTransactionの段階ではまだ決済情報預かりの決済手段登録は実施されておらず、決済手段一覧取得でも返却されません。adviceTransactionの決済要求が正常に完了したら決済手段登録が実施されます。

再支払（再オーソリ取引）

支払＋売上確定のパターンにおいて、売上確定前に支払(オーソリ)額を変更したい場合、支払を再実行することで対応できます。

金額補正（支払）

金額補正（売上確定）

支払キャンセル

返金

強制取消

障害取消

リクエスト送信時、通信障害などの理由で、本サービスに要求した処理（以下当該処理と表記）の結果が不明である際に障害取消を送信し取引をリセットできます。障害取消を送信する必要のある取引の結果コードはresultCodeをご参照ください。

クレジットカード詳細情報取得

クレジットカード詳細情報取得における処理シーケンスは以下の通りです。

クレジットカード有効性確認（3Dセキュア認証なし）

クレジットカード有効性確認（3Dセキュア認証あり）

コンビニ決済(番号払い)における処理シーケンスは以下の通りです。

支払（オーソリ）+売上確定

支払から売上確定までの処理シーケンスです。

※1 Callbacksに対して、HTTPステータスコードを返却されない場合、最大3回（2回リトライ）POSTされます。
※2 サブスクライブの設定が完了した際と、取引が更新された場合、指定されたcallbackUrlにPOSTされます。詳しくはsubscribeTransactionをご参照ください。
※3 HTTPステータスコードは202もしくは204を返してください。詳しくはsubscribeTransactionをご参照ください。

支払キャンセル

注文登録後、入金される前に注文取消を行う際の処理シーケンスです。

支払期限切れ

注文登録後、支払期限までに入金がされなかった場合の処理シーケンスです。
期限切れが通知された取引であっても、入金が成立するタイミングによってはこちらの後に入金通知を受け取る場合があります。

※1 Callbacksに対して、HTTPステータスコードを返却されない場合、最大3回（2回リトライ）POSTされます。
※2 サブスクライブの設定が完了した際と、取引が更新された場合、指定されたcallbackUrlにPOSTされます。詳しくはsubscribeTransactionをご参照ください。
※3 HTTPステータスコードは202もしくは204を返してください。詳しくはsubscribeTransactionをご参照ください。

メール再送

振込番号を記載したメールを利用者へ再送できます。

PayPayにおける処理シーケンスは以下の通りです。

支払（オーソリ）+売上確定 ブラウザ利用（ID、パスワード入力）

決済事業者の画面にID、パスワードでログインして決済を行う方法です。

※1 リクエスト時、captureNowにtrueを設定すると支払（オーソリ）と売上確定のタイミングが同時になります。取引のactionは"CAPTURE"となり、シーケンス上の売上確定判断以降を行う必要はありません。
※2 Callbacksに対して、HTTPステータスコードを返却されない場合、最大3回（2回リトライ）POSTされます。
※3 サブスクライブの設定が完了した際と、取引が更新された場合、指定されたcallbackUrlにPOSTされます。詳しくはsubscribeTransactionをご参照ください。
※4 HTTPステータスコードは202もしくは204を返してください。詳しくはsubscribeTransactionをご参照ください。
※5 リクエスト時にredirectUrlを設定しない場合、リダイレクトしません。
※6 増額売上確定時のみ、売上確定状況監視を行います。

支払（オーソリ）+売上確定 ブラウザ利用（コード読み取り）

決済事業者の画面に表示されたQRコードをアプリで読み取って決済を行う方法です。

※1 リクエスト時、captureNowにtrueを設定すると支払（オーソリ）と売上確定のタイミングが同時になります。取引のactionは"CAPTURE"となり、シーケンス上の売上確定判断以降を行う必要はありません。
※2 Callbacksに対して、HTTPステータスコードを返却されない場合、最大3回（2回リトライ）POSTされます。
※3 サブスクライブの設定が完了した際と、取引が更新された場合、指定されたcallbackUrlにPOSTされます。詳しくはsubscribeTransactionをご参照ください。
※4 HTTPステータスコードは202もしくは204を返してください。詳しくはsubscribeTransactionをご参照ください。
※5 リクエスト時にredirectUrlを設定しない場合、リダイレクトしません。
※6 増額売上確定時のみ、売上確定状況監視を行います。

支払（オーソリ）+売上確定 スマートフォンAPP連携利用

※1 リクエスト時、captureNowにtrueを設定すると支払（オーソリ）と売上確定のタイミングが同時になります。取引のactionは"CAPTURE"となり、シーケンス上の売上確定判断以降を行う必要はありません。
※2 Callbacksに対して、HTTPステータスコードを返却されない場合、最大3回（2回リトライ）POSTされます。
※3 サブスクライブの設定が完了した際と、取引が更新された場合、指定されたcallbackUrlにPOSTされます。詳しくはsubscribeTransactionをご参照ください。
※4 HTTPステータスコードは202もしくは204を返してください。詳しくはsubscribeTransactionをご参照ください。
※5 リクエスト時にredirectUrlを設定しない場合、リダイレクトしません。
※6 増額売上確定時のみ、売上確定状況監視を行います。

支払キャンセル

返金

障害取消

支払（payTransaction）実行後にサービスの障害などのエラーにより取引が失敗・もしくは応答を受信できない場合は、まず通常の支払キャンセル（cancelTransaction）を実行します。
支払キャンセルが失敗する場合、障害取消（cancelUnresponsedTransaction）を実行してください。
※障害取消（cancelUnresponsedTransaction）は支払（payTransaction）に対してのみ行えます。

売上確定、同時売上、返金の再送

売上確定、同時売上、返金実行後にサービスの障害などのエラーにより取引が失敗・もしくは応答を受信できない場合は、同取引の再送を行います。
本シーケンスは返金を例に記載します。

楽天ペイにおける処理シーケンスは以下の通りです。

支払（オーソリ）+売上確定

※1 リクエスト時、captureNowにtrueを設定すると支払（オーソリ）と売上確定のタイミングが同時になります。取引のactionは"CAPTURE"となり、シーケンス上の売上確定判断以降を行う必要はありません。
※2 利用者操作中にエラーが発生した場合はpayTransactionリクエスト時に設定いただいた失敗URLにリダイレクトします。
※3 adviceTransactionを実行し実際に与信確保を行う前に在庫の確認を行うことを推奨します。
※4 adviceTransactionは利用者が支払画面上で支払に同意してから30分以内に実行する必要があります。

再支払（再オーソリ・金額変更あり）

支払＋売上確定のパターンにおいて、その時点の支払額と異なる金額を設定して再支払（再オーソリ）を実行することで、売上確定前に支払(オーソリ)額を変更できます。

再支払（再オーソリ・金額変更なし）

支払＋売上確定のパターンにおいて、その時点の支払額と同額を設定して再支払（再オーソリ）を実行することで、与信を再取得し売上確定・金額変更期限を延長できます。

支払キャンセル

返金

障害取消

支払（payTransaction・adviceTransaction）実行後にサービスの障害などのエラーにより取引が失敗・もしくは応答を受信できない場合に障害取消（cancelUnresponsedTransaction）を実行してください。
※障害取消（cancelUnresponsedTransaction）は再支払（再オーソリ）を除く支払（payTransaction・adviceTransaction）に対してのみ行えます。

d払いにおける処理シーケンスは以下の通りです。

支払(オーソリ)

※後続処理（売上確定や返金など）に進む前に、subscribeTransactionやgetTransactionなどを用いてpayTransactionのステータスがSUCCESSになったことをご確認ください。

返金

支払キャンセル

売上確定

au PAYにおける処理シーケンスは以下の通りです。

支払（オーソリ）+売上確定

※1 リクエスト時、captureNowにtrueを設定すると支払（オーソリ）と売上確定のタイミングが同時になります。取引のactionは"CAPTURE"となり、シーケンス上の売上確定判断以降を行う必要はありません。
※2 決済完了通知の受け取り先であるreturnUrlを設定してください。
※3 QRコード表示やアプリコールに使用するためのau PAYサイトのURLです。
※4 au PAYサイトやアプリからの決済完了通知以外に、本サービスからも決済完了通知を受け取りたい場合にご利用ください。サブスクライブの設定が完了した際と、取引が更新された場合、指定されたcallbackUrlにPOSTされます。詳しくはsubscribeTransactionをご参照ください。
※5 Callbacksに対して、HTTPステータスコードを返却されない場合、最大3回（2回リトライ）POSTされます。
※6 HTTPステータスコードは202もしくは204を返してください。詳しくはsubscribeTransactionをご参照ください。
※7 支払完了後5分以内に、指定されたcallbackUrlに決済完了通知がPOSTされます。
※8 returnUrlには決済結果がクエリパラメータとして付与されます。詳しくはau PAY詳細をご参照ください。

再支払（再オーソリ）

支払（オーソリ）＋売上確定のパターンにおいて、売上確定前に支払額を変更したい場合、支払を再実行することで対応できます。

支払キャンセル

返金

事前に決済情報預かりの顧客登録と決済手段登録を実施する必要があります。
また、決済手段登録時に本人認証を行うことで利用者本人である事を確認しておく必要があります。

Bank Payにおける処理シーケンスは以下の通りです。

口座情報一覧照会

事前に決済情報預かりの顧客登録と決済手段登録を実施する必要があります。
会員が登録した口座情報の一覧を取得します。

口座情報ステータス変更

事前に決済情報預かりの顧客登録と決済手段登録を実施する必要があります。
会員が登録した口座の状態（有効化、無効化）を変更します。

金融機関上限金額照会

事前に決済情報預かりの顧客登録と決済手段登録を実施する必要があります。
利用する金融機関において、一度の決済、一日の決済で支払い可能な金額の情報を取得します。

利用金額照会

事前に決済情報預かりの顧客登録と決済手段登録を実施する必要があります。
会員が登録した口座の当日の利用金額を取得します。

支払

事前に決済情報預かりの顧客登録と決済手段登録を実施する必要があります。
また支払のタイミングでも本人認証を行う必要があります。

※1.加盟店様でBank Payの決済手段情報を管理されている場合は不要です。
※2.決済手段情報を利用して支払可能な金額を、利用者が確認できる仕組を推奨しています。

返金

障害取消

支払（payTransaction）実行後にサービスの障害などのエラーにより取引が失敗・もしくは応答を受信できない場合に障害取消（cancelUnresponsedTransaction）を実行してください。

Amazon Payにおける処理シーケンスは以下の通りです。

支払（オーソリ）+売上確定

※1 加盟店様へのリダイレクトURLのクエリにcheckoutSessionIdが付与されます。
※2 リクエスト時、captureNowにtrueを設定すると支払（オーソリ）と売上確定のタイミングが同時になります。取引のactionは"CAPTURE"となり、シーケンス上の売上確定判断以降を行う必要はありません。
※3 決済事業者のオーソリ処理後の遷移先としてreturnUrlを設定してください。

再支払（再オーソリ）

支払(オーソリ)＋売上確定のパターンにおいて、売上確定前に支払額を変更したい場合や与信を再取得したい場合に、支払を再実行することで対応できます。

※1 リクエスト時、captureNowにtrueを設定すると再支払（再オーソリ）と売上確定のタイミングが同時になります。取引のactionは"CAPTURE"となり、シーケンス上の売上確定判断以降を行う必要はありません。

売上確定（支払（オーソリ）後7日を超えた場合）

支払（オーソリ）後７日を超えた売上確定は非同期処理のため、売上確定処理の完了まで時間がかかる場合があります。

※1 Callbacksに対して、HTTPステータスコードを返却されない場合、最大3回（2回リトライ）POSTされます。
※2 サブスクライブの設定が完了した際と、取引が更新された場合、指定されたcallbackUrlにPOSTされます。詳しくはsubscribeTransactionをご参照ください。
※3 HTTPステータスコードは202もしくは204を返してください。詳しくはsubscribeTransactionをご参照ください。

支払キャンセル

返金

非同期処理のため返金処理の完了まで時間がかかる場合があります。

※1 Callbacksに対して、HTTPステータスコードを返却されない場合、最大3回（2回リトライ）POSTされます。
※2 サブスクライブの設定が完了した際と、取引が更新された場合、指定されたcallbackUrlにPOSTされます。詳しくはsubscribeTransactionをご参照ください。
※3 HTTPステータスコードは202もしくは204を返してください。詳しくはsubscribeTransactionをご参照ください。

銀行ネット決済における処理シーケンスは以下の通りです。

支払（オーソリ取引）+売上確定

支払お申し込みから売上確定までの処理シーケンスです。

※1 サブスクライブの設定が完了した際と、取引が更新された場合、指定されたcallbackUrlにCallbacksがPOSTされます。詳しくはsubscribeTransactionをご参照ください。
※2 Callbacksに対して、HTTPステータスコードを返却されない場合、最大3回（2回リトライ）POSTされます。
※3 HTTPステータスコードは202もしくは204を返してください。詳しくはsubscribeTransactionをご参照ください。

支払（オーソリ取引）+売上確定 情報リンク方式

本サービスが提供する金融機関選択画面を経由して実施する、支払お申し込みから売上確定までの処理シーケンスです。

※1 サブスクライブの設定が完了した際と、取引が更新された場合、指定されたcallbackUrlにCallbacksがPOSTされます。詳しくはsubscribeTransactionをご参照ください。
※2 Callbacksに対して、HTTPステータスコードを返却されない場合、最大3回（2回リトライ）POSTされます。
※3 HTTPステータスコードは202もしくは204を返してください。詳しくはsubscribeTransactionをご参照ください。
※4 payTransasctionのレスポンスに含まれるresultProperty.selectBankUrlで返却されるURLをご利用ください。またリンク決済ご利用時は決済完了画面に同様の画面遷移用リンクが表示されます。

支払キャンセル（オーソリ取消取引）

支払お申し込み後、利用者からの入金前にお申し込みいただいた取引の取消を行う際の処理シーケンスです。

支払期限切れ

支払お申し込み後、支払期限までに支払われなかった場合の処理シーケンスです。

※1 サブスクライブの設定が完了した際と、取引が更新された場合、指定されたcallbackUrlにCallbacksがPOSTされます。詳しくはsubscribeTransactionをご参照ください。
※2 Callbacksに対して、HTTPステータスコードを返却されない場合、最大3回（2回リトライ）POSTされます。
※3 HTTPステータスコードは202もしくは204を返してください。詳しくはsubscribeTransactionをご参照ください。

NP後払いにおける処理シーケンスは以下の通りです。

支払（オーソリ）

※1 利用者に表示案内する文言は、「NP後払い別紙」を参照ください。

再支払（再オーソリ）

売上確定前の場合、最新のオーソリ情報を再支払で変更できます。
再支払は金額以外の情報も変更が可能です。

売上確定

売上確定後に決済事業者から請求書を利用者に送付します。

売上確定（NP後払いwiz）

NP後払いwizの場合は請求書を加盟店様で印刷頂き、商品に同梱したうえで発送して頂きます。

※1 印刷は決済事業者提供のwizプリント内の機能で行ってください。また印刷後に再支払を行った場合は、最新のデータで再度印刷を実施し直してください。

支払キャンセル

返金

※ 利用者が商品代金を入金した後の返金については、加盟店様と利用者の間で個別にご対応頂く必要があります。

請求書再発行依頼

請求書の再発行依頼を行う場合のシーケンスです。

※1 NP後払いwizの場合でも、請求書の再発行から送付まで決済事業者側で行います。
※2 メールによる請求書送付の場合、異なるメールアドレスに送付をされる場合には、利用者から決済事業者に直接のお問い合わせが必要です。

リンク決済における処理シーケンスを以下に記載します。

決済リンク

リンク発行フロー

※1 Callbacksに対して、HTTPステータスコードを返却されない場合、最大3回（2回リトライ）POSTされます。
※2 取引が実施された場合及び実施された取引のステータスが変更された場合、指定されたcallbackUrlにPOSTされます。取引をサブスクライブする場合はcreatePaymentUrl実行時にcallbackUrlを指定してください。
※3 HTTPステータスコードは202もしくは204を返してください。詳しくはcreatePaymentUrlのCallbacksをご参照ください。

利用者の支払フロー

※4 各決済手段ごとに必要な決済承認を実施します。こちらの部分は決済手段ごとに異なり、クレジットカード決済、コンビニ決済のように本サービスのUIで完結するケースや、PayPayのようにPayPayのUIへリダイレクトするケースが存在します。また加盟店様登録の際に3Dセキュア認証を設定済みの場合には3Dセキュア認証と決済要求がこちらで行われます。

顧客情報管理リンク発行+顧客情報登録・削除

※1 顧客情報の登録・削除が行われた場合、指定されたcallbackUrlにPOSTされます。取引をサブスクライブする場合はcreateSetupUrl実行時にcallbackUrlを指定してください。
※2 HTTPステータスコードは202を返してください。詳しくはcreateSetupUrlのCallbacksをご参照ください。

リンク無効化

加盟店様が本サービスへ決済で用いる情報を事前に預け、その情報で決済を行うことで、加盟店様は決済で用いる情報の保持が不要です。
決済情報預かりを行うには事前に顧客登録、決済手段登録を行なっておく必要があります。
決済情報預かりの各機能の処理シーケンスを以下に記載します。

決済手段に依らない共通の決済情報預かり処理シーケンスを以下に記載します。

顧客登録

決済情報預かり手段登録を行う前に顧客登録を行う必要があります。 顧客IDは利用者を識別するために、加盟店様側で採番・管理頂くIDです。
こちらのIDは加盟店様内で一意である必要があります。

顧客削除

決済手段登録により紐づけた決済情報が多い場合は、各種ベンダーへの削除処理に時間がかかる場合もあります。
削除後に改めてデータの再登録や照会を行う際にはしばらく時間をあけてご利用ください。

決済手段削除

登録した決済手段を削除するには、顧客IDと決済手段登録番号を設定して削除要求をします。
決済手段登録番号は決済手段情報取得APIを利用して事前に取得してください。

クレジットカード決済における決済情報預かり処理シーケンスを以下に記載します。

決済手段登録（クレジットカード有効性確認無し）

クレジットカードの有効性確認を行わず、登録のみ行います。
事前に決済情報預かりの顧客登録を実施しておく必要があります。

決済手段登録（クレジットカード有効性確認有り3Dセキュア無し）

クレジットカード登録時に3Dセキュア認証を行わず、クレジットカードの有効性確認を行います。
有効性確認に失敗した場合、カード情報は登録されません。
事前に決済情報預かりの顧客登録を実施しておく必要があります。

決済手段登録（クレジットカード有効性確認有り3Dセキュア有り）

クレジットカード登録時に3Dセキュア認証とクレジットカードの有効性確認を行います。
決済追加処理（adviceAccountMethod）が15分以上実施されない場合、もしくは決済追加処理の有効性確認が失敗した場合は、カード情報は本サービスにて削除されます。
事前に決済情報預かりの顧客登録を実施しておく必要があります。

有効性確認（3Dセキュア無し）

3Dセキュア認証を付与せず、決済情報預かりの決済手段を登録します。

有効性確認（3Dセキュア有り）

3Dセキュア認証を付与し、決済情報預かりの決済手段を登録します。

支払(オーソリ)

決済情報預かりで支払(オーソリ)を行うには、顧客IDと決済手段登録番号を設定して決済要求をします。
決済手段登録番号は決済手段情報取得APIを利用して事前に取得してください。

決済手段更新

登録した決済手段を更新するには、顧客IDと決済手段登録番号を設定して更新要求をします。
決済手段登録番号は決済手段情報取得APIを利用して事前に取得してください。

Bank Payにおける決済情報預かり処理シーケンスを以下に記載します。

決済手段登録

決済手段登録前に顧客登録を行う必要があります。

また利用者が加盟店様で初めてBank Payを利用する場合は、利用者の本人認証が必須です。
※認証後にgetBankPayAuthInfoを実行してください。利用者が初回の場合のみBank Pay決済事業者側へのユーザ登録を行います。

またBank Payの口座登録（リダイレクト）で返却されるBank Pay口座情報について、必要に応じて加盟店様側で保存してください。本サービスのAPIで取得可能な情報はlistAccountMethodsとlistRegisteredBankAccountsを参照してください。
※口座登録リダイレクトAPIの詳細はBank Pay 口座登録リダイレクトを参照ください。Bank Pay開発用SDKを利用して開発する場合、口座登録処理はSDKの提供する口座登録APIで行います。詳細は別紙で配布していますSDK用の開発ドキュメントを参照ください。

Payment APIは本サービスの加盟店様がECサイトにおいて各種決済手段を利用するために必要な機能を提供します。
事前準備として、各決済手段の審査が完了している必要があります。

PAYMENT APIの構成について説明します。

リクエスト・レスポンスサンプルは、項目の必須・任意関係なく全項目表示されます。

HTTPステータスコードを選択すると、対応するレスポンスIFやレスポンスサンプルが表示されます。
上記画像では、HTTPステータスコードが201の際のレスポンスIFとレスポンスサンプルが表示されています。

PAYMENT APIの中には決済手段ごとに異なるリクエスト・レスポンスが定義してあるAPIがあります。

決済手段選択エリアで選択した決済手段のインターフェースやサンプルが表示されます。
上記画像では、決済手段にクレジットカード決済（Credit）を指定した際のリクエストインターフェースとリクエストサンプルが表示されています。

authを除いた全てのPayment APIに対するリクエストは、authで取得したtokenとroutingKeyを用いて認証を行います。 認証方式はBearer認証です。 以下のようにtokenをAuthorizationヘッダーに、routingKeyをX-Routing-Keyヘッダーに設定します。
（例）決済要求の場合
【Request】

curl 
    -X POST 
    -k https://Production.example/v1/transactions:pay 
    -H 'Content-Type: application/json' 
    -H 'Authorization: Bearer <token>'
    -H 'X-Routing-Key: <routingKey>' 
    -d '{
        "requestId":"sampleId_01",
        "paymentMethodId":"samplepaymentMethodId",
        "amount":{
            "currencyCode":"JPY",
            "value":10
                    },
        "captureNow":false,
        "requestProperty":{}
        }'

【Response】

curl 
    -X POST 
    -k https://Production.example/v1/transactions:pay 
    -H 'Content-Type: application/json' 
    -H 'Authorization: Bearer <token>'
    -H 'X-Routing-Key: <routingKey>'
    -d '{
        "requestId":"sampleId_01",
        "resultCode":100,
        "resultDescription":"正常に処理が終了しました",
        "resultProperty":{},
        "transactionId":"0XXXXXXXXXXXXXXXXXXXXX",
        "status":"REQUIRES_ACTION"
        }

※本サービスにおいて、全てのAPIのタイムアウト値は65秒に設定されています。

Bearer認証を行うための一時的なアクセストークンを払い出すエンドポイントです。アクセストークンを払い出すにはaccessKeyとaccessSecretが必要で、事前に加盟店ポータルから生成し控えておく必要があります。

決済を行う主体（決済グループ）についての情報を取得するAPIです。 決済グループとは店舗や加盟店様などを包括した概念で、どの単位を決済グループとするかは各加盟店様の運用体制によって異なります。 決済グループは階層構造になっており、以下の図の例でいうと階層によらず、図中全ての組織が決済グループになり得ます。

加盟店様が本サービスで利用可能な決済手段についての情報を取得するAPIです。 ECサイト上に利用可能な決済手段の一覧を取得したい時などに利用します。

決済取引を行うエンドポイントです。 処理シーケンスの詳細は以下のページをご参照ください。

• クレジットカード決済処理シーケンス
• PayPay処理シーケンス
• Bank Pay処理シーケンス
• au PAY処理シーケンス
• d払い処理シーケンス
• 楽天ペイ処理シーケンス
• Amazon Pay処理シーケンス
• コンビニ決済(番号払い)処理シーケンス
• NP後払い処理シーケンス
• 銀行ネット決済処理シーケンス