PaymentAPI - Omni Payment Gateway Documents (1.16.0)

Omni Payment Gateway Documents

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

業務概要

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

No.	機能/対応API項目		機能説明
1	認証	認証 auth（認証）	各API実行前に認証を行い、アクセストークンを取得します。
2	加盟店管理	情報取得 getSelfPaymentGroup（決済グループ情報取得） listPaymentMethods（決済手段取得（一覧）） getPaymentMethod（決済手段取得（詳細））	加盟店の情報を照会します。加盟店ポータルでも参照可能ですが、APIでも同様の情報を取得可能です。
3	決済中継	支払（オーソリ） payTransaction（支払） adviceTransaction（決済追加処理）	利用者からの購買要求に基づき、利用者のカード情報、コード決済情報に対して与信を取得します。
4		再支払（再オーソリ） payTransaction（支払）	過去に取得した与信情報を活用し、再度与信枠を取得します。
5		同時売上 payTransaction（支払） adviceTransaction（決済追加処理）	利用者からの支払完了時点で、本サービスにて売上確定処理をします。当該取引については、加盟店様にて売上を確定する処理が不要になります。 adviceTransactionの要否は決済手段によって異なります。詳細はシーケンス図をご参照ください。
6		売上確定 captureTransaction（売上確定）	支払（オーソリ）された決済に対して売上を確定します。
7		金額補正 correctAmountTransaction（金額補正）	支払（オーソリ）または売上確定した決済取引に対して金額補正処理をします。
8		支払キャンセル cancelTransaction（支払キャンセル）	利用者や加盟店からの取消要求に基づき、与信取得済の情報をキャンセルします。全額支払キャンセルと、一部金額に対して複数回支払キャンセルが可能です。
9		返金 refundTransaction（返金）	売上確定した決済に対して返金をします。全額返金と、一部金額に対して複数回返金が可能です。利用者にとっての「返品」と同義です。
10		強制取消 forceCancelTransaction（強制取消）	決済要求の際に支払（オーソリ）された決済か売上確定した決済取引かが不明な場合、取引アクションを判別し、支払（オーソリ）された決済であれば支払キャンセル、売上確定された決済であれば返金処理をします。
11		障害取消 cancelUnresponsedTransaction（障害取消）	加盟店・本サービス・決済事業者間において、通信断等により不整合が発生した取引について、取消します。
12	取引情報取得	1件情報取得 getTransaction（取引情報取得（詳細））	取引に対して1件ずつ、詳細情報含めて照会します。
13		複数情報取得 listTransactions（取引情報取得（一覧））	取引複数件をまとめて照会します。
14		サブスクライブ（差分情報取得） subscribeTransaction（サブスクライブ）	取引が変更された際に本サービス側から加盟店様に通知します。
15		取引サマリ1件照会 getTransactionSummary（取引サマリ情報取得）	指定された元取引に紐づく、一連の決済取引に関する詳細な情報を取得します。
16	取引情報取得（決済事業者管理情報）	決済事業者取引登録情報取得 getProviderTransaction（決済事業者取引登録情報取得）	決済事業者側で保持している取引情報を照会します。
17	リンク決済	支払用リンク作成 createPaymentUrl（利用者向け支払画面のリンク作成）	利用者が本サービスの提供する画面に遷移して決済を行う方法である、リンク決済を実施します。目的に応じて、支払用リンク作成機能と預かり情報管理用リンク作成機能を提供します。
18		預かり情報管理用リンク作成 createSetupUrl（利用者向け会員情報管理画面のリンク（URL）作成）
19		リンク無効化 disableUrl（発行済リンクの無効化）	発行済リンクを無効化します。
20	会員管理	決済情報預かり createCustomer（顧客情報生成） verifyCustomer（顧客の決済手段に対して有効性確認） deleteCustomer（顧客情報を削除） registerAccountMethod（決済情報登録） listAccountMethods（決済情報一覧取得） deleteAccountMethod（登録している決済手段を削除） adviceAccountMethod（登録している決済手段に追加処理） updateAccountMethod（登録している決済手段を更新）	決済で用いる情報を本サービスに登録し、決済情報に紐づく顧客ID/決済手段登録番号を払い出すことで、決済時に顧客ID/決済手段登録番号を使って決済をします。決済で用いる情報を決済のたびに入力する必要がなくなります。顧客ID/決済手段登録番号の登録・削除機能を提供しています。
21	クレジットカード固有機能	セキュリティ認証/3Dセキュア認証 payTransaction（支払） adviceTransaction（決済追加処理）	クレジットカード決済において、エンドユーザーにストレスのないフリクションレスなリスクベース認証（3Dセキュア2.0）で不正検知をします。
22		トークン決済 createEndUserAccessToken（トークン発行API認証） createTransactionToken（トークン発行）	クレジットカード情報のような決済で用いる情報を本サービスにカード情報として一時的に登録した上で、決済用トークンを発行し、決済用トークンで決済をします。決済実施の都度、本サービスが発行する決済用トークンを使って決済依頼を行うため、加盟店サイトにてカード情報を保持する必要がありません。
23		クレジットカード詳細情報取得 inquireCreditCard（クレジットカード詳細情報取得）	カード会員番号を元にクレジットカード情報を取得します。カード会員番号を直接指定する以外に、決済情報預かりで登録した決済手段や決済用ワンタイムトークンを利用する判定も利用可能です。
24		クレジットカード有効性確認 verifyCustomer（クレジットカード有効性確認）	カード会員番号を直接指定して有効性確認をします。
25	Amazon Pay住所・支払情報取得	Amazon Pay住所・支払情報取得 getAmazonAccount（住所・支払情報取得）	Amazon Payで支払いが行われる際に、利用者の住所と支払い情報を取得します。
26	Bank Pay固有操作	Bank Pay固有操作 listAvailableBanks（利用可能金融機関取得） getBankAccountInputInfo（口座入力情報取得） getBankPayAuthInfo（口座認証情報取得） listRegisteredBankAccounts（口座情報複数照会） changeRegisteredBankAccountStatus（口座ステータス変更） getBankPaymentLimit（金融機関上限金額照会） getAccountUsageAmount（利用金額照会）	Bank Pay登録情報の照会や登録情報を利用した機能が利用できます。
27	NP後払い固有操作	請求書再発行依頼 NPAtobaraiReissueInvoice（NP後払い請求書再発行依頼）	NP後払いで利用者に送付する請求書を、決済事業者に再発行依頼します。利用者の請求書紛失時などにご利用頂けます。

提供機能マッピング

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

auth(認証)

getSelfPaymentGroup（決済グループ情報取得）

listPaymentMethods（決済手段取得（一覧）

getPaymentMethod（決済手段取得（詳細）

subscribeTransaction（サブスクライブ）

listTransactions（取引情報取得（一覧））

getTransaction（取引情報取得（詳細））

getTransactionSummary（取引サマリ情報取得）

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

決済中継

No	機能/対応API項目	クレジットカード決済	コンビニ決済（番号払い）	PayPay	楽天ペイ	d払い	au PAY	Amazon Pay	銀行ネット決済	Bank Pay	NP後払い
1	支払（オーソリ） payTransaction（支払） adviceTransaction（決済追加処理）※2	〇	対応なし	〇※1	〇	〇	〇	〇	対応なし	対応なし	〇
2	再支払（再オーソリ） payTransaction（支払）	〇（非推奨※6）	対応なし	対応なし	〇	対応なし	〇	〇	対応なし	対応なし	〇
3	同時売上 payTransaction（支払） adviceTransaction（決済追加処理）※2	〇	〇	〇※1	〇	〇	〇	〇	〇	〇	対応なし
4	売上確定 captureTransaction（売上確定）	〇	対応なし	〇	〇	〇	〇	〇	対応なし	対応なし	〇
5	金額補正 correctAmountTransaction（金額補正）	〇	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし
6	支払キャンセル cancelTransaction（支払キャンセル）	〇	〇	〇	〇	〇	〇	〇	〇	対応なし	〇
7	返金 refundTransaction（返金）	〇	対応なし	〇	〇	〇	〇	〇	対応なし	〇	〇
8	強制取消 forceCancelTransaction（強制取消）	〇	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし
9	障害取消 cancelUnresponsedTransaction（障害取消）	〇	対応なし	〇	〇※4	〇※3	対応なし	対応なし	対応なし	〇※5	対応なし
10	取引情報取得（決済事業者管理情報） getProviderTransaction（決済事業者取引登録情報取得）	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	〇

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

リンク決済

No	機能/対応API項目	クレジットカード決済	コンビニ決済 (番号払い)	PayPay	楽天ペイ	d払い	au PAY	Bank Pay	Amazon Pay	NP後払い	銀行ネット決済
1	支払用リンク作成 createPaymentUrl（利用者向け支払画面のリンク作成）	〇	〇	〇	〇	〇	〇	対応なし	対応なし	対応なし	〇
2	預かり情報管理用リンク作成 createSetupUrl（利用者向け会員情報管理画面のリンク（URL）作成）	〇	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし
3	リンク無効化 disableUrl（発行済リンクの無効化）	〇	〇	〇	〇	〇	〇	対応なし	対応なし	対応なし	〇

会員管理

No	機能/対応API項目	クレジットカード決済	コンビニ決済(番号払い)	PayPay	楽天ペイ	d払い	au PAY	Bank Pay	Amazon Pay	NP後払い	銀行ネット決済
1	決済情報預かりの顧客登録 createCustomer（顧客情報生成）	〇	対応なし	対応なし	対応なし	対応なし	対応なし	〇	対応なし	対応なし	対応なし
2	預かり決済手段の有効性確認 verifyCustomer（顧客の決済手段に対して有効性確認）	〇	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし
3	決済情報預かりの顧客削除 deleteCustomer（顧客情報を削除）	〇	対応なし	対応なし	対応なし	対応なし	対応なし	〇	対応なし	対応なし	対応なし
4	預かり決済手段の登録 registerAccountMethod（決済情報登録）	〇	対応なし	対応なし	対応なし	対応なし	対応なし	〇	対応なし	対応なし	対応なし
5	預かり決済手段の一覧取得 listAccountMethods（決済情報一覧取得）	〇	対応なし	対応なし	対応なし	対応なし	対応なし	〇	対応なし	対応なし	対応なし
6	預かり決済手段の削除 deleteAccountMethod（登録している決済手段を削除）	〇	対応なし	対応なし	対応なし	対応なし	対応なし	〇	対応なし	対応なし	対応なし
7	預かり決済手段の追加情報付与 adviceAccountMethod（登録している決済手段に追加情報の付与）	〇	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし
8	預かり決済手段の更新 updateAccountMethod（登録している決済手段を更新）	〇	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし

クレジットカード固有機能

No	機能/対応API項目	クレジットカード決済	クレジットカード決済以外
1	セキュリティ認証/3Dセキュア認証 payTransaction（支払） adviceTransaction（決済追加処理）	〇	対応なし
2	トークン決済 createEndUserAccessToken（トークン発行API認証） createTransactionToken（トークン発行）	〇	対応なし
3	クレジットカード詳細情報取得 inquireCreditCard（クレジットカード詳細情報取得）	〇	対応なし
4	クレジットカード有効性確認 verifyCustomer（クレジットカード有効性確認）	〇	対応なし

Bank Pay固有機能

No	機能/対応API項目	Bank Pay	Bank Pay以外
1	Bank Pay固有機能 listAvailableBanks（利用可能金融機関取得） getBankAccountInputInfo（口座入力情報取得） getBankPayAuthInfo（口座認証情報取得） listRegisteredBankAccounts（口座情報複数照会） changeRegisteredBankAccountStatus（口座ステータス変更） getBankPaymentLimit（金融機関上限金額照会） getAccountUsageAmount（利用金額照会）	〇	対応なし

Amazon Pay固有機能

No	機能/対応API項目	Amazon Pay	Amazon Pay以外
1	Amazon Pay住所・支払情報取得 getAmazonAccount（住所・支払情報取得）	〇	対応なし

NP後払い固有機能

No	機能/対応API項目	NP後払い	NP後払い以外
1	NP後払い請求書再発行依頼 NPAtobaraiReissueInvoice（NP後払い請求書再発行依頼）	〇	対応なし

各決済手段の取引期限

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

No	取引アクション	クレジットカード決済※1	コンビニ決済(番号払い)	PayPay	楽天ペイ	d払い	au PAY	Amazon Pay	銀行ネット決済	Bank Pay	NP後払い
1	売上確定	初回支払（オーソリ）完了時から60日以内	同時売上のため期限なし	支払（オーソリ）完了時から30日以内※4	初回支払(adviceTransaction が成功し与信確保した日)から365日以内かつ最後の支払（初回支払もしくは再支払）から160日以内※3	初回支払（オーソリ）完了時から翌々月末19時まで	初回支払（オーソリ）完了時から90日以内	最後の支払（オーソリ）完了時から30日以内	同時売上のため期限なし	対応なし	初回支払（オーソリ）完了時から 3～4ヶ月以内※6
2	再支払（再オーソリ）	初回支払（オーソリ）から 90日以内	対応なし	対応なし	初回支払(adviceTransaction が成功し与信確保した日)から365日以内かつ最後の支払（初回支払もしくは再支払）から160日以内※3	対応なし	初回支払（オーソリ）完了時から90日以内	初回支払（オーソリ）完了時から 180日以内	対応なし	対応なし	初回支払（オーソリ）完了時から 3～4ヶ月以内※6
3	金額補正（支払金額）	初回支払（オーソリ）完了時から90日以内	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし
4	金額補正（確定金額）	初回支払（オーソリ）完了時から90日以内	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし	対応なし
5	支払キャンセル	初回支払（オーソリ）完了時から90日以内	支払期限切れ、または入金まで※5	支払（オーソリ）完了時から30日以内※4	初回支払(adviceTransaction が成功し与信確保した日)から 365日以内	初回支払（オーソリ）完了時から179日後19時まで	初回支払（オーソリ）完了時から90日以内	最後の支払（オーソリ）完了時から180日以内	支払期限切れ、または入金まで※7	対応なし	初回支払（オーソリ）完了時から 3～4ヶ月以内※6
6	返金	初回支払（オーソリ）完了時から90日以内	対応なし	同時売上確定・売上確定完了日の365日後の23:59:59まで	初回支払(adviceTransaction が成功し与信確保した日)から365日以内かつ売上確定から 30日以内	初回支払（オーソリ）完了時から179日後19時まで	初回支払（オーソリ）完了時から90日以内	初回支払（オーソリ）完了時から400日以内	対応なし	支払（オーソリ）完了時から当日の 23:59:59まで※8	初回支払（オーソリ）完了時から最大14ヶ月以内
7	障害取消	障害取消の対象取引(relatedRequestId で指定する取引)のリクエストから7日以内	対応なし	期限なし	支払の場合、初回支払(adviceTransaction が成功し与信確保した日)から365日以内同時売上の場合、初回支払(adviceTransaction が成功し与信確保した日) から30日以内	初回支払（オーソリ）完了時から翌月2日20時まで※2	対応なし	対応なし	対応なし	支払（オーソリ）完了時から当日の 23:59:59まで	対応なし

※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は同時売上に対しての取引期限となっています。

処理シーケンス

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

分類	処理シーケンス
共通	認証決済グループ情報取得決済手段の情報取得（一覧）決済手段の情報取得（詳細）取引情報取得サブスクライブ決済取引の情報取得（一覧）決済事業者取引情報取得
クレジットカード決済	支払（オーソリ・3Dセキュア認証なし）+売上確定支払（オーソリ・3Dセキュア認証あり）+売上確定支払(トークン決済) 支払（3Dセキュア認証なし）+決済情報預かり手段登録支払（3Dセキュア認証あり）+決済情報預かり手段登録再支払（再オーソリ取引）金額補正（支払）金額補正（売上確定）支払キャンセル返金強制取消障害取消クレジットカード詳細情報取得クレジットカード有効性確認（3Dセキュア認証なし）クレジットカード有効性確認（3Dセキュア認証あり）
コンビニ決済(番号払い)	支払（オーソリ）+売上確定支払キャンセル支払期限切れメール再送
PayPay	支払（オーソリ）+売上確定ブラウザ利用（ID、パスワード入力）支払（オーソリ）+売上確定ブラウザ利用（コード読み取り）支払（オーソリ）+売上確定スマートフォンAPP連携利用支払キャンセル返金障害取消売上確定、同時売上、返金の再送
楽天ペイ	支払（オーソリ取引）+売上確定支払（再オーソリ取引・金額変更あり）支払（再オーソリ取引・金額変更なし）支払キャンセル（オーソリ取消取引）返金障害取消
d払い	支払（オーソリ）返金支払キャンセル売上確定
au PAY	支払（オーソリ）+売上確定再支払（再オーソリ）支払キャンセル返金
Bank Pay	口座情報一覧照会口座情報ステータス変更金融機関上限金額照会利用金額照会支払返金障害取消
Amazon Pay	支払（オーソリ）+売上確定再支払（再オーソリ）売上確定（支払後7日を超えた場合）支払キャンセル返金
銀行ネット決済	支払（オーソリ取引）+売上確定支払（オーソリ取引）+売上確定情報リンク方式支払キャンセル（オーソリ取消取引）支払期限切れ
NP後払い	支払（オーソリ取引）支払（再オーソリ取引）売上確定売上確定（NP後払いwiz）支払キャンセル返金請求書再発行依頼
リンク決済	決済リンク発行+支払顧客情報管理リンク発行+顧客情報登録・削除リンク無効化
決済情報預かり	券種共通顧客登録顧客削除決済手段削除
	クレジットカード決済決済手段登録（クレジットカード有効性確認無し）決済手段登録（クレジットカード有効性確認有り3Dセキュア無し）決済手段登録（クレジットカード有効性確認有り3Dセキュア有り）有効性確認（3Dセキュア無し）有効性確認（3Dセキュア有り）支払（オーソリ）決済手段更新
	Bank Pay 決済手段登録

共通処理シーケンス

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

認証

決済グループ情報取得

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

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

取引情報取得

サブスクライブ

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

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

決済事業者取引参照

クレジットカード決済処理シーケンス

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

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

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

creditpayCaptureUml

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

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

creditpayCapture3dsUml

支払(トークン決済)

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

creditTokenUml

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

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

creditPayRegisterAccountMethodUml

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

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

creditPayRegisterAccountMethodWith3DSUml

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

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

creditreAuthorizationUml

金額補正（支払）

creditCorrectAmountAuthorizationUml

金額補正（売上確定）

creditCorrectAmountCaptureUml

支払キャンセル

creditCancelUml

返金

creditRefundUml

強制取消

creditForceCancelUml

障害取消

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

creditCancelUnresponsedTransactionRequestUml

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

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

inquireCreditCardUml

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

creditPANVerifyCustomerUml

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

creditPANVerifyCustomerWith3DSUml

コンビニ決済(番号払い)処理シーケンス

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

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

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

conveniencePayCaptureUml

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

支払キャンセル

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

convenienceCancelUml

支払期限切れ

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

convenienceExpiredTransactionlUml

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

メール再送

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

convenienceAdviceUml

PayPay処理シーケンス

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

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

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

paypayPayCaptureBrowser

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

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

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

paypayPayCaptureBrowserCode

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

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

paypayPayCaptureApp

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

支払キャンセル

paypayCancelUml

返金

paypayRefundUml

障害取消

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

paypayCancelUnresponsedTransactionUml

障害取消で返金が必要な場合

同時売上に対して障害取消を行った場合、取消が行えずエラーメッセージが返却されることがあります。
該当取引の取消については加盟店様判断の上、必要に応じて返金処理を行ってください。
下記シーケンスは返金応答をする一例です。

paypayCancelUnresponsedTransactionRefundRequiredUml

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

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

paypayResendUml

楽天ペイ処理シーケンス

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

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

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

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

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

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

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

支払キャンセル

rakutenpayCancelUml

返金

rakutenpayRefundUml

障害取消

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

d払い処理シーケンス

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

支払(オーソリ)

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

返金

dpayRefundUml

支払キャンセル

dpayCancelUml

売上確定

dpayCaptureUml

au PAY処理シーケンス

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

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

aupayPayCaptureUml

※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詳細をご参照ください。

再支払（再オーソリ）

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

aupayReAuthorizationUml

支払キャンセル

aupayCancelUml

返金

aupayRefundUml

Bank Pay処理シーケンス

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

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

口座情報一覧照会

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

口座情報ステータス変更

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

金融機関上限金額照会

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

利用金額照会

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

支払

事前に決済情報預かりの顧客登録と決済手段登録を実施する必要があります。
また支払のタイミングでも本人認証を行う必要があります。
bankpayPayTransactionUml
※1.加盟店様でBank Payの決済手段情報を管理されている場合は不要です。
※2.決済手段情報を利用して支払可能な金額を、利用者が確認できる仕組を推奨しています。

返金

bankpayRefundUml

障害取消

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

Amazon Pay処理シーケンス

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

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

amazonpayPayCaptureUml

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

再支払（再オーソリ）

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

amazonpayReAuthorizationUml

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

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

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

amazonpayCaptureUml

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

支払キャンセル

amazonpayCancelUml

返金

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

amazonpayRefundUml

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

銀行ネット決済処理シーケンス

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

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

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

netBankingAtmPayCaptureUml

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

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

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

netBankingAtmPayCaptureLinkUml

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

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

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

netBankingAtmCancelUml

支払期限切れ

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

netBankingAtmTransactionlUml

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

NP後払い処理シーケンス

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

支払（オーソリ）

NPAtobaraiPayUml

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

再支払（再オーソリ）

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

NPAtobaraiReAuthorizationUml

売上確定

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

NPAtobaraiCaptureUml

売上確定（NP後払いwiz）

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

NPAtobaraiCaptureWizUml

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

支払キャンセル

NPAtobaraiCancelUml

返金

NPAtobaraiRefundUml

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

請求書再発行依頼

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

NPAtobaraiReissueInvoiceUml

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

リンク決済処理シーケンス

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

決済リンク

リンク発行フロー

createPaymentUrl

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

利用者の支払フロー

linkPaymentPayDetail

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

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

createSetupUrl

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

リンク無効化

disableUrl

決済情報預かり処理シーケンス

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

券種共通

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

顧客登録

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

accountMethodCreateCustomerUml

顧客削除

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

accountMethodDeleteCustomerUml

決済手段削除

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

accountMethodDeleteAccountMethodUml

クレジットカード決済

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

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

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

creditAccountMethodRegisterAccountMethodWithoutValidationUml

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

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

creditAccountMethodValidationUml

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

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

creditAccountMethodValidation3DSUml

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

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

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

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

支払(オーソリ)

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

creditAccountMethodPayUml

決済手段更新

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

creditAccountMethodUpdateAccountMethodUml

Bank Pay

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

決済手段登録

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

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

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

bankpayAccountMethodRegisterUml

Payment API利用にあたって

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

PAYMENT APIの構成

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

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

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

決済手段固有の情報の確認方法

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

kouseiOneof

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

API認証

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"
        }

接続条件

項目	説明
接続方式	インターネット接続のみです。専用線接続のオプションはありません。
プロトコル	HTTP/1.1に対応します。(HTTP 2.0には対応していません）リクエスト・レスポンスのcontent-typeはapplication/jsonです。加盟店様と本サービスの間で通信エラーが発生した場合などはhtmlなどjson以外の形式でレスポンスが返ることもあります。通信エラーが発生した場合はリクエスト内容をご確認いただいたうえで再送してください。同一のrequestIdとリクエストボディで送る場合はべき等性の担保がされているため二重決済にはなりませんが、requestIdが異なる場合は新規決済として処理をします。また、必要に応じ取引情報取得や加盟店ポータルで取引の状態を確認し、支払キャンセルなどの操作を行ってください。
暗号化方式	TLS v1.2以上に対応します。
文字コード	UTF-8
使用可能文字	各項目の制限欄に記載があります。詳細は使用可能文字をご参照ください。

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

互換性と拡張方針

Payment APIは後方互換性の維持を基本方針としています。
既存のエンドポイントの廃止やリクエスト・レスポンス項目の削除、名称・型・意味の変更など、既存実装に影響を与える破壊的変更は原則行いません。
やむを得ず破壊的変更を伴うアップグレードを行う場合は、数ヵ月前に加盟店様にご案内いたします。

以下の変更は、後方互換を維持した非破壊的な変更として扱われます。
原則として変更内容は事前にご案内いたしますが、後方互換の範囲での更新は予告なく行われることがあります。基本的に加盟店様の既存実装に影響はありません。

エンドポイントの追加
任意のリクエスト項目の追加
レスポンス項目の追加
結果コード、結果詳細コードの追加
リクエスト項目の文字列長・文字種などの変更

変更内容は更新履歴をご確認ください。

認証

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

auth

認証を行い、アクセストークンを取得します。
トークン払い出し後、他のAPIへアクセスを行う場合はそのトークンを利用したBearer認証方式にて行います。トークンには30分の有効期限が定められており、適切なタイミングでトークンの再生成を行う必要があります。
再作成を行っても、以前生成したトークンが有効期限内であれば以前のトークンも利用できます。
また、加盟店ポータルから事前にaccessKey、accessSecretを払い出す必要がありますが、生成時に権限を選択する必要があるため、アクセスしたい要件によって適切な権限を選択してください。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

Request Body schema: application/json

accessKey required	string = 26 characters アクセスキー加盟店ポータルから事前に払い出す必要があります。 `使用可能文字：半角英数字`
accessSecret required	string = 64 characters アクセスシークレット加盟店ポータルから事前に払い出す必要があります。 `使用可能文字：半角英数字`

Responses

Request samples

Payload

Content type

application/json

{"accessKey": "SAMPLEKEYVALUE012345678901",
"accessSecret": "SampleKeyValue01234567890123456789012345678901234567890123456789"
}

Response samples

Content type

application/json

{"token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQ...",
"expiresAt": "2021-10-12T11:11:57+09:00",
"routingKey": "sample routingkey"
}

決済グループ情報取得

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

paymentGroups

getSelfPaymentGroup

認証された決済グループに関する詳細な情報を取得します。
※決済グループについては決済グループ情報取得をご参照ください。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

Responses

Response samples

Content type

application/json

{"id": "01DQ4H6WA0ZPX4V3GRY7TJ0J70",
"name": "店舗a"
}

決済手段情報取得

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

listPaymentMethods

認証された決済グループで支払時に利用可能な決済手段の一覧を取得します。 Response Schema以下の表の要素を持つオブジェクトの配列が、決済グループで利用可能な決済手段として数字、英字大文字、英字小文字（アルファベット順）の順番で返却されます。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

query Parameters

pageSize	integer <int32> [ 1 .. 100 ] 一度に返却するアイテム数 APIはこちらで指定した値より少ないアイテム数を返却する場合があります。指定しない場合と0を指定した場合、最大10個のアイテムが返却されます。 100を超える値は100に変換されます。負の値を指定すると、422が返却されます。
pageToken	string 前回こちらのAPIを呼び出した際にResponse Headersとして受信した値(`X-Next-Token`) こちらの項目を指定することで、前回取得したアイテムの次のアイテムから取得できます。

Responses

Response samples

Content type

application/json

[{"logoUrl": "http://example.com",
"name": "PayPay",
"paymentMethodId": "PayPay"
}
]

getPaymentMethod

指定された決済手段に関する詳細な情報を取得します。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

path Parameters

paymentMethodId

required

string

取引に利用する決済手段ID

クレジットカード決済 - ”Credit”
PayPay - ”PayPay”
au PAY - ”AuPay”
d払い - ”DPayment”
楽天ペイ - "RakutenPay"
Bank Pay - ”BankPay”
Amazon Pay - ”AmazonPay”
コンビニ決済(番号払い) - ”Convenience”
NP後払い - ”NPAtobarai”
銀行ネット決済 - ”NetBankingAtm”

Responses

Response samples

Content type

application/json

{"logoUrl": "http://example.com",
"name": "PayPay",
"paymentMethodId": "PayPay"
}

決済取引

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

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

payTransaction

決済取引を開始します。決済手段や加盟店様の運用体制によってこちらのAPIの役割は異なります。オーソリ（与信枠の確保）と売上確定のタイミングが別である場合、こちらのAPIを利用して支払処理を行い、captureTransactionを利用して売上確定処理を行います。
一方支払（オーソリ）と売上確定のタイミングが同時の場合や支払に対応していない決済手段の場合、こちらのAPIのみで決済が完了します(支払への対応状況は提供機能マッピングをご確認ください)。売上確定がされておらず与信枠を増減したい取引に対して、こちらのAPIを利用して再支払（再オーソリ）を行えます。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

Request Body schema: application/json

One of

requestId required	string <= 70 characters 加盟店様が払い出す、リクエストを識別するID べき等性を担保し、決済取引が多重に行われることを防ぐために設定します。詳細はべき等性の担保をご参照ください。 `使用可能文字：半角英数字＋記号（_）`
paymentMethodId	string 取引に利用する決済手段ID 決済手段ごとに以下を設定してください。クレジットカード決済 - ”Credit” PayPay - ”PayPay” au PAY - ”AuPay” d払い - ”DPayment” 楽天ペイ - "RakutenPay" Bank Pay - ”BankPay” Amazon Pay - ”AmazonPay” コンビニ決済(番号払い) - ”Convenience” NP後払い - ”NPAtobarai” 銀行ネット決済 - ”NetBankingAtm” こちらのIDはlistPaymentMethodsからも取得できます。 ※初回取引の場合、必須項目。再支払（再オーソリ）の場合、任意項目
required	object
orderId	string <= 64 characters 支払（オーソリ）で設定され、情報取得のために加盟店様が払い出す、注文を識別するID このIDによって、関連するすべての取引(支払/売上/返金など)を紐づけて参照できます。 `使用可能文字：半角英数字＋記号（-_）` ※NP後払いでは、`orderId`を以下の様に利用します。 40桁以内で設定頂いた場合、利用者への発送の請求書にご注文番号として本項目を掲載します。未設定もしくは41桁以上での設定時は、payTransaction(初回支払)の`transactionId`を掲載します。
required	object requestPropertyオブジェクトこちらの項目は各種決済手段固有の情報です。 ※支払区分によって設定有無、方法が異なります。詳細支払区分設定方法をご参照ください。
captureNow	boolean Default: false 支払（オーソリ）と売上確定のタイミングを同時にするか否かを区別する項目支払に対応していない決済手段の場合、こちらの項目をtrueに設定する必要があります。 (支払への対応状況は提供機能マッピングをご確認ください) true - 同時にする false - 同時にしない
relatedTransactionId	string 関連する取引のID こちらのIDはpayTransactionのレスポンスと同じtransactionIdである必要があります。 ※再支払（再オーソリ）を実行したい場合、必須項目 ※クレジットカード決済の場合、再支払（再オーソリ）は非推奨です。支払金額を変更する場合は、correctAmountTransaction（金額補正）をご利用ください。
labels	Array of strings <= 50 items [ items [ 1 .. 255 ] characters ] ラベル加盟店様の運用に合わせて最大50個まで自由に設定いただけます。 `使用可能文字：全角半角文字（<>&は対象外）`
	object registerAccountPropertyオブジェクト requestPropertyのcardInfoに設定したカード情報を保持し、必要に応じて3Dセキュアを利用した決済に利用します。支払（3Dセキュア認証なし）で支払が失敗した場合は、カード情報は登録されません。支払（3Dセキュア認証あり）で決済追加処理（adviceTransaction）が失敗した場合は、カード情報は登録されません。 ※クレジットカード決済を行う際に使用したカード情報を登録したい場合、必須項目

Responses

Request samples

Payload

Content type

application/json

Example

CreditRequest

{"requestId": "sampleId_01",
"paymentMethodId": "samplepaymentMethodId",
"amount": {"currencyCode": "JPY",
"value": 1200
},
"orderId": "order_01",
"requestProperty": {"merchantCategoryCode": "5999",
"receiveCompanyCode": "12345670001",
"productCode": "990",
"settleUnitID": "00001",
"businessName": "テスト店舗|ﾃｽﾄﾃﾝﾎﾟ|testShopName",
"cardInfo": {"primaryAccountNumber": "3540697499992567",
"accountName": "test name",
"expirationDate": "2107",
"securityCode": "123",
"securityCodeToken": "043a4f87-3b1b-497f-a9eb-d598010f4fc1",
"token": "043a4f87-3b1b-497f-a9eb-d598010f4fc1",
"customerId": "sampleCustomerId_01",
"accountMethodId": "01"
},
"threeDSInfo": {"notificationUrl": "http://domain/authResult",
"authenticationData": {"authenticationIndicator": "01",
"authenticationInfo": {"authenticationData": "sample Requestor Authentication Data",
"authenticationMethod": "01",
"authenticationTimestamp": "201908161402"
},
"challengeIndicator": "01",
"accountType": "02",
"accountId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"accountInfo": {"cardholderAccountAgeIndicator": "03",
"cardholderAccountChange": "20190816",
"cardholderAccountChangeIndicator": "01",
"cardholderAccountDate": "",
"passwordChange": "20190816",
"passwordChangeIndicator": "02",
"purchaseCount": "10",
"numberOfProvisioningAttemptsPerDay": "2",
"numberOfTransactionsPerDay": "5",
"numberOfTransactionsPerYear": "100",
"paymentAccountAge": "20181201",
"paymentAccountAgeIndicator": "05",
"shippingAddressUsage": "20181201",
"shippingAddressUsageIndicator": "04",
"shippingNameIndicator": "02",
"suspiciousAccountActivity": "02"
},
"cardholderInfo": {"addressMatchIndicator": "Y",
"billingAddress": {"city": "xxxxyyyyyoooonnnnnn",
"country": "392",
"addressLine1": "円山町１９−１",
"addressLine2": "渋谷プライムプラザ",
"addressLine3": "xxxxyyyyyoooonnnnnn",
"postalCode": "1680082",
"state": "01"
},
"cardholderName": "DATA ENUTEITEI",
"email": "sample_mail_address@nttdata.com",
"homePhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
},
"mobilePhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
},
"shippingAddress": {"city": "xxxxyyyyyoooonnnnnn",
"country": "392",
"addressLine1": "円山町１９−１",
"addressLine2": "渋谷プライムプラザ",
"addressLine3": "xxxxyyyyyoooonnnnnn",
"postalCode": "1680082",
"state": "01"
},
"workPhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
}
},
"instalmentPaymentDate": "10",
"merchantRiskIndicator": {"deliveryEmailAddress": "enuteitei@sample.co.jp",
"deliveryTimeframe": "04",
"giftCardAmount": "100000",
"giftCardCount": "02",
"giftCardCurrency": "392",
"preOrderDate": "20190711",
"preOrderPurchaseIndicator": "01",
"reorderItemsIndicator": "01",
"shippingIndicator": "03"
},
"messageCategory": "01",
"purchaseDate": "20190816160405",
"recurringExpiry": "20200831",
"recurringFrequency": "30",
"transactionType": "01"
}
},
"paymentMethod": {"paymentType": "34",
"numberOfInstallmentPayments": 36
},
"b2bSupplierData": {"endbeneficiaryName": "bppname=endname",
"cardAcceptorPostalCode": "1234567",
"endbeneficiaryCity": "Tokyo",
"endbeneficiaryStreet": "1-7-1 Nagatacho, Chiyoda-ku",
"sellerId": "123456789012345",
"sellerEmailAddress": "seller@example.com",
"sellerTelephone": "1312345678",
"cardAcceptorBusinessCode": "5045",
"merchantContactInformation": "contact@example.com"
}
},
"captureNow": false,
"relatedTransactionId": "01FDSD9KG9Z6SB678SE64ABC94",
"labels": ["ラベル"
],
"registerAccountProperty": {"customerId": "string"
}
}

Response samples

Content type

application/json

Example

CreditResponse

{"requestId": "sampleId_01",
"resultCode": 100,
"resultDescription": "正常に処理が終了しました",
"resultProperty": {"errorCode": "G12",
"approvalCode": "1234567",
"receiveCompanyCode": "12345670001",
"terminalProcessingSerialNumber": "11001",
"threeDSHTML": "<!DOCTYPE html><html><head><meta charset=\"UTF-8\"><title>ThreeDSMethodInit</title></head><body onload=\"window.location.href='https://simulator.test.3ds.com/api/v2/auth/brw/threeDsMethod?threeDSServerTransID=0dabae77-d947-4a98-96dd-23e922be5aaf'\"></body></html>",
"threeDSRedirectUrl": "https://dummy/dummy/threedsRedirectXXXXXXXXXXXXXXXXXXXXXXXXX",
"threeDSMerchantTransId": "550e8400-e29b-41d4-a716-446655440000",
"maskedPrimaryAccountNumber": "123456******1234",
"maskedNetworkTokenNumber": "123456******1234"
},
"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"status": "REQUIRES_ACTION",
"receivedTime": "2021-10-12T11:11:57+09:00",
"orderId": "order_01",
"resultRegisterAccountProperty": {"customerId": "sampleCustomerId_01",
"accountMethod": {"accountMethodId": "01",
"isValid": true,
"paymentMethodId": "samplePaymentMethodId",
"property": {"maskedAccountNumber": "************0000",
"accountName": "test name",
"expiryDate": "0000"
}
},
"status": "SUCCESS",
"errorDetail": {"code": "404",
"message": "顧客が存在していません。"
}
}
}

captureTransaction

支払（オーソリ）された決済を売上確定します。支払後にのみ決済を売上確定できます。
通常支払額の全額を売上確定しますが、金額変更の際にRequest Bodyにおいて金額を指定すると、支払額の一部を売上確定できます。
※支払（オーソリ）と売上確定のタイミングが同時の場合や支払に対応していない決済手段の場合、こちらのAPIは使用しません(支払への対応状況は提供機能マッピングをご確認ください)。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

path Parameters

transactionId

required

string

元取引のID
こちらのIDはpayTransactionのレスポンスと同じtransactionIdである必要があります。
※再支払（再オーソリ）の売上確定時も元取引のpayTransactionのレスポンスと同じtransactionIdである必要があります。

Request Body schema: application/json

One of

requestId required	string <= 70 characters 加盟店様が払い出す、リクエストを識別するID べき等性を担保し、決済取引が多重に行われることを防ぐために設定します。詳細はべき等性の担保をご参照ください。 `使用可能文字：半角英数字＋記号（_）`
required	object
labels	Array of strings <= 50 items [ items [ 1 .. 255 ] characters ] ラベル加盟店様の運用に合わせて最大50個まで自由に設定いただけます。 `使用可能文字：全角半角文字（<>&は対象外）`
requestProperty required	object requestPropertyオブジェクトこちらの項目は各種決済手段固有の情報です。クレジットカード決済のrequestPropertyオブジェクトの中身は空で設定してください。

Responses

Request samples

Payload

Content type

application/json

Example

CreditCaptureRequest

{"requestId": "sampleId_02",
"amount": {"currencyCode": "JPY",
"value": 1200
},
"labels": ["ラベル"
],
"requestProperty": { }
}

Response samples

Content type

application/json

Example

CreditCaptureResponse

{"requestId": "sampleId_01",
"resultCode": 100,
"resultDescription": "正常に処理が終了しました",
"resultProperty": {"errorCode": "I900"
},
"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"status": "REQUIRES_ACTION",
"receivedTime": "2021-10-12T11:11:57+09:00",
"orderId": "order_01"
}

cancelTransaction

支払（オーソリ）された決済をキャンセルします。支払後にのみ決済をキャンセルできます。
※支払（オーソリ）と売上確定のタイミングが同時の場合や支払に対応していない決済手段の場合、こちらのAPIは使用しません(支払への対応状況は提供機能マッピングをご確認ください)。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

path Parameters

transactionId

required

string

元取引のID
こちらのIDはpayTransactionのレスポンスと同じtransactionIdである必要があります。
※再支払（再オーソリ）時も元取引のpayTransactionのレスポンスと同じtransactionIdである必要があります。

Request Body schema: application/json

One of

requestId required	string <= 70 characters 加盟店様が払い出す、リクエストを識別するID べき等性を担保し、決済取引が多重に行われることを防ぐために設定します。詳細はべき等性の担保をご参照ください。 `使用可能文字：半角英数字＋記号（_）`
required	object
labels	Array of strings <= 50 items [ items [ 1 .. 255 ] characters ] ラベル加盟店様の運用に合わせて最大50個まで自由に設定いただけます。 `使用可能文字：全角半角文字（<>&は対象外）`
required	object requestPropertyオブジェクトこちらの項目は各種決済手段固有の情報です。

Responses

Request samples

Payload

Content type

application/json

Example

CreditCancelRequest

{"requestId": "sampleId_03",
"amount": {"currencyCode": "JPY",
"value": 1200
},
"labels": ["ラベル"
],
"requestProperty": {"settleUnitID": "00001"
}
}

Response samples

Content type

application/json

Example

CreditCancelResponse

{"requestId": "sampleId_01",
"resultCode": 100,
"resultDescription": "正常に処理が終了しました",
"resultProperty": {"errorCode": "C50",
"approvalCode": "1234567",
"terminalProcessingSerialNumber": "11001",
"receiveCompanyCode": "12345670001"
},
"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"status": "REQUIRES_ACTION",
"receivedTime": "2021-10-12T11:11:57+09:00",
"orderId": "order_01"
}

refundTransaction

売上確定した決済取引に対して返金処理をします。売上確定後の決済取引にのみ返金処理ができます。支払（オーソリ）と売上確定のタイミングを同時にした場合（payTransactionのRequest Bodyの項目であるcaptureNowにtrueを設定した場合）も返金処理ができます。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

path Parameters

transactionId

required

string

元取引のID
こちらのIDはpayTransactionのレスポンスと同じtransactionIdである必要があります。

Request Body schema: application/json

One of

requestId required	string <= 70 characters 加盟店様が払い出す、リクエストを識別するID べき等性を担保し、決済取引が多重に行われることを防ぐために設定します。詳細はべき等性の担保をご参照ください。 `使用可能文字：半角英数字＋記号（_）`
required	object
labels	Array of strings <= 50 items [ items [ 1 .. 255 ] characters ] ラベル加盟店様の運用に合わせて最大50個まで自由に設定いただけます。 `使用可能文字：全角半角文字（<>&は対象外）`
required	object requestPropertyオブジェクトこちらの項目は各種決済手段固有の情報です。 ※支払区分によって設定有無、方法が異なります。詳細支払区分設定方法をご参照ください。

Responses

Request samples

Payload

Content type

application/json

Example

CreditRefundRequest

{"requestId": "sampleId_04",
"amount": {"currencyCode": "JPY",
"value": 1200
},
"labels": ["ラベル"
],
"requestProperty": {"settleUnitID": "00001"
}
}

Response samples

Content type

application/json

Example

CreditRefundResponse

{"requestId": "sampleId_01",
"resultCode": 100,
"resultDescription": "正常に処理が終了しました",
"resultProperty": {"errorCode": "C50",
"approvalCode": "1234567",
"terminalProcessingSerialNumber": "11001",
"receiveCompanyCode": "12345670001"
},
"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"status": "REQUIRES_ACTION",
"receivedTime": "2021-10-12T11:11:57+09:00",
"orderId": "order_01"
}

forceCancelTransaction

決済要求の際に支払（オーソリ）された決済か売上確定した決済取引かが不明な場合、取引アクションを判別し、支払（オーソリ）された決済であれば支払キャンセル、売上確定された決済であれば返金処理を実施します。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

path Parameters

transactionId

required

string

元取引のID
こちらのIDはpayTransactionのレスポンスと同じtransactionIdである必要があります。

Request Body schema: application/json

One of

requestId required	string <= 70 characters 加盟店様が払い出す、リクエストを識別するID べき等性を担保し、決済取引が多重に行われることを防ぐために設定します。詳細はべき等性の担保をご参照ください。 `使用可能文字：半角英数字＋記号（_）`
required	object
labels	Array of strings <= 50 items [ items [ 1 .. 255 ] characters ] ラベル加盟店様の運用に合わせて最大50個まで自由に設定いただけます。 `使用可能文字：全角半角文字（<>&は対象外）`
required	object requestPropertyオブジェクトこちらの項目は各種決済手段固有の情報です。

Responses

Request samples

Payload

Content type

application/json

{"requestId": "sampleId_05",
"amount": {"currencyCode": "JPY",
"value": 1200
},
"labels": ["ラベル"
],
"requestProperty": {"settleUnitID": "00001"
}
}

Response samples

Content type

application/json

{"requestId": "sampleId_05",
"resultCode": 100,
"resultDescription": "正常に処理が終了しました",
"resultProperty": {"errorCode": "C50",
"approvalCode": "1234567",
"terminalProcessingSerialNumber": "11001"
},
"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"status": "SUCCESS",
"receivedTime": "2021-10-12T11:11:57+09:00",
"orderId": "order_01"
}

subscribeTransaction

こちらのAPIを利用することで、指定された決済取引が更新された際に最新の取引状態の通知が送信されるWebhookを設定できます。
取引情報取得のAPI（listTransactions・getTransaction・getTransactionSummary）ではなくこちらのAPIを利用したほうが利用者のリダイレクトより前に結果をうけとれる可能性がある為、処理に時間がかからず利用者を待たせないというメリットがあります。

通知を受信するためには、本サービス側から送信されるPOSTメソッドを受け取れるcallbackUrlを加盟店様側で設定する必要があります。
なお、callbackUrlのポート番号は443を設定してください（443以外のポート番号の場合、適切にCallback通知を送信できないのでご注意ください）。
Callbackの詳細は以下のCallbacksをご参照ください。
※取引をサブスクライブした際、CallbacksがcallbackUrlにPOSTされます。
※本サービスからCallbackをPOSTされ、正常に受信できた加盟店様のサーバーは、HTTPステータスコード202もしくは204のいずれかを本サービスに応答する必要があります。
※POSTメソッドの受け取りの際にエラーが発生し、送信から5秒間加盟店様のサーバーからレスポンスがない場合は、3秒間スリープしたのちに2回までリトライを行います。(各通知が最大3回POSTされます) リトライを行いますが、通知送信がすべて失敗する可能性もあるため、一定の期間通知を受信できない場合は、getTransactionを行い取引情報を取得するか、もう一度subscribeTransactionを送り最新の取引情報を取得することを推奨します。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

path Parameters

transactionId

required

string

Webhookを設定する取引のID
こちらのIDは、通知を設定する取引に紐づいたtransactionIdです。

Request Body schema: application/json

callbackUrl

required

string <uri>

取引が更新された際にデータが送信される場所
https://から始まる任意のURLをご指定いただけます。詳細は以下のCallbacksをご参照ください。

Responses

Callbacks

Request samples

Payload

Content type

application/json

{"callbackUrl": "https://example.com/callback"
}

Response samples

Content type

application/json

{"subscribeId": "01FC5K6EZ7Q5VTP0BHEFES3SP3"
}

Callback payload samples

Callback

POST: サブスクライブの設定が完了した際と、取引が更新された場合、指定されたcallbackUrlに対して以下の内容がPOSTされます。

Content type

application/json

{"requestId": "sampleId_05",
"resultCode": 100,
"resultDescription": "正常に処理が終了しました",
"resultProperty": { },
"status": "REQUIRES_ACTION",
"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76g",
"paymentMethodId": "samplepaymentMethodId",
"receivedTime": "2021-10-12T11:11:57+09:00"
}

listTransactions

認証された決済グループの決済取引一覧を取得します。
Response Schema以下の表の要素を持つオブジェクトの配列がreceivedTimeの降順で返却されます。
※requestPropertyやresultPropertyの機密情報はマスキングされます。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

query Parameters

pageSize	integer <int32> [ 1 .. 100 ] 一度に返却するアイテム数 APIはこちらで指定した値より少ないアイテム数を返却する場合があります。指定しない場合と0を指定した場合、最大10個のアイテムが返却されます。 100を超える値は100に変換されます。負の値を指定すると、422が返却されます。
pageToken	string 前回こちらのAPIを呼び出した際にResponse Headersとして受信した値(`X-Next-Token`) こちらの項目を指定することで、前回取得したアイテムの次のアイテムから取得できます。指定した値が取引IDとして存在しなかった場合、未設定とみなします。
after	string <date-time> こちらで指定した日付以降に作成されたアイテムを返却します。こちらで指定した日付を含みます。フォーマットはISO 8601(YYYY-MM-DDThh:mm:ss+09:00)です。
before	string <date-time> こちらで指定した日付より前に作成されたアイテムを返却します。こちらで指定した日付は含みません。フォーマットはISO 8601(YYYY-MM-DDThh:mm:ss+09:00)です。
orderId	string <= 64 characters 支払（オーソリ）で設定され、情報取得のために加盟店様が払い出す、注文を識別するID こちらで指定したIDに関連するすべてのアイテムを返却します。 `使用可能文字：半角英数字＋記号（-_）`

Responses

Response samples

Content type

application/json

[[{"action": "PAY",
"amount": {"currencyCode": "JPY",
"value": 1200
},
"baseTransactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"paymentGroupId": "01DQ4H6WA0ZPX4V3GRY7TJ0J70",
"paymentMethodId": "PayPay",
"relatedTransactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"requestId": "sampleId_02",
"requestProperty"": { },
"resultCode": 100,
"resultDescription": "正常に処理が終了しました",
"resultProperty"": { },
"status": "SUCCESS",
"transactionId": "01DQ4H0BA0Z4X4V5DOR7TJ0l4",
"labels": ["ラベル"
],
"orderId": "order_01",
"receivedTime": "2021-10-12T11:11:57+09:00",
"processedTime": "2021-10-13T11:11:57+09:00"
},
{"action": "CAPTURE",
"amount": {"currencyCode": "JPY",
"value": 1200
},
"baseTransactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"paymentGroupId": "01DQ4H6WA0ZPX4V3GRY7TJ0J70",
"paymentMethodId": "PayPay",
"relatedTransactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"requestId": "sampleId_02",
"requestProperty"": { },
"resultCode": 100,
"resultDescription": "正常に処理が終了しました",
"resultProperty"": { },
"status": "SUCCESS",
"transactionId": "01DQ4H0BA0Z4X4V5DOR7TJ0l4",
"labels": ["ラベル"
],
"orderId": "order_01",
"receivedTime": "2021-10-12T11:11:57+09:00",
"processedTime": "2021-10-13T11:11:57+09:00"
}
]
]

getTransaction

指定された取引に関する詳細な情報を取得します。
※requestPropertyやresultPropertyの機密情報はマスキングされます。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

path Parameters

transactionId

required

string

取引のID
こちらのIDは、情報を取得する取引に紐づいたtransactionIdです。

query Parameters

recursive

boolean

Default: false

配下決済グループ検索フラグ
trueを指定した場合、APIを実行する決済グループよりも下位に位置する、全ての決済グループに属する取引を検索対象とします。 true/false以外が指定された場合、デフォルト値(false)が適用されます。

Responses

Response samples

Content type

application/json

{"action": "CAPTURE",
"amount": {"currencyCode": "JPY",
"value": 1200
},
"baseTransactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"paymentGroupId": "01DQ4H6WA0ZPX4V3GRY7TJ0J70",
"paymentMethodId": "PayPay",
"relatedTransactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"requestId": "sampleId_02",
"requestProperty": { },
"resultCode": 100,
"resultDescription": "正常に処理が終了しました",
"resultProperty": { },
"status": "SUCCESS",
"terminalId": "string",
"transactionId": "01DQ4H0BA0Z4X4V5DOR7TJ0l4",
"labels": ["ラベル"
],
"orderId": "order_01",
"receivedTime": "2021-10-12T11:11:57+09:00",
"processedTime": "2021-10-13T11:11:57+09:00"
}

getProviderTransaction

指定された取引に対して、決済事業者側で管理している情報を取得します。
決済事業側での取引進行状況など、リアルタイムでの取引状態を確認したい場合などに、ご利用いただけます。

path Parameters

transactionId

required

string

元取引のID
こちらのIDはpayTransactionのレスポンスと同じtransactionIdである必要があります。

Responses

Response samples

Content type

application/json

{"status": "SUCCESS",
"resultCode": 100,
"resultDescription": "正常に処理が終了しました",
"resultProperty": {"errorCode": "NP101",
"providerTransaction": {"npTransactionId": "2024040100001",
"invoiceType": "01",
"shopCode": "akt1234567",
"shopOrderDate": "2023-04-01",
"shopOrderId": "shopOrder20211027",
"amount": 10000,
"authorizationResult": "00",
"authoriRequiredDateTime": "2021-10-27T12:34:56+09:00",
"authorizationResultNgReason": "NG001",
"billIssuedDate": "2023-04-01",
"paymentDueDate": "string",
"billReturnDate": "2023-04-01",
"customerPaymentDate": "2023-04-01",
"cancelDate": "2023-04-01",
"billType": "02",
"customer": {"name": "注文太郎",
"nameKana": "ちゅうもんたろう",
"companyName": "（株）オムニペイメントゲートウェイ",
"department": "カスタマーサービス事業部",
"postalCode": "1356033",
"address": "東京都江東区豊洲３－３－３　豊洲センタービル",
"telephoneNumber": "12312341234",
"emailAddress": "atobarai@omni.service.com",
"lastPurchaseDate": "2023-09-30",
"lastPurchaseAmount": 99999999,
"totalPurchaseAmount": 99999999,
"totalPurchaseCount": 99999,
"identificationStatus": "1",
"membershipFlag": "1",
"shopCustomerId": "c123456",
"membershipStartDate": "2023-04-20",
"terminalId": "11 111111 111111 0",
"terminalInfo": "iphone12",
"ipAddress": "127.0.0.1",
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100"
},
"destCustomer": {"name": "お届け太郎",
"nameKana": "おとどけたろう",
"companyName": "（株）お届け先カンパニー",
"department": "お届け事業部",
"postalCode": "1356033",
"address": "東京都江東区豊洲３ー３－３　豊洲センタービル",
"telephoneNumber": "12312341234"
},
"items": [{"itemName": "商品名１",
"itemPrice": 1000,
"itemCount": 10,
"brandName": "ブランドA"
},
{"itemName": "10%OFF割引",
"itemPrice": -1000,
"itemCount": 1
}
]
}
}
}

cancelUnresponsedTransaction

通信障害などの理由で、本サービスに要求した処理（以下当該処理と表記）の結果が不明である際に利用する機能です。
障害取消を利用することで、本サービスにおいて当該処理が成功していたか失敗していたかに関わらず、当該処理が送信される前の状態に戻ります。

なお、本APIは障害取引が成功したかどうかではなく、本サービスが障害取消を実行可能かを応答します。障害取消取引の成否は別途、取引情報取得（listTransactions / getTransaction）、サブスクライブ（subscribeTransaction）で確認できます。当該処理の結果は更新されません。
クレジットカードの場合は、障害取消可能時間を過ぎた場合は障害取消が失敗します。障害取消可能時間については各決済手段の取引期限をご参照ください。また、同一取引に対して障害取消を複数回実行できません。
PayPayの場合は、支払のみに障害取消を行い、同時売上、売上確定、支払キャンセル、返金に対しては再送を行ってください。既に成功した同時売上の取消については、別途返金処理を行ってください。詳しくはPayPay処理シーケンスの障害取消をご参照ください。
d払いの場合は、支払・同時売上・売上確定・返金のみに障害取消を行い、支払キャンセルの場合は元の取引の再送を行います。
同一取引に対して障害取消を複数回実行できません。また、売上データ連携が既に行われた取引（同時売上、売上確定、返金が該当）に対しても障害取消不可となっています。
Bank Payの場合は、同時売上のみに障害取消を行います。
au PAY・Amazon Pay・コンビニ決済(番号払い)の場合は、障害取消に対応していないため必要に応じて支払キャンセルや返金を実施してください。
楽天ペイの場合は、支払・同時売上に対してのみ障害取消が可能です。

※API経由で作成された決済取引のみ障害取消可能です。
※金額補正処理（correctAmountTransaction）で作成された取引は障害取消できません。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

Request Body schema: application/json

requestId required	string <= 70 characters 加盟店様が払い出す、リクエストを識別するID べき等性を担保し、決済取引が多重に行われることを防ぐために設定します。詳細はべき等性の担保をご参照ください。 `使用可能文字：半角英数字＋記号（_）`
relatedRequestId required	string <= 70 characters 関連するリクエストを識別するID こちらのIDは障害取消対象取引と同じrequestIdである必要があります。

Responses

Request samples

Payload

Content type

application/json

{"requestId": "sampleId_03",
"relatedRequestId": "sampleId_02"
}

Response samples

Content type

application/json

{"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76"
}

adviceTransaction

決済へ追加処理を行う際に実施します。
例：クレジットカード決済の場合、支払（オーソリ・3Dセキュア認証あり）+売上確定にて、認証要求完了後の決済リクエストを実行します。 ※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

path Parameters

transactionId

required

string

元取引のID
こちらのIDはpayTransactionもしくは、会員番号を直接設定する場合のverifyCustomerのレスポンスと同じtransactionIdである必要があります。

Request Body schema: application/json

One of

requestId required	string <= 70 characters 加盟店様が払い出す、リクエストを識別するID べき等性を担保し、決済取引が多重に行われることを防ぐために設定します。詳細はべき等性の担保をご参照ください。 `使用可能文字：半角英数字＋記号（_）`
required	object requestPropertyオブジェクトこちらの項目は各種決済手段固有の情報です。 3DセキュアのnotificationUrlに通知される情報に通知された情報（以下、通知情報）を設定してください。

Responses

Request samples

Payload

Content type

application/json

Example

CreditAdviceRequest

{"requestId": "sampleId_01",
"requestProperty": {"threeDSResult": {"messageVersionNumber": "ABC0001!!",
"transactionStatus": "s",
"accountholderAuthenticationValue": "ABCDEFGHIJKLMNO0123456789!%&",
"electronicCommerceIndicator": "10",
"dsTransactionId": "ABCDEFGHIJKLMNOPQRSTUVW0123456789!%&",
"threeDSServerTransactionId": "ABCDEFGHIJKLMNOPQRSTUVW0123456789!%&"
}
}
}

Response samples

Content type

application/json

Example

CreditAdviceResponse

{"requestId": "sampleId_01",
"resultCode": 100,
"resultDescription": "正常に処理が終了しました",
"resultProperty": {"errorCode": "G12",
"approvalCode": "1234567",
"receiveCompanyCode": "12345670001",
"terminalProcessingSerialNumber": "11001",
"maskedPrimaryAccountNumber": "123456******1234",
"maskedNetworkTokenNumber": "123456******1234"
},
"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"status": "REQUIRES_ACTION",
"receivedTime": "2021-10-12T11:11:57+09:00",
"orderId": "order_01",
"resultRegisterAccountProperty": {"customerId": "sampleCustomerId_01",
"accountMethod": {"accountMethodId": "01",
"isValid": true,
"paymentMethodId": "samplePaymentMethodId",
"property": {"maskedAccountNumber": "************0000",
"accountName": "test name",
"expiryDate": "0000"
}
},
"status": "SUCCESS",
"errorDetail": {"code": "404",
"message": "顧客が存在していません。"
}
}
}

correctAmountTransaction

支払(オーソリ)または売上確定した決済取引に対して金額補正処理を行います。
元取引が支払(オーソリ)の場合は、取引情報としては変更後の金額での支払(オーソリ)と変更前の金額でのキャンセルの2レコード登録されます。
元取引が売上確定の場合は、取引情報としては変更後の金額での売上確定と変更前の金額での返金の2レコード登録されます。
また、金額補正処理の中で片方または両方の取引の失敗など、不整合が発生した場合は、内部で障害取消を実施します。
例えば元取引が支払(オーソリ)の決済取引に対して金額補正処理を行い、補正処理の途中で支払(オーソリ)が失敗した場合、失敗した支払(オーソリ)に対して内部で障害取消を実施します。
Response SchemaのtransactionsはreceivedTimeの昇順で返却されます。
※金額補正処理で作成された取引は障害取消できません。前の状態に戻したい場合は、前の状態の金額を設定し再度金額補正処理を実施してください。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

path Parameters

transactionId

required

string

元取引のID
こちらのIDはpayTransactionのレスポンスと同じtransactionIdである必要があります。

Request Body schema: application/json

One of

requestId required	string <= 70 characters 加盟店様が払い出す、リクエストを識別するID べき等性を担保し、決済取引が多重に行われることを防ぐために設定します。詳細はべき等性の担保をご参照ください。 ※なお本項目と補正の結果として取引に設定されるrequestIdは異なります。金額補正処理では、元取引に応じて補正の結果として2つの取引が生成されます。そのため金額補正処理で発生する取引では、金額補正処理作成時に指定されたrequestIdの末尾にその取引に応じて発生するアクション情報を追加して決済リクエストを識別しています。例えば金額補正処理作成時に指定されたrequestIdがxxx、元取引が支払(オーソリ)の場合、補正の結果として取引に設定されるrequestIdはxxx_payとxxx_cancelです。同様にrequestIdがxxx、元取引が売上確定の場合、補正の結果として取引に設定されるrequestIdはxxx_captureとxxx_refundです。障害取消の場合はxxx_payFC,xxx_cancelFC,xxx_captureFC,xxx_refundFCのように、対象の取引のactionにFCが付加されたものが設定されます。 `使用可能文字：半角英数字＋記号（_）`
required	object
labels	Array of strings <= 50 items [ items [ 1 .. 255 ] characters ] ラベル加盟店様の運用に合わせて最大50個まで自由に設定いただけます。 `使用可能文字：全角半角文字（<>&は対象外）`
requestProperty required	object requestPropertyオブジェクトこちらの項目は各種決済手段固有の情報です。クレジットカード決済のrequestPropertyオブジェクトの中身は空で設定してください。

Responses

Request samples

Payload

Content type

application/json

{"requestId": "sampleId_03",
"amount": {"currencyCode": "JPY",
"value": 1200
},
"labels": ["ラベル"
],
"requestProperty": { }
}

Response samples

Content type

application/json

{"requestId": "sampleId_01",
"correctStatus": "SUCCESS",
"orderId": "order_01",
"transactions": [{"action": "PAY",
"resultCode": 100,
"resultDescription": "正常に処理が終了しました",
"resultProperty": {"errorCode": "G12",
"approvalCode": "1234567",
"receiveCompanyCode": "12345670001",
"terminalProcessingSerialNumber": "11001"
},
"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"status": "SUCCESS",
"receivedTime": "2021-10-12T11:11:57+09:00"
},
{"action": "CANCEL",
"resultCode": 100,
"resultDescription": "正常に処理が終了しました",
"resultProperty": {"errorCode": "G12",
"approvalCode": "1234567",
"receiveCompanyCode": "12345670001",
"terminalProcessingSerialNumber": "11001"
},
"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J78",
"status": "SUCCESS",
"receivedTime": "2021-10-12T11:11:59+09:00"
}
]
}

取引サマリ取得

getTransactionSummary

指定された元取引に紐づく、一連の決済取引に関する詳細な情報を取得します。
指定された元取引（支払）のtransactionIdを指定することで、関連する取引（売上確定、キャンセル、返金など）や、その詳細な情報を取得できます。
Response SchemaのrelatedTransactionsはreceivedTimeの昇順で返却されます。
※relatedTransactions内のrequestPropertyやresultPropertyの機密情報はマスキングされます。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

path Parameters

baseTransactionId

required

string

元取引のID
こちらのIDは初回のpayTransactionのレスポンスと同じtransactionIdである必要があります。

Responses

Response samples

Content type

application/json

{"baseTransactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"baseRequestId": "sampleId_0",
"baseRequestChannel": "api",
"amount": {"currencyCode": "JPY",
"value": 1200
},
"paymentGroupId": "01DQ4H6WA0ZPX4V3GRY7TJ0J70",
"terminalId": "string",
"paymentMethodId": "PayPay",
"orderId": "order_01",
"lastSucceedAction": "PAY",
"relatedTransactions": [{"action": "PAY",
"amount": {"currencyCode": "JPY",
"value": 1200
},
"baseTransactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"paymentGroupId": "01DQ4H6WA0ZPX4V3GRY7TJ0J70",
"paymentMethodId": "PayPay",
"relatedTransactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"requestId": "sampleId_02",
"requestProperty"": { },
"resultCode": 100,
"resultDescription": "正常に処理が終了しました",
"resultProperty"": { },
"status": "SUCCESS",
"transactionId": "01DQ4H0BA0Z4X4V5DOR7TJ0l4",
"labels": ["ラベル"
],
"orderId": "order_01",
"receivedTime": "2021-10-12T11:11:57+09:00",
"processedTime": "2021-10-13T11:11:57+09:00"
},
{"action": "CAPTURE",
"amount": {"currencyCode": "JPY",
"value": 1200
},
"baseTransactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"paymentGroupId": "01DQ4H6WA0ZPX4V3GRY7TJ0J70",
"paymentMethodId": "PayPay",
"relatedTransactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"requestId": "sampleId_02",
"requestProperty"": { },
"resultCode": 100,
"resultDescription": "正常に処理が終了しました",
"resultProperty"": { },
"status": "SUCCESS",
"transactionId": "01DQ4H0BA0Z4X4V5DOR7TJ0l4",
"labels": ["ラベル"
],
"orderId": "order_01",
"receivedTime": "2021-10-12T11:11:57+09:00",
"processedTime": "2021-10-13T11:11:57+09:00"
}
]
}

リンク決済

リンク決済を行うためのエンドポイントです。
処理シーケンスの詳細はサービス仕様書の以下のページをご参照ください。

リンク決済処理シーケンス

createPaymentUrl

利用者向け支払画面のリンク（URL）を作成します。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。
※リンク情報の保持期間は発行日から26か月です。保持期間を過ぎたリンクは閲覧できません。

Request Body schema: application/json

requestId

required

string <= 50 characters

加盟店様が払い出す、リクエストを識別するID

※なお本項目とリンクから行われる取引に設定されるrequestIdは異なります。
詳細は本APIのCallbacksのrequestIdの説明をご参照ください。

使用可能文字：半角英数字＋記号（_）

required

object

paymentMethodIds

Array of strings

取引に利用する決済手段ID

設定しない場合は利用可能な決済手段の全てが有効です。
複数指定可能です。

クレジットカード決済 - ”Credit”
コンビニ決済(番号払い) - ”Convenience”
PayPay - ”PayPay”
楽天ペイ - "RakutenPay"
d払い - ”DPayment”
au PAY - ”AuPay”
銀行ネット決済 - ”NetBankingAtm”

こちらのIDはlistPaymentMethodsからも取得できます。
※クレジットカード決済では、分割回数を2回、3回、6回、10回、12回、24回から選択可能です。
※決済情報預かりに対応しているのはクレジットカード決済のみです。決済情報預かりについての詳細は業務概要の会員管理の機能説明の欄をご参照ください。

object

こちらの項目は各種決済手段固有の情報の集合です。

orderId

string <= 64 characters

照会のために加盟店様が払い出す、注文を識別するID
このIDによって、発行済みリンクからそれに関連するすべての取引(支払/売上/返金など)を紐付けて参照できるため、値を設定することが推奨されます。

また、このIDを使って、生成された取引をlistTransactionsで情報取得することが出来ます。
使用可能文字：半角英数字＋記号（_-）

successUrl

string <uri> <= 2000 characters

取引を正常に完了した利用者はこちらのURLにリダイレクトされます。
successUrlを指定しない場合は、本サービスの完了画面を表示します。

※利用者が以下の決済手段を選択した場合は、支払に必要な情報が記載された本サービスの支払受付画面が表示されるため、本パラメータのURLには遷移しません。

コンビニ決済(番号払い)
銀行ネット決済

cancelUrl

string <uri> <= 2000 characters

利用者が戻るボタンを選択か押下するとこちらのURLにリダイレクトされます。
cancelUrl を指定しない場合は、戻るボタンは表示されません。

callbackUrl

string <uri> <= 2000 characters

取引が更新された際に本サービスから更新内容を通知するURLを指定してください。
本パラメータが設定された場合のみ通知が行われます。
https://から始まる任意のURLをご指定いただけます。
なお、callbackUrlのポート番号は443を設定してください（443以外のポート番号の場合、適切にCallback通知を送信できないのでご注意ください）。
詳細は以下のCallbacksをご参照ください。

※本サービスからCallbackをPOSTされ、正常に受信できた加盟店様のサーバーは、HTTPステータスコード202もしくは204のいずれかを本サービスに応答する必要があります。
※POSTメソッドの受け取りの際にエラーが発生し、送信から5秒間加盟店様のサーバーからレスポンスがない場合は、3秒間スリープしたのちに2回までリトライを行います。(各通知が最大3回POSTされます)

expiresAt

string <date-time>

決済リンクの有効期限

発行した決済リンクが期限切れになる日時です。
期限切れになったリンクは利用できなくなります。

デフォルトでは、こちらの値は作成から24時間後です。
フォーマットはISO 8601です。

※1年以内の値を設定してください。

payLimitAt

string <date-time>

利用者の支払期限

利用者の払込が必要な決済手段における利用者の支払期限です。
各決済事業者から利用者に払い出される払込番号やバーコードの有効期間であり、利用者はこの期限内にコンビニや金融機関などでの支払を完了させる必要があります。
本項目の設定対象となる決済手段と設定可能な期限は以下の通りです。

コンビニ決済(番号払い) - リンク発行の当日〜89日後
銀行ネット決済 - リンク発行の当日〜60日後

デフォルトでは、こちらの値はリンク発行日から5日後です。
フォーマットはISO 8601です。

※決済手段によって上限が異なります。
複数の決済手段を選択してリンクを発行する場合、最も上限が低い決済手段に合わせた支払期限を設定する必要があります。

※現在は分単位の期限設定に対応していないため、分の設定値によらず指定された時間の59分59秒が期限として設定されます。

captureNow

boolean

Default: false

支払（オーソリ）と売上確定のタイミングを同時にするか否かを区別する項目

true - 同時にする
false - 同時にしない

本パラメータをサポートしていない決済手段の場合は、決済手段規定の動作をします。
各決済手段の対応は以下です。

クレジットカード決済 - 設定可能
コンビニ決済(番号払い) - 設定値によらずtrueで決済が実行されます
PayPay - 設定可能
楽天ペイ - 設定可能
d払い - 設定可能
au PAY - 設定可能
銀行ネット決済 - 設定値によらずtrueで決済が実行されます

description

string <= 255 characters

任意の文字列
利用者向け支払画面に表示されます。
候補としては取引の内容が考えられます。

d払いを選択した場合は、先頭40文字がd払い決済時の内容確認画面およびご利用明細（詳細内容確認画面など）に表示されますが、それらの画面ではd払い未対応の記号（".'/）が半角スペースに置換されます。

楽天ペイを選択した場合は、不正注文対策のため購入商品情報を特定できる名称（一部でも可）を設定してください。
型番商品の場合ブランド名の併記を推奨します。購入商品が複数の場合、区切り文字（推奨＝セミコロン；）をご利用ください。個人情報（氏名、住所など）は設定しないでください。設定した値は利用者向け決済画面に表示されますのでご注意ください。

使用可能文字：全角半角文字

labels

Array of strings <= 50 items [ items [ 1 .. 255 ] characters ]

ラベル
加盟店様の運用に合わせて最大50個まで自由に設定いただけます。
使用可能文字：全角半角文字（<>&は対象外）

customerId

string [ 1 .. 33 ] characters

顧客ID

顧客を識別するために、加盟店様側で採番・管理頂くIDです。
加盟店様が払い出すIDで、加盟店様内で一意である必要があります。
既に登録済みのIDを指定した場合は、顧客が過去に登録したカード情報を利用して決済を行うことができます。
未登録のIDを指定した場合は、顧客が取引に使用したカード情報を新規で登録できます。

※決済情報預かりに対応していない決済手段のみを選択した場合は、入力しないようにしてください(決済情報預かりへの対応状況は提供機能マッピングをご確認ください) 。
使用可能文字：半角英数字+記号（-_）

object

利用者情報

メールまたはSMSの送信を行う際に使用する利用者情報です。
それぞれの場合で必要な情報を設定してください。

また、利用者情報が必要な決済手段を選択した際にも本項目の値が利用されます。
必要項目に値を設定しなかった場合、支払画面で利用者へ入力を要求する場合があります。
※利用者情報を加盟店様が事前に保持している場合は、本項目を設定することで、利用者が支払画面で入力する項目を減らすことが出来ます。

利用者情報が必要な決済手段と利用有無一覧

	クレジットカード決済 (3Dセキュア認証)	コンビニ決済 (番号払い)	銀行ネット決済
`firstName`	- (※1)	発行時任意・決済時必須(※3)	任意(※4)
`lastName`	-	発行時任意・決済時必須(※3)	任意(※4)
`firstNameKana`	-	-	任意(※4)
`lastNameKana`	-	-	任意(※4)
`emailAddress`	条件付き任意(※2)	発行時任意・決済時必須(※3)	-
`telephones`	任意(※2)	発行時任意・決済時必須(※3)	-

※1. -となっている値は支払に不要なため、設定されていても利用されません。
※2. emailAddressとtelephonesの両項目とも値を設定せずリンクを発行した場合、クレジットカード決済選択時に支払画面で利用者へemailAddressのみ入力を要求します。
※3. 本項目に値を設定せずリンクを発行した場合、コンビニ決済(番号払い)選択時に支払画面で利用者へ入力を要求します。
※4. 本項目に値を設定せずリンクを発行した場合、利用者への入力は要求せず空のまま決済が行われます。

notifyOnExpiration

boolean

Default: false

期限切れお知らせを加盟店ポータルに表示するかを指定する項目

true - 表示する
false - 表示しない

Array of objects <= 3 items

メール送信に必要な情報

利用者に対してメールによる通知を行う際に指定してください。
利用者の情報はcustomerInfoに設定してください。

Array of objects <= 3 items

SMS送信に必要な情報

利用者に対してSMSによる通知を行う際に指定してください。
利用者の情報はcustomerInfoに設定してください。

※SMS送信機能の利用には別途契約や利用料金が必要です。リンク決済 SMS送信時の注意事項をご参照の上、詳しくは担当者にお問い合わせください。

employeeEmailAddresses

Array of strings <email> <= 5 items [ items <email > <= 50 characters ]

加盟店担当者様のメールアドレス

本項目を設定した場合は、利用者にメールもしくはSMSを送信する際の証跡として、同内容のメールを加盟店担当者様に送信できます。

メール送信の場合は、利用者に送信されるメールのBCCに本項目のメールアドレスを設定し送信します。
SMS送信の場合は、利用者に送信されるSMSのメッセージが記載されたメールを本項目のメールアドレス宛に送信します。

※RFC 5322に準拠していない形式のメールアドレスを指定した場合、事業者側でエラーになる可能性があります。

メールアドレスのフォーマットは以下の通りです。

@は一つだけにしてください。
ローカル部(@より前)とドメイン部(@より後)はそれぞれ1文字以上にしてください。
ドメイン部に.(ピリオド)が1つ以上含まれるようにしてください。

使用可能文字：半角英数字＋記号(0x21～0x7E)

Responses

Callbacks

Request samples

Payload

Content type

application/json

{"requestId": "sampleId_123",
"amount": {"currencyCode": "JPY",
"value": 1200
},
"paymentMethodIds": ["Credit",
"PayPay",
"DPayment"
],
"linkRequestProperty": {"credit": {"is3DS": true,
"requireSecurityCodeForNewCard": false,
"requireSecurityCodeForAccountMethod": false
},
"dPayment": {"merchantParameter": "sampleCode",
"contactInfo": "店舗名：○○○ストア<br>連絡先：03-9999-9999<br>Mail：hoge@example.com<br>ホームページ：http:<sl><sl>example.com"
},
"netBankingAtm": {"paymentDetail": "決済内容",
"paymentDetailKana": "ｹﾂｻｲﾅｲﾖｳ"
}
},
"orderId": "order_1231-01",
"successUrl": "https://example.com/success?requestId=sampleId_01",
"cancelUrl": "https://example.com/cancel?requestId=sampleId_01",
"callbackUrl": "https://example.com/webhook",
"expiresAt": "2020-01-31T23:59:59+09:00",
"payLimitAt": "2020-02-28T23:59:59+09:00",
"captureNow": true,
"description": "string",
"labels": ["ラベル"
],
"customerId": "sampleCustomerId_01-01",
"customerInfo": {"firstName": "太郎",
"lastName": "山田",
"firstNameKana": "タロウ",
"lastNameKana": "ヤマダ",
"emailAddress": "example@example.com",
"telephones": [{"telType": "MOBILE",
"use": ["SMS",
"CONVENIENCE"
],
"countryCode": "81",
"number": "12312341234"
}
]
},
"notifyOnExpiration": true,
"mailContents": [{"mailType": "LINK_CREATED",
"subject": "EXAMPLE店舗での購入商品についてお支払いのご依頼",
"freeText": "EXAMPLE店舗です。\nこの度は商品のご購入誠にありがとうございました。"
},
{"mailType": "REMIND",
"subject": "EXAMPLE店舗での購入商品について再度お支払いのご依頼"
},
{"mailType": "PAY_ACCEPTED",
"freeText": "EXAMPLE店舗です。\nこの度は商品のご購入誠にありがとうございました。"
},
{"mailType": "PAY_COMPLETED"
}
],
"smsContents": [{"smsType": "LINK_CREATED",
"body": "EXAMPLE店舗です。\n以下のリンクから支払を完了させてください。\n {{URL}} "
},
{"smsType": "REMIND"
},
{"smsType": "PAY_ACCEPTED"
},
{"smsType": "PAY_COMPLETED"
}
],
"employeeEmailAddresses": ["example1@example.com",
"example2@example.com"
]
}

Response samples

Content type

application/json

{"requestId": "sampleId_123",
"url": "https://example.com/test_aEU17pd0DcmGfF6eUY",
"createdAt": "2020-01-30T23:59:59+09:00",
"expiresAt": "2020-01-31T23:59:59+09:00",
"urlId": "4ef479c3-ed99-4cde-ba6d-d4125f8db68f"
}

Callback payload samples

Callback

POST: 取引が更新された場合、指定されたcallbackUrlに対して以下の内容がPOSTされます。

Content type

application/json

{"requestId": "sampleId_123_01",
"resultCode": 100,
"resultDescription": "正常に処理が終了しました",
"resultProperty": { },
"status": "REQUIRES_ACTION",
"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"paymentMethodId": "Credit",
"receivedTime": "2021-10-12T11:11:57+09:00"
}

createSetupUrl

クレジットカードのカード情報など支払に必要な決済手段情報を事前に登録、または登録済みの決済手段情報を削除する為の利用者向け画面のリンク（URL）を作成します。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。
※リンク情報の保持期間は発行日から26か月です。保持期間を過ぎたリンクは閲覧できません。

Request Body schema: application/json

customerId required	string [ 1 .. 33 ] characters 顧客ID 顧客を識別するために、加盟店様側で採番・管理頂くIDです。加盟店様が払い出すIDで、加盟店様内で一意である必要があります。既に登録済みのIDを指定した場合は、顧客が過去に登録したカード情報が表示され、カード情報の新規登録や削除が行えます。未登録のIDを指定した場合は、顧客がカード情報を新規に登録できます。 `使用可能文字：半角英数字＋記号（-_）`
paymentMethodIds	Array of strings 決済手段ID 登録する顧客情報を限定する場合に設定します。設定しない場合は利用可能な決済手段の全てが有効です。複数指定可能です。クレジットカード決済 - ”Credit”
	object こちらの項目は各種決済手段固有の情報の集合です。
successUrl	string <uri> <= 2000 characters 顧客情報の更新を正常に完了した利用者はこちらのURLにリダイレクトされます。 successUrlを指定しない場合は、本サービスの完了画面を表示します。
cancelUrl	string <uri> <= 2000 characters 顧客が戻るボタンを選択か押下するとこちらのURLにリダイレクトされます。 cancelUrl を指定しない場合は、戻るボタンは表示されません。 ※本項目名は旧項目名(`returnUrl`)から変更されています。旧項目名も引き続き利用できますが、非推奨となっているため新規でのご利用はお控えください。
callbackUrl	string <uri> <= 2000 characters 顧客情報が更新された際に本サービスから更新内容を通知するURLを指定してください。本パラメータが設定された場合のみ通知が行われます。 https://から始まる任意のURLをご指定いただけます。なお、callbackUrlのポート番号は`443`を設定してください（`443`以外のポート番号の場合、適切にCallback通知を送信できないのでご注意ください）。詳細は以下のCallbacksをご参照ください。 ※本サービスからCallbackをPOSTされ、正常に受信できた加盟店様のサーバーは、HTTPステータスコード`202`もしくは`204`のいずれかを本サービスに応答する必要があります。 ※POSTメソッドの受け取りの際にエラーが発生し、送信から5秒間加盟店様のサーバーからレスポンスがない場合は、3秒間スリープしたのちに2回までリトライを行います。(各通知が最大3回POSTされます)
expiresAt	string <date-time> リンクの有効期限発行したリンクが期限切れになる日時です。期限切れになったリンクは利用できなくなります。デフォルトでは、こちらの値は作成から24時間後です。フォーマットはISO 8601です。 ※1年以内の値を設定してください。
description	string <= 255 characters 任意の文字列顧客向けの画面に表示されます。 `使用可能文字：全角半角文字`
labels	Array of strings <= 50 items [ items [ 1 .. 255 ] characters ] ラベル加盟店様の運用に合わせて最大50個まで自由に設定いただけます。 `使用可能文字：全角半角文字（<>&は対象外）`
isDeletable	boolean Default: true 登録済み決済手段情報の削除可否を設定する項目 `true` - 削除できる `false` - 削除できない登録済みの決済手段情報を利用者がリンクから削除できるかどうかを設定します。 `false`を設定した場合、登録済みの決済手段に削除用ボタンが表示されず、利用者はリンクから登録済みの決済手段情報を削除できません。
isUpdatable	boolean Default: true 登録済み決済手段情報の更新可否を設定する項目 `true` - 更新できる `false` - 更新できない登録済みの決済手段情報を利用者がリンクから更新できるかどうかを設定します。 `false`を設定した場合、登録済みの決済手段に更新用ボタンが表示されず、利用者はリンクから登録済みの決済手段情報を更新できません。
	object 利用者情報クレジットカードの有効性確認で実施される3Dセキュア認証時に本項目の値が利用されます。必要項目に値を設定しなかった場合、カード情報登録画面で利用者へ入力を要求します。 ※利用者情報を加盟店様が事前に保持している場合は、本項目を設定することで、利用者がカード情報登録画面で入力する項目を減らすことが出来ます。

Responses

Callbacks

Request samples

Payload

Content type

application/json

{"customerId": "sampleCustomerId_01-01",
"paymentMethodIds": ["Credit"
],
"linkRequestProperty": {"credit": {"is3DS": true,
"isVerify": true
}
},
"successUrl": "https://example.com/success",
"cancelUrl": "https://example.com/cancel",
"callbackUrl": "https://example.com/webhook",
"expiresAt": "2020-01-31T23:59:59+09:00",
"description": "カード情報の登録をお願いいたします。",
"labels": ["ラベル"
],
"isDeletable": true,
"isUpdatable": true,
"customerInfo": {"emailAddress": "example@example.com",
"telephones": [{"telType": "MOBILE",
"use": ["3DS"
],
"countryCode": "81",
"number": "12312341234"
}
]
}
}

Response samples

Content type

application/json

{"customerId": "sampleCustomerId_01-01",
"url": "https://example.com/test_aEU17pd0DcmGfF6eUY",
"createdAt": "2020-01-30T23:59:59+09:00",
"expiresAt": "2020-01-31T23:59:59+09:00",
"urlId": "4ef479c3-ed99-4cde-ba6d-d4125f8db68f"
}

Callback payload samples

Callback

POST: 利用者による操作が終了した場合、指定されたcallbackUrlに対して以下の内容がPOSTされます。

Content type

application/json

{"customerId": "sampleCustomerId_01-01",
"paymentMethodId": "Credit",
"action": "REGISTER",
"status": "SUCCESS",
"accountMethodId": "01",
"urlId": "4ef479c3-ed99-4cde-ba6d-d4125f8db68f",
"resultProperty": {"errorCode": "G12"
}
}

disableUrl

発行済リンクを無効化します。
無効化されたリンクは、利用者による決済や預かり情報の登録ができなくなります。

支払用リンクは、有効期限内かつ決済未完了のリンクのみ無効化可能です。
預かり情報管理用リンクは、有効期限内のリンクのみ無効化可能です。

※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

path Parameters

urlId

required

string

URL ID

発行されたリンクに対して一意なIDです。
フォーマットはUUIDです。

Responses

Response samples

Content type

application/json

{"code": 401,
"message": "unauthorized"
}

決済情報預かり

決済情報を預けて決済を行うためのエンドポイントです。
処理シーケンスの詳細はサービス仕様書の以下のページをご参照ください。
※管理対象は、現時点では、クレジットカードとBank Payの情報のみです。

クレジットカード決済_決済情報預かり
Bank Pay_決済情報預かり

createCustomer

顧客情報を生成します。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

Request Body schema: application/json

customerId required	string <= 33 characters 顧客ID 利用者を識別するために、加盟店様側で採番・管理頂くIDです。加盟店様が払い出すIDで、加盟店様内で一意である必要があります。 `使用可能文字：半角英数字＋記号（-_）`
name	string <= 20 characters 登録する顧客の顧客名 `使用可能文字：全角半角文字`
email	string <= 254 characters 登録する顧客のメールアドレス ※RFC 5322に準拠していない形式のメールアドレスを指定した場合、事業者側でエラーになる可能性があります。 `使用可能文字：半角英数字＋記号(0x21～0x7E)`
	object 登録する顧客の自宅の電話番号
	object 登録する顧客の携帯電話番号
	object 登録する顧客の勤務先の電話番号

Responses

Request samples

Payload

Content type

application/json

{"customerId": "sampleCustomerId_01",
"name": "string",
"email": "example@example.com",
"homePhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
},
"mobilePhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
},
"workPhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
}
}

Response samples

Content type

application/json

{"customerId": "sampleCustomerId_01",
"name": "string",
"email": "sample_mail_address@nttdata.com",
"homePhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
},
"mobilePhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
},
"workPhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
}
}

verifyCustomer

顧客の決済手段に対して有効性確認を行います。
クレジットカード登録時の有効性確認で3Dセキュア認証を有効にした場合は、adviceAccountMethodが実施されるまでの間このAPIは実施できません。
本APIの有効性確認によって登録している決済手段の有効区分は更新されないため、有効性確認が失敗しても登録している決済手段の有効区分は無効になりません。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。
※リクエストIDは本サービスにて付与されます。生成仕様はULID(26桁)です。

Request Body schema: application/json

One of

required

object

有効性確認の設定値です。

Responses

Request samples

Payload

Content type

application/json

{"verificationProperty": {"cardInfo": {"customerId": "sampleCustomerId_01",
"accountMethodId": "01",
"securityCode": "123",
"securityCodeToken": "043a4f87-3b1b-497f-a9eb-d598010f4fc1",
"primaryAccountNumber": "3540697499992567",
"accountName": "test name",
"expirationDate": "2107"
},
"threeDSInfo": {"notificationUrl": "http://domain/authResult",
"authenticationData": {"authenticationIndicator": "01",
"authenticationInfo": {"authenticationData": "sample Requestor Authentication Data",
"authenticationMethod": "01",
"authenticationTimestamp": "201908161402"
},
"challengeIndicator": "01",
"accountType": "02",
"accountId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"accountInfo": {"cardholderAccountAgeIndicator": "03",
"cardholderAccountChange": "20190816",
"cardholderAccountChangeIndicator": "01",
"cardholderAccountDate": "",
"passwordChange": "20190816",
"passwordChangeIndicator": "02",
"purchaseCount": "10",
"numberOfProvisioningAttemptsPerDay": "2",
"numberOfTransactionsPerDay": "5",
"numberOfTransactionsPerYear": "100",
"paymentAccountAge": "20181201",
"paymentAccountAgeIndicator": "05",
"shippingAddressUsage": "20181201",
"shippingAddressUsageIndicator": "04",
"shippingNameIndicator": "02",
"suspiciousAccountActivity": "02"
},
"cardholderInfo": {"addressMatchIndicator": "Y",
"billingAddress": {"city": "xxxxyyyyyoooonnnnnn",
"country": "392",
"addressLine1": "円山町１９−１",
"addressLine2": "渋谷プライムプラザ",
"addressLine3": "xxxxyyyyyoooonnnnnn",
"postalCode": "1680082",
"state": "01"
},
"cardholderName": "DATA ENUTEITEI",
"email": "sample_mail_address@nttdata.com",
"homePhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
},
"mobilePhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
},
"shippingAddress": {"city": "xxxxyyyyyoooonnnnnn",
"country": "392",
"addressLine1": "円山町１９−１",
"addressLine2": "渋谷プライムプラザ",
"addressLine3": "xxxxyyyyyoooonnnnnn",
"postalCode": "1680082",
"state": "01"
},
"workPhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
}
},
"instalmentPaymentDate": "10",
"merchantRiskIndicator": {"deliveryEmailAddress": "enuteitei@sample.co.jp",
"deliveryTimeframe": "04",
"giftCardAmount": "100000",
"giftCardCount": "02",
"giftCardCurrency": "392",
"preOrderDate": "20190711",
"preOrderPurchaseIndicator": "01",
"reorderItemsIndicator": "01",
"shippingIndicator": "03"
},
"messageCategory": "01",
"purchaseDate": "20190816160405",
"recurringExpiry": "20200831",
"recurringFrequency": "30",
"transactionType": "01"
}
}
}
}

Response samples

Content type

application/json

{"resultProperty": {"errorCode": "G12",
"accountMethod": {"accountMethodId": "01",
"isValid": true,
"paymentMethodId": "samplePaymentMethodId",
"property": {"maskedAccountNumber": "************0000",
"accountName": "test name",
"expiryDate": "0000"
}
},
"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"threeDSHTML": "<!DOCTYPE html><html><head><meta charset=\"UTF-8\"><title>ThreeDSMethodInit</title></head><body onload=\"window.location.href='https://simulator.test.3ds.com/api/v2/auth/brw/threeDsMethod?threeDSServerTransID=0dabae77-d947-4a98-96dd-23e922be5aaf'\"></body></html>",
"threeDSRedirectUrl": "https://dummy/dummy/threedsRedirectXXXXXXXXXXXXXXXXXXXXXXXXX",
"threeDSMerchantTransID": "550e8400-e29b-41d4-a716-446655440000",
"cardInfo": {"maskedAccountNumber": "************0000",
"expirationDate": "2107"
}
},
"status": "SUCCESS"
}

deleteCustomer

顧客情報を削除します。
※削除対象の顧客情報に紐づく決済手段情報を登録している場合、それらも全て削除されます。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

path Parameters

customerId

required

string

顧客ID
決済情報預かりを利用する際に、利用者を識別するために加盟店様側で採番したIDです。
createCustomerで登録済みの顧客IDを指定してください。
使用可能文字：半角英数字＋記号（-_）

Responses

Response samples

Content type

application/json

{"code": 401,
"message": "unauthorized"
}

registerAccountMethod

決済情報預かりの決済手段を登録します。
こちらのAPIを実行する前にcreateCustomerを実行する必要があります。

Creditの場合、こちらのAPIを実行する前にcreateTransactionTokenを実行する必要があります。
「決済手段登録（クレジットカード有効性確認有り3Dセキュア無し）」で有効性確認が失敗した場合は、カード情報は登録されません。
「決済手段登録（クレジットカード有効性確認有り3Dセキュア有り）」で、adviceAccountMethod内の有効性確認が失敗した場合は、カード情報は本サービスにて削除されます。
「決済手段登録（クレジットカード有効性確認有り3Dセキュア有り）」で、adviceAccountMethodが15分以上実施されない場合は、カード情報は本サービスにて任意のタイミングで削除されます。

Bank Payの場合、こちらのAPIを実行する前に口座登録リダイレクトAPIを実行する必要があります。詳細は口座登録リダイレクトAPIの詳細はBank Pay 口座登録リダイレクトを参照ください。
※Bank Pay用開発SDKを利用して口座登録される場合も同様に、事前の口座登録が必要です。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。
※１つの顧客IDに対して、券種ごとに以下の預かり上限を超えると429エラーが返却されます。

"Credit" - 1~10件
"Bank Pay" - 8件

path Parameters

customerId

required

string

顧客ID
決済情報預かりを利用する際に、利用者を識別するために加盟店様側で採番したIDです。
createCustomerで登録済みの顧客IDを指定してください。
使用可能文字：半角英数字＋記号（-_）

Request Body schema: application/json

One of

	object 有効性確認の設定値です。こちらの項目は各種決済手段固有の情報です。 ※有効性確認を利用する場合は設定 3Dセキュア認証が不要で有効性確認のみ実施する場合`{}`を入れてください。
	object 登録の設定値です。こちらの項目は各種決済手段固有の情報です。
paymentMethodId	string 登録する会員番号の決済手段ID 決済手段ごとに以下を設定してください。クレジットカード決済 - ”Credit” Bank Pay - ”BankPay” こちらのIDはlistPaymentMethodsからも取得できます。 ※何も指定しなかった場合"Credit"として扱われます。

Responses

Request samples

Payload

Content type

application/json

Example

CreditRegisterAccountRequest

{"verificationProperty": {"threeDSInfo": {"notificationUrl": "http://domain/authResult",
"authenticationData": {"authenticationIndicator": "01",
"authenticationInfo": {"authenticationData": "sample Requestor Authentication Data",
"authenticationMethod": "01",
"authenticationTimestamp": "201908161402"
},
"challengeIndicator": "01",
"accountType": "02",
"accountId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"accountInfo": {"cardholderAccountAgeIndicator": "03",
"cardholderAccountChange": "20190816",
"cardholderAccountChangeIndicator": "01",
"cardholderAccountDate": "",
"passwordChange": "20190816",
"passwordChangeIndicator": "02",
"purchaseCount": "10",
"numberOfProvisioningAttemptsPerDay": "2",
"numberOfTransactionsPerDay": "5",
"numberOfTransactionsPerYear": "100",
"paymentAccountAge": "20181201",
"paymentAccountAgeIndicator": "05",
"shippingAddressUsage": "20181201",
"shippingAddressUsageIndicator": "04",
"shippingNameIndicator": "02",
"suspiciousAccountActivity": "02"
},
"cardholderInfo": {"addressMatchIndicator": "Y",
"billingAddress": {"city": "xxxxyyyyyoooonnnnnn",
"country": "392",
"addressLine1": "円山町１９−１",
"addressLine2": "渋谷プライムプラザ",
"addressLine3": "xxxxyyyyyoooonnnnnn",
"postalCode": "1680082",
"state": "01"
},
"cardholderName": "DATA ENUTEITEI",
"email": "sample_mail_address@nttdata.com",
"homePhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
},
"mobilePhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
},
"shippingAddress": {"city": "xxxxyyyyyoooonnnnnn",
"country": "392",
"addressLine1": "円山町１９−１",
"addressLine2": "渋谷プライムプラザ",
"addressLine3": "xxxxyyyyyoooonnnnnn",
"postalCode": "1680082",
"state": "01"
},
"workPhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
}
},
"instalmentPaymentDate": "10",
"merchantRiskIndicator": {"deliveryEmailAddress": "enuteitei@sample.co.jp",
"deliveryTimeframe": "04",
"giftCardAmount": "100000",
"giftCardCount": "02",
"giftCardCurrency": "392",
"preOrderDate": "20190711",
"preOrderPurchaseIndicator": "01",
"reorderItemsIndicator": "01",
"shippingIndicator": "03"
},
"messageCategory": "01",
"purchaseDate": "20190816160405",
"recurringExpiry": "20200831",
"recurringFrequency": "30",
"transactionType": "01"
}
}
},
"registerProperty": {"token": "043a4f87-3b1b-497f-a9eb-d598010f4fc1"
},
"paymentMethodId": "Credit"
}

Response samples

Content type

application/json

Example

CreditRegisterAccountResponse

{"accountMethod": {"accountMethodId": "01",
"isValid": true,
"paymentMethodId": "samplePaymentMethodId",
"property": {"maskedAccountNumber": "************0000",
"accountName": "test name",
"expiryDate": "0000"
}
},
"resultProperty": {"errorCode": "G12",
"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"threeDSHTML": "<!DOCTYPE html><html><head><meta charset=\"UTF-8\"><title>ThreeDSMethodInit</title></head><body onload=\"window.location.href='https://simulator.test.3ds.com/api/v2/auth/brw/threeDsMethod?threeDSServerTransID=0dabae77-d947-4a98-96dd-23e922be5aaf'\"></body></html>",
"threeDSRedirectUrl": "https://dummy/dummy/threedsRedirectXXXXXXXXXXXXXXXXXXXXXXXXX'",
"threeDSMerchantTransID": "550e8400-e29b-41d4-a716-446655440000"
},
"status": "SUCCESS"
}

listAccountMethods

指定された顧客IDで登録している決済手段の一覧を取得します。
Response Schema以下の表の要素を持つオブジェクトの配列がaccountMethodIdの昇順で返却されます。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

path Parameters

customerId

required

string

顧客ID
決済情報預かりを利用する際に、利用者を識別するために加盟店様側で採番したIDです。
createCustomerで登録済みの顧客IDを指定してください。
使用可能文字：半角英数字＋記号（-_）

query Parameters

pageSize	integer <int32> [ 1 .. 100 ] 一度に返却するアイテム数 APIはこちらで指定した値より少ないアイテム数を返却する場合があります。指定しない場合と0を指定した場合、最大10個のアイテムが返却されます。 100を超える値は100に変換されます。負の値を指定すると、422が返却されます。
pageToken	string 前回こちらのAPIを呼び出した際にResponse Headersとして受信した値(`X-Next-Token`) こちらの項目を指定することで、前回取得したアイテムの次のアイテムから取得できます。

Responses

Response samples

Content type

application/json

[{"accountMethodId": "01",
"isValid": true,
"paymentMethodId": "samplePaymentMethodId",
"property": {"maskedAccountNumber": "************0000",
"accountName": "test name",
"expiryDate": "0000"
}
}
]

deleteAccountMethod

登録している決済手段を削除します。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

path Parameters

customerId required	string 顧客ID 決済情報預かりを利用する際に、利用者を識別するために加盟店様側で採番したIDです。 createCustomerで登録済みの顧客IDを指定してください。 `使用可能文字：半角英数字＋記号（-_）`
accountMethodId required	string 決済手段登録番号登録している決済手段を利用者ごとに識別するためのIDです。券種によらずcustomerIdごとに一意で、00~99のランダムな2桁の数字が本サービスによって採番されます。

Responses

Response samples

Content type

application/json

{"code": 401,
"message": "unauthorized"
}

adviceAccountMethod

登録している決済手段に対して追加処理を行う際に実施します。
「決済手段登録（クレジットカード有効性確認有り3Dセキュア有り）」で、adviceAccountMethod内の有効性確認が失敗した場合は、カード情報は本サービスにて削除されます。
「決済手段登録（クレジットカード有効性確認有り3Dセキュア有り）」で、adviceAccountMethodが15分以上実施されない場合は、カード情報は本サービスにて任意のタイミングで削除されます。

※クレジットカード決済の場合、3Dセキュアの有効性確認の際に使用します。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

path Parameters

customerId required	string 顧客ID 決済情報預かりを利用する際に、利用者を識別するために加盟店様側で採番したIDです。 createCustomerで登録済みの顧客IDを指定してください。 `使用可能文字：半角英数字＋記号（-_）`
accountMethodId required	string 決済手段登録番号登録している決済手段を利用者ごとに識別するためのIDです。券種によらずcustomerIdごとに一意で、00~99のランダムな2桁の数字が本サービスによって採番されます。

Request Body schema: application/json

One of

required

object

requestPropertyオブジェクト
こちらの項目は各種決済手段固有の情報です。

3DセキュアのnotificationUrlに通知される情報に通知された情報（以下、通知情報）を設定してください。

Responses

Request samples

Payload

Content type

application/json

{"requestProperty": {"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"threeDSResult": {"messageVersionNumber": "ABC0001!!",
"transactionStatus": "s",
"accountholderAuthenticationValue": "ABCDEFGHIJKLMNO0123456789!%&",
"electronicCommerceIndicator": "10",
"dsTransactionId": "ABCDEFGHIJKLMNOPQRSTUVW0123456789!%&",
"threeDSServerTransactionId": "ABCDEFGHIJKLMNOPQRSTUVW0123456789!%&"
}
}
}

Response samples

Content type

application/json

{"accountMethod": {"accountMethodId": "01",
"isValid": true,
"paymentMethodId": "samplePaymentMethodId",
"property": {"maskedAccountNumber": "************0000",
"accountName": "test name",
"expiryDate": "0000"
}
},
"resultProperty": {"errorCode": "G12"
},
"status": "SUCCESS"
}

updateAccountMethod

登録している決済手段を更新します。
クレジットカード登録時の有効性確認で3Dセキュア認証を有効にした場合は、adviceAccountMethodが実施されるまでの間このAPIは実施できません。
3Dセキュア認証ありの有効性確認を利用した場合は、後続でのadviceAccountMethod実施時の登録ステータスが成功の場合に決済手段が更新されます。
本APIによる有効性確認が失敗しても登録している決済手段の有効区分は無効になりません。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

path Parameters

customerId required	string 顧客ID 決済情報預かりを利用する際に、利用者を識別するために加盟店様側で採番したIDです。 createCustomerで登録済みの顧客IDを指定してください。 `使用可能文字：半角英数字＋記号（-_）`
accountMethodId required	string 決済手段登録番号登録している決済手段を利用者ごとに識別するためのIDです。券種によらずcustomerIdごとに一意で、00~99のランダムな2桁の数字が本サービスによって採番されます。

Request Body schema: application/json

One of

	object 更新の設定値です。
	object 有効性確認の設定値です。こちらの項目は各種決済手段固有の情報です。 ※有効性確認を利用する場合は設定 3Dセキュア認証が不要で有効性確認のみ実施する場合`{}`を入れてください。

Responses

Request samples

Payload

Content type

application/json

{"updateProperty": {"accountName": "test name",
"expiryDate": "0000"
},
"verificationProperty": {"threeDSInfo": {"notificationUrl": "http://domain/authResult",
"authenticationData": {"authenticationIndicator": "01",
"authenticationInfo": {"authenticationData": "sample Requestor Authentication Data",
"authenticationMethod": "01",
"authenticationTimestamp": "201908161402"
},
"challengeIndicator": "01",
"accountType": "02",
"accountId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"accountInfo": {"cardholderAccountAgeIndicator": "03",
"cardholderAccountChange": "20190816",
"cardholderAccountChangeIndicator": "01",
"cardholderAccountDate": "",
"passwordChange": "20190816",
"passwordChangeIndicator": "02",
"purchaseCount": "10",
"numberOfProvisioningAttemptsPerDay": "2",
"numberOfTransactionsPerDay": "5",
"numberOfTransactionsPerYear": "100",
"paymentAccountAge": "20181201",
"paymentAccountAgeIndicator": "05",
"shippingAddressUsage": "20181201",
"shippingAddressUsageIndicator": "04",
"shippingNameIndicator": "02",
"suspiciousAccountActivity": "02"
},
"cardholderInfo": {"addressMatchIndicator": "Y",
"billingAddress": {"city": "xxxxyyyyyoooonnnnnn",
"country": "392",
"addressLine1": "円山町１９−１",
"addressLine2": "渋谷プライムプラザ",
"addressLine3": "xxxxyyyyyoooonnnnnn",
"postalCode": "1680082",
"state": "01"
},
"cardholderName": "DATA ENUTEITEI",
"email": "sample_mail_address@nttdata.com",
"homePhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
},
"mobilePhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
},
"shippingAddress": {"city": "xxxxyyyyyoooonnnnnn",
"country": "392",
"addressLine1": "円山町１９−１",
"addressLine2": "渋谷プライムプラザ",
"addressLine3": "xxxxyyyyyoooonnnnnn",
"postalCode": "1680082",
"state": "01"
},
"workPhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
}
},
"instalmentPaymentDate": "10",
"merchantRiskIndicator": {"deliveryEmailAddress": "enuteitei@sample.co.jp",
"deliveryTimeframe": "04",
"giftCardAmount": "100000",
"giftCardCount": "02",
"giftCardCurrency": "392",
"preOrderDate": "20190711",
"preOrderPurchaseIndicator": "01",
"reorderItemsIndicator": "01",
"shippingIndicator": "03"
},
"messageCategory": "01",
"purchaseDate": "20190816160405",
"recurringExpiry": "20200831",
"recurringFrequency": "30",
"transactionType": "01"
}
}
}
}

Response samples

Content type

application/json

{"accountMethod": {"accountMethodId": "01",
"isValid": true,
"paymentMethodId": "samplePaymentMethodId",
"property": {"maskedAccountNumber": "************0000",
"accountName": "test name",
"expiryDate": "0000"
}
},
"resultProperty": {"errorCode": "G12",
"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"threeDSHTML": "<!DOCTYPE html><html><head><meta charset=\"UTF-8\"><title>ThreeDSMethodInit</title></head><body onload=\"window.location.href='https://simulator.test.3ds.com/api/v2/auth/brw/threeDsMethod?threeDSServerTransID=0dabae77-d947-4a98-96dd-23e922be5aaf'\"></body></html>",
"threeDSRedirectUrl": "https://dummy/dummy/threedsRedirectXXXXXXXXXXXXXXXXXXXXXXXXX'",
"threeDSMerchantTransID": "550e8400-e29b-41d4-a716-446655440000"
},
"status": "SUCCESS"
}

トークン発行API認証

トークン決済・決済情報預かりにおいて利用者が本サービスのAPIにアクセスするためのアクセストークンを払い出すエンドポイントです。トークン決済・決済情報預かりそれぞれの処理シーケンスの詳細はサービス仕様書の以下のページをご参照ください。

クレジットカード決済_トークン決済
クレジットカード決済_決済情報預かり

createEndUserAccessToken

利用者用のワンタイムのアクセストークンを生成します。
こちらのアクセストークンは一度だけ有効で、有効期限は30分です。
また、createTransactionTokenに使用されたものは有効期限内であっても無効化されます。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

Request Body schema: application/json

object

※空オブジェクト({})を設定してください。

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

{"token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQ...",
"expiresAt": "2021-02-03T15:16:17+09:00"
}

トークン発行

トークンを利用したクレジットカード決済を行うためのエンドポイントです。
処理シーケンスの詳細はサービス仕様書の以下のページをご参照ください。

クレジットカード決済_トークン決済

createTransactionToken

決済用ワンタイムトークンを生成します。
生成されたワンタイムトークンはトークン決済、決済情報預かりでのカード情報登録、セキュリティコードのトークン化、クレジットカード詳細情報取得に使用します。
トークン決済／決済情報預かりでのカード情報登録／セキュリティコードのトークン化に使用した場合、トークンは使用時点で無効化されます（有効期限内でも再利用不可）。
クレジットカード詳細情報取得に使用した場合のみ、トークンは無効化されず、有効期限内は他用途にも使用できます。
有効期限は発行から5分です。
createTransactionTokenは利用者のブラウザから直接アクセスされることを想定しています。実際に開発する際には JavaScriptの使用方法(JavaScriptによるトークンの取得)をご参照ください。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

header Parameters

object

createEndUserAccessTokenとauthからそれぞれ認証情報を取得する必要があります。

Request Body schema: application/json

accountNumber	string [ 14 .. 16 ] characters カード番号 ※トークン決済または決済情報預かりを利用する場合、必須項目
accountName	string [ 2 .. 30 ] characters カード名義使用可能文字：カード会員名で利用可能な英数字及び特殊文字
expiryDate	string = 4 characters 有効期限 ※トークン決済または決済情報預かりを利用する場合、必須項目 `使用可能文字：YYMM形式`
securityCode	string [ 3 .. 4 ] characters セキュリティコード ※セキュリティコードのトークン化を利用する場合、必須項目

Responses

Request samples

Payload

Content type

application/json

{"accountNumber": "0000000000000000",
"accountName": "test name",
"expiryDate": "0000",
"securityCode": "000"
}

Response samples

Content type

application/json

{"token": "043a4f87-3b1b-497f-a9eb-d598010f4fc1",
"expiresAt": "2021-10-12T11:11:57+09:00",
"maskedAccountNumber": "************0000"
}

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

カード会員番号を元にクレジットカード情報を取得するエンドポイントです。
カード会員番号を直接指定する以外に、決済情報預かりで登録した決済手段や決済用ワンタイムトークンを利用する判定も利用できます。
決済用ワンタイムトークンを利用した場合、決済用ワンタイムトークンは無効にならず再利用できます。

inquireCreditCard

クレジットカード詳細情報を取得します。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

Request Body schema: application/json

primaryAccountNumber	string [ 14 .. 16 ] characters カード会員番号 ※カード会員番号・預かり情報(顧客ID/決済手段登録番号)・トークンのいずれかは必須 `使用可能文字：半角数字`
customerId	string [ 1 .. 33 ] characters 顧客ID 決済情報預かりを利用する際に、利用者を識別するために加盟店様側で採番したIDです。 ※カード会員番号・預かり情報(顧客ID/決済手段登録番号)・トークンのいずれかは必須 `使用可能文字：半角英数字＋記号（-_）`
accountMethodId	string = 2 characters 会員番号登録により払い出された決済手段登録番号 ※カード会員番号・預かり情報(顧客ID/決済手段登録番号)・トークンのいずれかは必須 `使用可能文字：半角数字`
token	string 決済用ワンタイムトークン ※カード会員番号・預かり情報(顧客ID/決済手段登録番号)・トークンのいずれかは必須
paymentType	string = 2 characters Default: "10" 支払区分例えばリボ払い設定の場合は"80"を設定します。詳細は支払区分設定方法をご参照ください。

Responses

Request samples

Payload

Content type

application/json

{"primaryAccountNumber": "3540697499992567",
"customerId": "sampleCustomerId_01",
"accountMethodId": "01",
"token": "043a4f87-3b1b-497f-a9eb-d598010f4fc1",
"paymentType": "34"
}

Response samples

Content type

application/json

{"maskedAccountNumber": "000000******0000",
"receiveCompanyCode": "12345670001",
"brand": "Visa",
"cardType": "DEBIT",
"issuingCountry": "JAPAN",
"allianceInfo": {"allianceType": "10",
"merchantAttributeInfo": {"memberRank": "gold"
}
}
}

Amazon Pay住所・支払情報取得

Amazon Payで支払いが行われる際に、顧客の住所と支払い情報を取得するエンドポイントです。

getAmazonAccount

Amazonアカウントに登録されている住所・支払情報を取得します。
初回支払（オーソリ）完了時から30日間のみ取得可能です。
その他取得できる情報の条件については、Amazon Pay 住所・支払情報取得の補足をご確認ください。

path Parameters

checkoutSessionId

required

string

チェックアウトセッションID
利用者がAmazon Payを選択・ログイン後にリダイレクトされるURLに付加されます。
Amazon Payから利用者の住所や支払い情報を取得するために必要なIDです。
使用可能文字：半角英数字＋記号（-）

Responses

Response samples

Content type

application/json

{"shippingAddress": {"name": "TestName",
"addressLine1": "test address1",
"addressLine2": "test address2",
"addressLine3": "test address3",
"prefectures": "東京都",
"postalCode": "000-0000",
"phoneNumber": "000-0000-0000"
},
"paymentPreferences": [{"paymentDescriptor": "Visa ****1111 (Amazon Pay)"
}
],
"buyer": {"buyerId": "testID",
"name": "test name",
"email": "sample_mail_address@nttdata.com",
"phoneNumber": "000-0000-0000"
},
"billingAddress": {"name": "TestName",
"addressLine1": "test address1",
"addressLine2": "test address2",
"addressLine3": "test address3",
"prefectures": "東京都",
"postalCode": "000-0000",
"phoneNumber": "000-0000-0000"
},
"errorCode": "AMZ000"
}

Bank Pay固有操作

会員操作および口座操作を行うためのエンドポイントです。

listAvailableBanks

加盟店様ごとに使用できる金融機関の一覧を取得します。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

query Parameters

bankCode

string = 4 characters

Example: bankCode=0001

金融機関コード
指定した場合、指定された金融機関の情報のみを返却します。
使用可能文字：半角数字

Responses

Response samples

Content type

application/json

{"resultProperty": {"bankInfoList": [{"bankName": "株式会社xxx銀行",
"bankCode": "0001",
"termsOfUseUrl": "http://XXX"
}
]
},
"errorCode": "BP201"
}

getBankPayAuthInfo

口座登録リダイレクトAPIにアクセスするための認証情報を取得します。
※Bank Pay開発用SDKを利用して口座登録される場合も、本APIでの認証情報取得は必要です。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

path Parameters

customerId

required

string <= 33 characters

Example: sampleCustomerId_01

顧客ID
createCustomerで登録済みの顧客IDを指定してください。
使用可能文字：半角英数字＋記号（-_）

Responses

Response samples

Content type

application/json

{"resultProperty": {"cAccessToken": "sampleValue"
},
"errorCode": "BP201"
}

getBankAccountInputInfo

口座登録リダイレクトAPIによる口座登録時に入力する情報を取得します。
※Bank Pay開発用SDKを利用して口座登録される場合も、本APIでの口座登録入力情報取得は必要です。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

path Parameters

customerId required	string <= 33 characters Example: sampleCustomerId_01 顧客ID createCustomerで登録済みの顧客IDを指定してください。 `使用可能文字：半角英数字＋記号（-_）`
bankCode required	string = 4 characters Example: 0001 金融機関コード `使用可能文字：半角数字`

Responses

Response samples

Content type

application/json

{"resultProperty": {"bankCode": "0001",
"branchCodeFlag": true,
"depositTypeFlag": true,
"accountNumFlag": true,
"accountNameFlag": true
},
"errorCode": "BP201"
}

listRegisteredBankAccounts

登録済みのBank Pay口座情報を全件取得します。
加盟店様で口座登録リダイレクトAPIの結果をハンドリング出来なかった場合などは、こちらのAPIで決済事業者側の口座登録情報を取得して対応してください。
※Bank Pay開発用SDKを利用して口座登録される場合も、本APIでの情報取得は可能です。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

path Parameters

customerId

required

string <= 33 characters

Example: sampleCustomerId_01

顧客ID
createCustomerで登録済みの顧客IDを指定してください。
使用可能文字：半角英数字＋記号（-_）

Responses

Response samples

Content type

application/json

{"resultProperty": {"accountList": [{"bankpayAccountMethodId": "01",
"accountNum": "***0000",
"bankCode": "0001",
"branchCode": "001",
"depositType": "1",
"isValid": true,
"accountLabel": "口座ラベル",
"accountMethodId": "01"
}
]
},
"errorCode": "BP201"
}

changeRegisteredBankAccountStatus

Bank Payの決済手段登録情報に紐づく口座のステータスを変更します。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

path Parameters

customerId required	string <= 33 characters Example: sampleCustomerId_01 顧客ID createCustomerで登録済みの顧客IDを指定してください。 `使用可能文字：半角英数字＋記号（-_）`
accountMethodId required	string = 2 characters Example: 01 決済手段登録番号顧客IDに対してregisterAccountMethodで登録済みの、Bank Payの決済手段登録番号を指定してください。 `使用可能文字：半角数字`

Request Body schema: application/json

isValid

required

boolean

有効区分

有効 - ”true”
無効 - ”false”

こちらで設定した値は、listAccountMethodsとlistRegisteredBankAccountsのレスポンスに含まれるisValidに反映されます。

Responses

Request samples

Payload

Content type

application/json

{"isValid": true
}

Response samples

Content type

application/json

{"resultProperty": {"bankpayTransactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76g..."
},
"errorCode": "BP201"
}

getBankPaymentLimit

金融機関ごとの上限金額情報を取得します。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

query Parameters

bankCode required	string = 4 characters Example: bankCode=0001 金融機関コード `使用可能文字：半角数字`
category required	string = 1 characters Example: category=3 カテゴリ都度決済(非対面決済) - "3" チャージ(非対面決済)オープン - "5" チャージ(非対面決済)ハウス - "6" チャージ(非対面決済)資金移動 - "7" ※ご契約の内容に従って利用可能な値を設定してください。 `使用可能文字：半角数字`

Responses

Response samples

Content type

application/json

{"resultProperty": {"bankCode": "0001",
"bankLimitAmount": 9999999,
"bankLimitAmountDefault": 9999999,
"bankDailyLimitAmount": 99999999,
"bankDailyLimitAmountDefault": 99999999,
"processingDate": "1975-01-01 00:00:00",
"bankpayTransactionId": "sampleTransactionIdValue"
},
"errorCode": "BP201"
}

getAccountUsageAmount

会員の当日の利用金額情報を取得します。
※レスポンスのHTTPステータスコードについての詳細な説明や、4XX・5XXエラー時の詳細な説明についてはHTTPステータスコードをご確認ください。

path Parameters

customerId required	string <= 33 characters Example: sampleCustomerId_01 顧客ID createCustomerで登録済みの顧客IDを指定してください。 `使用可能文字：半角英数字＋記号（-_）`
accountMethodId required	string = 2 characters Example: 01 決済手段登録番号顧客IDに対してregisterAccountMethodで登録済みの、Bank Payの決済手段登録番号を指定してください。 `使用可能文字：半角数字`

query Parameters

Responses

Response samples

Content type

application/json

{"resultProperty": {"customerId": "sampleCustomerId_01",
"accountMethodId": "01",
"category": "3",
"useAmount": 1000,
"processingDate": "1975-01-01 00:00:00",
"bankpayTransactionId": "sampleTransactionIdValue"
},
"errorCode": "BP201"
}

NP後払い固有操作

NP後払いの固有操作を行うためのエンドポイントです。 NP後払い以外の取引ではご利用できません。

NPAtobaraiReissueInvoice

利用者に送付した請求書の再発行依頼を行います。１つの注文において、請求書の発行上限数は１０回までです。
電子バーコードでの請求書再発行発行依頼の場合も、同一メールアドレス宛ての場合はこちらのAPIを使用可能です。

path Parameters

transactionId

required

string

元取引のID
こちらのIDはpayTransactionのレスポンスと同じtransactionIdである必要があります。

Request Body schema: application/json

isRepeatConditions	boolean 前回条件で再送するかを設定できます。 `true`: 前回と同一の住所に請求書を再送します。 `false`: 今回設定した住所に請求書を再送します（今回設定の内容で完全な上書きをします）。 ※電子バーコードによる取引の再発行依頼についても、`true`を設定してください。 ※本項目が`true`の場合は、他項目（下記参照）は設定不要です。設定しても使用されません。 `postalCode` `address` `companyName` `department`
postalCode	string = 7 characters 郵便番号 `使用可能文字：半角数字` ※`isRepeatConditions`が`false`の場合は必須項目
address	string <= 55 characters 住所 `使用可能文字：全角半角文字` ※`isRepeatConditions`が`false`の場合は必須項目 ※郵便番号との関係性が一致しない場合、請求書再発行依頼が失敗します。API実行前にチェックをしてください。
companyName	string <= 30 characters 会社名 `使用可能文字：全角半角文字`
department	string <= 30 characters 部署名 `使用可能文字：全角半角文字`

Responses

Request samples

Payload

Content type

application/json

{"isRepeatConditions": false,
"postalCode": "1234567",
"address": "東京都千代田区永田町１丁目７－１",
"companyName": "（株）オムニペイメントゲートウェイ",
"department": "カスタマーサービス事業部"
}

Response samples

Content type

application/json

{"status": "SUCCESS",
"resultCode": 100,
"resultDescription": "正常に処理が終了しました",
"resultProperty": {"billIssuedDate": "2022-08-31",
"errorCode": "NP101"
}
}

べき等性の担保

Payment APIではrequestIdを設定することでべき等性を担保し、多重に取引されることなく、リクエストを安全に複数回再試行できます。たとえば、売上確定要求(captureTransaction)においてタイムアウトエラーが発生した場合、売上確定金額が1回だけ請求されることが保証された状態で、同じAPIの呼び出しの送信を安全に複数回再試行できます。

以下のAPIがrequestIdによるべき等性の担保に対応しています。

payTransaction
captureTransaction
cancelTransaction
refundTransaction
forceCancelTransaction
cancelUnresponsedTransaction
adviceTransaction
correctAmountTransaction

べき等性の担保の仕組み

多重に実行しても結果が変わることのない特性のことをべき等性といいます。

上記のAPIではリクエストにrequestIdを設定することで、その同一性によりべき等性を担保します。同一のAPIで同一のrequestIdとリクエストボディを持つリクエストは同一のリクエストとして処理し、多重に取引されることを防止します。
1回目の決済要求が本サービスに届いていた場合は、同一のrequestIdとリクエストボディをもつ決済要求に対して1回目の取引結果を返却します。
本サービスに届いていない場合は新規決済要求として処理します。
requestIdを変更した場合は新規決済として処理するため多重決済のリスクがあります。

加盟店様によるrequestIdの付与

requestIdは加盟店様で生成し、全てのAPI種別において決済グループ内（参考：決済グループ情報取得）で一意であることを担保いただく必要があります。 requestIdが同一で、かつ同じ決済グループを使用したリクエストの場合に同一のリクエストとみなしべき等性を担保するためです。なお、requestIdの使用可能文字と桁数制限は各APIのrequestIdに記載しており、その制限に従って設定していただく必要があります。ご確認ください。

HTTPステータスコード

1. HTTPステータスコード

本サービスで発生するHTTPステータスコードの詳細です。

HTTPステータスコード	説明
200 Expected response to a valid request	正常
200 A paged array of payment methods
200 A paged array of transactions
201 Expected response to a valid request
400 Bad Request	許可されていない"HTTP method"です。"HTTP method"をご確認の上、再度リクエストしてください。
401 Missing or invalid credentials	API認証情報が無効です。API認証情報(accessKey・accessSecret・auth/createEndUserAccessToken/createTransactionTokenで取得したtoken)をご確認の上、再度リクエストしてください。
404 Resource not found	getPaymentMethod	指定された決済手段が存在しません。`paymentMethodId`をご確認の上、再度リクエストしてください。
	inquireCreditCard	指定された決済手段登録番号と顧客IDの組が存在しません。`accountMethodId`と`customerId`の組み合わせをご確認の上、再度リクエストしてください。
	inquireCreditCard	指定されたカード番号が存在しません。カード番号をご確認の上、再度リクエストしてください。
	payTransaction	再支払（再オーソリ）の場合、元取引が存在しません。`relatedTransactionId`をご確認の上、再度リクエストしてください。
	captureTransaction	元取引が存在しません。`transactionId`をご確認の上、再度リクエストしてください。
	cancelTransaction
	refundTransaction
	forceCancelTransaction
	adviceTransaction
	correctAmountTransaction
	cancelUnresponsedTransaction	障害取消の対象取引が存在しません。`requestId`をご確認の上、再度リクエストしてください。/td>
	getTransaction	指定された取引が存在しません。`transactionId`をご確認の上、再度リクエストしてください。
	subscribeTransaction	指定された取引が存在しません。`transactionId`をご確認の上、再度リクエストしてください。
	getTransactionSummary	指定された取引サマリが存在しません。`baseTransactionId`をご確認の上、再度リクエストしてください。
	disableUrl	指定されたURLが存在しません。`urlId`をご確認の上、再度リクエストしてください。
	adviceAccountMethod	指定された取引が存在しません。`transactionId`をご確認の上、再度リクエストしてください。
	adviceAccountMethod	指定された決済手段登録番号と顧客IDの組が存在しません。`accountMethodId`と`customerId`の組み合わせをご確認の上、再度リクエストしてください。
	deleteCustomer	指定された顧客IDが存在しません。`customerId`をご確認の上、再度リクエストしてください。
	registerAccountMethod
	listAccountMethods
	verifyCustomer	指定された決済手段登録番号と顧客IDの組が存在しません。`accountMethodId`と`customerId`の組み合わせをご確認の上、再度リクエストしてください。
	deleteAccountMethod
	updateAccountMethod
	getBankAccountInputInfo	指定された顧客IDに対して、Bank Pay用の初回会員登録がされていません。`customerId`をご確認の上、再度リクエストしてください。
	listRegisteredBankAccounts
	changeRegisteredBankAccountStatus
	getAccountUsageAmount
	listAvailableBanks	使用可能な金融機関が存在しません。`bankCode`をご確認の上、再度リクエストしてください。
	getAmazonAccount	本APIを利用するために必要な加盟店情報が存在しません。加盟店ポータルなどで登録状況をご確認の上、再度リクエストしてください。
	許可されていない"HTTP method"です。"HTTP method"をご確認の上、再度リクエストしてください。
	エンドポイントが不正です。エンドポイントをご確認の上、再度リクエストしてください。
405 Method not allowed	許可されていない"HTTP method"です。"HTTP method"をご確認の上、再度リクエストしてください。
405 Method not allowed	エンドポイントが不正です。エンドポイントをご確認の上、再度リクエストしてください。
409 Request conflict	payTransaction	`requestId`が重複しています。(request内容が完全一致する場合を除きます)`requestId`をご確認の上、再度リクエストしてください。
	captureTransaction
	cancelTransaction
	refundTransaction
	forceCancelTransaction
	cancelUnresponsedTransaction
	adviceTransaction
	correctAmountTransaction
	createPaymentUrl	`requestId`が重複しています。`requestId`をご確認の上、再度リクエストしてください。
	createCustomer	顧客IDが重複しています。`customerId`をご確認の上、再度リクエストしてください。
	registerAccountMethod	クレジットの場合、1つの顧客IDに対して登録するカード番号が重複しています。すでに登録済のカード番号のため、再度登録いただく必要はない旨を利用者に案内してください。
412 Precondition failed	事前に必要な加盟店情報登録が不足しています。加盟店ポータルなどで登録状況をご確認の上、再度リクエストしてください。
412 Precondition failed	決済情報預かりの場合は、API実行できない状態である可能性があります。決済手段の登録状態をご確認ください。
415 Unsupported requests	"Content-type"ヘッダーが不正です。"Content-type"ヘッダーをご確認の上、再度リクエストしてください。
415 Unsupported requests	許可されていない"HTTP method"です。"HTTP method"をご確認の上、再度リクエストしてください。
422 Request validation error	リクエスト内容もしくは"X-Routing-Key"ヘッダーが不正です。リクエスト内容もしくは"X-Routing-Key"ヘッダーをご確認の上、再度リクエストしてください。
422 Request validation error	決済情報預かりの場合は、API実行できないAPI認証情報を指定している可能性があります。API認証情報をご確認の上、再度リクエストしてください。
429 Too Many Requests	1つの顧客IDに対する預かりの上限を超えています。券種ごとの預かり上限はregisterAccountMethodの説明をご確認ください。
4XX error	400番台のHTTPステータスコードが返却された場合はリクエスト内容の誤り、もしくは予期せぬエラーの可能性があります。一度リクエスト内容をご確認ください。リクエストの内容に誤りがない場合、下記の4XXエラー時のアクションをご参照ください。上記のHTTPステータスコードやそれ以外の400番台のHTTPステータスコードが返却されます。
5XX error	500番台のHTTPステータスコードが返却された場合はリクエスト内容の誤り、もしくは予期せぬエラーの可能性があります。一度リクエスト内容をご確認ください。リクエストの内容に誤りがない場合、下記の5XXエラー時のアクションをご参照ください。

2. 4XXエラー時のアクション

送信したリクエストは失敗しています。HTTPステータスコードを確認の上リクエストの内容を見直し、必要に応じて再度リクエストを送信してください。決済取引実行するAPI（例:payTransaction、captureTransaction）の場合、決済取引は実行されていないため障害取消の必要はありません。また、4XXエラーが返却された決済取引は取引情報取得のAPIや加盟店ポータルでの取引情報取得でも表示されません。

3. 5XXエラー時のアクション

加盟店様から見た場合、5XXエラーを受け取った際に送信したリクエストの結果の成否がその時点ではわかりません。 5XXエラー時の対応として同一のrequestId、HTTPリクエストボディで再送する方法がありますが、APIの種類・アクションによって方法が異なるため詳しくは下記の5XXエラー時における再送についてをご参照ください。また再送によるエラーの対応はサーバーの復旧状況によっては時間を要するため、顧客への伝達が十分に行えない可能性があります。
顧客への伝達を優先した際にpayTransactionやcancelTransactionなどの決済関連APIは、対応や顧客への回答が多岐に渡るため、以下に加盟店様が取りうるアクション例を記載いたします。必要に応じてご参照ください。以下のアクションはAPIを用いてシステム化可能です。加盟店ポータルを利用できるアクションについてはシステム化せずとも担当者の手運用で対応可能です。

API種別	条件		取りうるアクション
決済関連API	障害取消可能な券種/アクション(※1)		障害取消実行後(※2) 再度加盟店様から取引を実行または顧客に再度取引を依頼
	障害取消が可能ではない、または障害取消が失敗(※3)	5XXエラーとなったのが取引キャンセル/返金	取引が成功していることを顧客通知後、加盟店ポータルで該当決済を検索。(※4) 取引キャンセル/返金が存在し成功している場合：成功しているため、対応不要。取引キャンセル/返金が存在しない、または失敗の場合：加盟店ポータルにて取引キャンセル/返金を実行する、もしくはcancelTransactionやrefundTransactionなどを用いて取引を取り消す。行えない場合はシステム管理者に問い合わせください。
	障害取消が可能ではない、または障害取消が失敗(※3)	5XXエラーとなったのが取引キャンセル/返金ではない	取引が失敗していることを顧客通知後、加盟店ポータルで該当決済を検索。(※4) 取引が存在し成功している場合：加盟店ポータルにて取引キャンセル/返金を実行する、もしくはcancelTransactionやrefundTransactionなどを用いて取引を取り消す。行えない場合はシステム管理者に問い合わせください。取引が存在しない、または失敗の場合：顧客に決済失敗を通知しているため、対応不要。
決済以外のAPI	照会/トークン発行/URL発行などのAPI		再送をお願いします。
決済以外のAPI	登録や削除、ユーザ管理などのAPI		再送をお願いします。重複エラーが帰る場合は登録が完了していますが、必要に応じ照会をお願いします。

※1:決済手段によっては、障害取消がない代わりに同一取引の再送を推奨しているものもあります。詳細は各種決済手段のフローを参照ください。
※2:障害取消実行時のフローの詳細は各種決済手段のフローを参照ください。
※3:決済手段によっては障害取消の代替手段がある場合があります。詳細は各種決済手段を参照ください。また再送による対応も可能です。詳しくは下記の5XXエラー時における再送についてをご参照ください。
※4:getTransactionを用いても検索可能です。サーバーの状況によってはエラーが返る場合もあることがあります。

以下にpayTransaction時に5XXエラーとなった際の代表的なフロー図を記載いたしますので対応の参考にしてください。

5xxエラー時のフロー(paytran)

4. 5XXエラー時における再送について

決済関連APIであっても、
障害取消がない決済手段/取引種別で5XXエラーが発生したとき、
障害取消実施前に、まずは5XXエラーが発生した決済取引のリトライをしたいとき、
加盟店様は再送することも可能です。

再送した場合、一回目の取引で結果が出ていた場合、本サービスは一回目の取引の結果を応答します（再送した取引を元に再度決済を実施することはありません）。一回目の取引で結果が出ていなかった場合、本サービスは再送した取引をもとに決済を実行します。そのため、決済が二度行われることはありません。
ただし、再送の際にrequestId、HTTPリクエストボディを一回目の取引と同一のものに設定してください。特に、requestIdが異なる場合は二重決済のリスクがあるので注意してください。また、どのAPIもサーバーの状態によっては再リクエストの結果も5XXエラーが返却されることもあります。

詳しくはべき等性の担保をご参照ください。

resultCode

本サービスで発生する取引の結果コードの一覧です。

概要

結果コード	分類
0	不明
100	成功
1001~1999 11001~19999	リクエストチェックエラー
2001~4999 21001~49999	本サービス内部で発生したエラー
5001~5999 51001~59999	本サービス外部(決済事業者など)で発生したエラー
61001~69999	決済手段固有で発生する特殊なステータス

詳細

範囲	分類	決済手段	結果コード	結果説明文	障害取消要否
0	不明	ー	0	ー	ー
100	成功	ー	100	正常に処理が終了しました。	ー
1001~1999 11001~19999	リクエストチェックエラー	決済手段共通	1001	`paymentMethodId`が正しく設定されているか確認してください。問題が解決しない場合はシステム管理者にお問い合わせください。	不要
			1002	取引アクションが使用期間外です。問題が解決しない場合はシステム管理者にお問い合わせください。
			1003	`paymentMethodId`が正しく設定されているか確認してください。問題が解決しない場合はシステム管理者にお問い合わせください。
			1005	`paymentGroupId`が無効になっています。システム管理者にお問い合わせください。
		クレジットカード決済	1101	リクエスト不正エラーが発生したため、リクエスト内容を見直して再送してください。	不要
		PayPay	1201	リクエスト不正エラーが発生したため、リクエスト内容を見直して再送してください。	不要
		PayPay	1202	支払キャンセルの金額が決済要求時の金額と異なっています。決済要求時の金額と同額を設定したうえで、再度リクエストをしてください。	不要
		クレジットカード決済（3Dセキュア）	1301	リクエスト不正エラーが発生したため、リクエスト内容を見直して再送してください。	不要
		コンビニ決済(番号払い)	1501	リクエスト不正エラーが発生したため、リクエスト内容を見直して再送してください。	対応なし
			1502	元取引が存在しない、または既に入金済みの可能性がある取引であるため、処理を行うことができません。
			1503	支払キャンセルの金額が決済要求時の金額と異なっています。決済要求時の金額と同額を設定したうえで、再度リクエストをしてください。
		au PAY	1601	リクエスト不正エラーが発生したため、リクエスト内容を見直して再送してください。	対応なし
			1602	支払キャンセルの金額が決済要求時よりも上回っています。決済要求時の金額と同額もしくは低く設定した上で再度リクエストをしてください。
			1603	取引金額が適切ではありません。取引金額を変更したうえで再度リクエストをしてください。
			1604	返金の金額が決済時よりも上回っています。決済時の金額と同額もしくは低く設定した上で再度リクエストをしてください。
			1605	対象の取引に対するリクエストが不正です。再支払（再オーソリ）を行う場合はcaptureNowをfalseに設定してください。
		d払い	1701	リクエスト不正エラーが発生したため、リクエスト内容を見直して再送してください。	不要
		Amazon Pay	1801	リクエスト不正エラーが発生したため、リクエスト内容を見直して再送してください。	対応なし
		楽天ペイ（オンライン決済）	1901	リクエスト不正エラーが発生したため、リクエスト内容を見直して再送してください。	不要
		銀行ネット決済	11001	リクエスト不正エラーが発生したため、リクエスト内容を見直して再送してください。	対応なし
		Bank Pay	11101	リクエスト不正エラーが発生したため、リクエスト内容を見直して再送してください。	不要
		Bank Pay	11102	整合性エラーが発生したため、リクエスト内容を見直して再送してください。	不要
		NP後払い	11201	リクエスト不正エラー（単項目エラー）が発生したため、リクエスト内容を見直して再送してください。	対応なし
		NP後払い	11202	リクエスト不正エラー（整合性エラー）が発生したため、リクエスト内容を見直して再送してください。	対応なし
2001~4999 21101~49999	本サービス内部で発生したエラー	決済手段共通	2001	登録情報が不正であるため、システム管理者へお問い合わせください。	不要
		クレジットカード決済	2101	決済事業者への接続時にエラーが発生したため再度リクエストをしてください。	不要
		PayPay	2201	QRコードによる支払が一定時間以内に行われませんでした。必要に応じて再度リクエストをしてください。	不要
		PayPay	2202	処理中にエラーが発生したため、再度リクエストをしてください。解消しない場合はシステム管理者へお問い合わせください。	不要
		クレジットカード決済（3Dセキュア）	2301	処理中にエラーが発生したため、再度リクエストをしてください。解消しない場合はシステム管理者へお問い合わせください。	不要
			2302	決済事業者への接続時にエラーが発生したため、再度リクエストをしてください。
			2303	登録情報が不正であるため、システム管理者へお問い合わせください。
		コンビニ決済(番号払い)	2501	登録情報が不正であるため、システム管理者へお問い合わせください。	対応なし
		コンビニ決済(番号払い)	2502	払込番号による支払が一定時間以内に行われませんでした。必要に応じて再度リクエストをしてください。	対応なし
		au PAY	2601	決済事業者への接続前にエラーが発生したため、再度リクエストをしてください。解消しない場合はシステム管理者へお問い合わせください。	対応なし
			2603	決済事業者への接続後にエラーが発生したため、再度リクエストをしてください。解消しない場合はシステム管理者へお問い合わせください。
			2604	決済事業者への接続後にエラーが発生したため、管理者へお問い合わせください。
			2605	登録情報が不正であるため、システム管理者へお問い合わせください。
			2606	全額支払キャンセル、または全額返金済みの取引に対して売上確定処理は行えません。リクエスト内容を見直した上で再送してください。
			2607	全額支払キャンセル済みの取引に対して支払キャンセル処理は行えません。リクエスト内容を見直した上で再送してください。
			2608	全額返金済みの取引に対して返金処理は行えません。リクエスト内容を見直した上で再送してください。
			2609	対象の取引に対するリクエストが不正です。対象のリクエストを正しく設定した上で再送してください。
			2610	取引期限を過ぎています。期限を過ぎた取引に対しては処理が行えません。
		d払い	2701	決済事業者への接続時にエラーが発生したため再度リクエストをしてください。	不要
		Amazon Pay	2801	処理中にエラーが発生しました。時間をおいて再送してください。解消しない場合はシステム管理者にお問い合わせください。	対応なし
		Amazon Pay	2802	処理中にエラーが発生したため、システム管理者へお問い合わせください。	対応なし
		楽天ペイ（オンライン決済）	2901	処理中にエラーが発生したため、システム管理者へお問い合わせください。	不要
		クレジットカード決済	3101	決済事業者への接続後にエラーが発生したため障害取消を実施したうえで、再度リクエストをしてください。	必要
		クレジットカード決済	3102	決済事業者への接続後にエラーが発生したため障害取消を実施したうえで、再度リクエストをしてください。	必要
		d払い	3701	決済事業者への接続後にエラーが発生したため障害取消を実施したうえで、再度リクエストをしてください。	必要
		PayPay	4201	決済事業者への接続後にエラーが発生したため障害取消を実施したうえで、再度リクエストをしてください。解消しない場合はシステム管理者へお問い合わせください。PayPayは支払の場合のみ障害取消が必要です。	支払時のみ必要
		コンビニ決済(番号払い)	4501	決済事業者への接続後にエラーが発生したため、システム管理者へお問い合わせください。	対応なし
		楽天ペイ（オンライン決済）	4901	決済事業者への接続後にエラーが発生したため障害取消を実施したうえで、再度リクエストをしてください。解消しない場合はシステム管理者へお問い合わせください。	必要
		銀行ネット決済	21001	処理中にエラーが発生しました。時間をおいて再送してください。解消しない場合はシステム管理者にお問い合わせください。	対応なし
		銀行ネット決済	21002	処理中にエラーが発生したため、システム管理者へお問い合わせください。	対応なし
		Bank Pay	21101	決済事業者への接続前にエラーが発生したため再度リクエストをしてください。解消しない場合はシステム管理者へお問い合わせください。	不要
		Bank Pay	31101	決済事業者への接続後にエラーが発生しました。payTransaction実行時に本resultCodeが返却された場合、障害取消を実施したうえで、再度リクエストをしてください。それ以外の場合は、再度リクエストしてください。また、解消しない場合はシステム管理者へお問い合わせください。	必要
		NP後払い	21201	Omniサービスの内部システムエラーが発生しました。再度リクエストを実施してください。解消しない場合はシステム管理者へお問い合わせください。	対応なし
5001~5999 51001~59999	本サービス外部 (決済事業者など) で発生したエラー	クレジットカード決済	5102	決済事業者に取引要求を拒否されました。リクエスト内容を見直して再送してください。	不要
		PayPay	5201	登録情報が不正であるため、システム管理者へお問い合わせください。	不要
			5202	決済事業者への接続後にエラーが発生したため、システム管理者へお問い合わせください。
			5203
			5290
			5204	決済事業者への接続後にエラーが発生したため障害取消を実施したうえで、再度リクエストをしてください。 PayPayは支払の場合のみ障害取消が必要です。	支払時のみ必要
			5205
			5206
			5207
			5208	決済事業者への接続後にエラーが発生したため障害取消を実施したうえで、システム管理者に問い合わせてください。 PayPayは支払の場合のみ障害取消が必要です。
			5209	決済事業者へ一定の時間内に大量のリクエストを送信したことによるエラーが発生したため障害取消を実施したうえで、リクエスト数を絞って再送信してください。PayPayは支払の場合のみ障害取消が必要です。
			5210	決済事業者への接続後にエラーが発生したため障害取消を実施したうえで、障害復旧後に再送信してください。PayPayは支払の場合のみ障害取消が必要です。
			5211	決済事業者への接続後にエラーが発生したため障害取消を実施したうえで、再度リクエストをしてください。PayPayは支払の場合のみ障害取消が必要です。
			5212	決済事業者への接続後にエラーが発生したため障害取消を実施したうえで、障害復旧後に再送信してください。PayPayは支払の場合のみ障害取消が必要です。
			5213	決済事業者への接続後にエラーが発生したため障害取消を実施したうえで、再度リクエストをしてください。PayPayは支払の場合のみ障害取消が必要です。
			5214	ただいま決済事業者がメンテナンスをしております。しばらく時間をおいてから、再度お試しください。	不要
			5215	増額売上確定が利用者に承認されませんでした。必要に応じて再度リクエストをしてください。
			5216	ユーザーが無効な状態です。
			5217	ユーザーの支払上限額を超過しました。
			5218	指定された取引は既に決済が完了しています。
			5219	有効期限が超過しています。
			5220	指定された処理が実施できませんでした。必要に応じてシステム管理者へお問い合わせください。
			5221	処理中にエラーが発生しました。リクエスト内容を見直して再送してください。
			5222	ユーザーの残高が不足しているため、処理が実施できませんでした。
			5223	返金の最大数に達しているため、処理が実施できませんでした。システム管理者へお問い合わせください。
			5224	障害取消では返金処理は行われません。しばらく時間をおいてから返金を実施してください。
		コンビニ決済(番号払い)	5501	決済事業者に取引要求を拒否されました。エラーコードの内容をご確認ください。	対応なし
		au PAY	5601	決済事業者にて決済処理中のため情報が取得できませんでした。しばらく時間をおいてから、再度お試しください。	対応なし
			5602	決済事業者への接続後にエラーが発生したため、システム管理者へお問い合わせください。
			5603	ただいま決済事業者がメンテナンスをしております。しばらく時間をおいてから、再度お試しください。
			5604	決済事業者への接続後にエラーが発生したため、システム管理者へお問い合わせください。
			5605	決済事業者への接続後にエラーが発生したため、再度リクエストをしてください。
			5606	ただいま決済事業者がメンテナンスをしております。しばらく時間をおいてから、再度お試しください。
			5607	決済事業者にて決済処理がエラーとなりました。QRコードの期限が切れた為、再度支払（オーソリ）からやり直してください。
			5608	決済事業者にて決済処理がエラーとなりました。利用者が1日の利用限度額を超過した支払いを行いました。
		d払い	5701	決済事業者に取引要求を拒否されました。リクエスト内容を見直して再送してください。	不要
		Amazon Pay	5801	決済事業者に取引要求を拒否されました。エラーコードを確認した上で、各種の対応を実施してください。	対応なし
		楽天ペイ（オンライン決済）	5901	決済事業者への接続後にエラーが発生したため、システム管理者へお問い合わせください。	不要
		Bank Pay	51101	決済事業者への接続時にエラーが発生しました。errorCode(結果詳細コード)をご参照の上、再度リクエストをしてください。解消しない場合はシステム管理者へお問い合わせください。	不要
			51102	決済事業者への接続時にエラーが発生したため再度リクエストをしてください。解消しない場合はシステム管理者へお問い合わせください。	不要
			51103	決済事業者への接続時にエラーが発生しました。payTransaction実行時に本resultCodeが返却された場合、障害取消を実施したうえで、再度リクエストをしてください。それ以外の場合は、再度リクエストしてください。また、解消しない場合はシステム管理者へお問い合わせください。	必要
			51104	ご利用の金融機関においてエラーが発生しました。errorCode(結果詳細コード)をご参照の上、再度リクエストをしてください。解消しない場合はシステム管理者へお問い合わせください。	不要
		NP後払い	51201	決済事業者との通信でエラーが発生しました。再度リクエストを実施してください。解消しない場合はシステム管理者へお問い合わせください。	対応なし
			51202	決済事業者システムでシステムエラーが発生しました。再度リクエストを実施してください。解消しない場合はシステム管理者へお問い合わせください。
			51203	決済事業者システムがメンテナンス等で現在利用不可です。しばらく時間をおいてから、再度お試しください。
			51204	決済事業者システムでタイムアウトが発生しました。再度リクエストを実施してください。解消しない場合はシステム管理者へお問い合わせください。
			51205	決済事業者システムで予期せぬリクエスト不正を検知しました。本メッセージに記載のコード内容を、システム管理者へお問い合わせください。
			51206	決済事業者において審査の結果、与信がNGとなりました。結果詳細コード確認してください。
6001~6999 61001~61999	決済手段固有で発生する特殊なステータス	銀行ネット決済	61001	支払期限日時までに支払い（消込）が行われなかったため、取引が無効になりました。	対応なし

使用可能文字

本サービスおける使用可能文字の詳細です。

各API項目の制限欄に記載があるものの定義は以下の通りです。

型	使用可能文字
全角半角文字	UTF-8で使用できる文字（※1）
ULID	詳細は以下をご参照ください。 https://github.com/ulid/spec
半角数字	0123456789
半角英字	ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz
半角記号①	! " # $ % & ' ( ) * + , - . @ [ ] ^ _ ` { } ~ 縦棒
半角記号②	\ , . ( ) - / * ｢｣ $ + & 半角スペース
全角文字	UTF-8で使用できる全角文字（※1）
全角英字	ＡＢＣＤＥＦＧＨＩＪＫＬＭＮＯＰＱＲＳＴＵＶＷＸＹＺａｂｃｄｅｆｇｈｉｊｋｌｍｎｏｐｑｒｓｔｕｖｗｘｙｚ
半角英数字	ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz 0123456789
半角カナ	ｱｲｳｴｵｶｷｸｹｺｻｼｽｾｿﾀﾁﾂﾃﾄﾅﾆﾇﾈﾉﾊﾋﾌﾍﾎﾏﾐﾑﾒﾓﾔﾕﾖﾗﾘﾙﾚﾛﾜｦﾝｧｨｩｪｫｯｬｭｮﾞﾟ

※1 NP後払いについては併せて、「NP後払い別紙」も参照ください。

マスキング詳細

本サービスにおけるマスキング仕様の詳細です。

requestProperty

取引情報を取得した際のrequestPropertyは以下のようにマスキングされます。

決済手段	マスク項目	マスク詳細
クレジットカード決済	cardInfo.primaryAccountNumber	上6桁下4桁表示例：123456******1234
	cardInfo.accountName	`[MASKED]`に置き換え
	cardInfo.expirationDate	`[MASKED]` に置き換え
	cardInfo.securityCode	項目自体返却せず
	cardInfo.token	`[MASKED]` に置き換え
	threeDSInfo.authenticationData.accountId	`[MASKED]` に置き換え
	threeDSInfo.authenticationData.cardholderInfo	`[MASKED]` に置き換え ※string型に変更
	threeDSInfo.authenticationData.merchantRiskIndicator.deliveryEmailAddress	`[MASKED]` に置き換え
コンビニ決済	customerInfo.telephoneNumber	`[MASKED]` に置き換え
	customerInfo.emailAddress	`[MASKED]` に置き換え
	customerInfo.firstName	`[MASKED]` に置き換え
	customerInfo.lastName	`[MASKED]` に置き換え
銀行ネット決済	userName	`[MASKED]` に置き換え
	userName	`[MASKED]` に置き換え
	userNameKana	`[MASKED]` に置き換え
	firstName	`[MASKED]` に置き換え
	lastName	`[MASKED]` に置き換え
	firstNameKana	`[MASKED]` に置き換え
	lastNameKana	`[MASKED]` に置き換え
NP後払い	customer.name	`[MASKED]` に置き換え
	customer.nameKana	`[MASKED]` に置き換え
	*customer.companyName	`[MASKED]` に置き換え
	*customer.department	`[MASKED]` に置き換え
	*customer.postalCode	`[MASKED]` に置き換え
	*customer.address	`[MASKED]` に置き換え
	customer.telephoneNumber	`[MASKED]` に置き換え
	customer.emailAddress	`[MASKED]` に置き換え
	customer.terminalId	`[MASKED]` に置き換え
	customer.terminalInfo	`[MASKED]` に置き換え
	customer.ipAddress	`[MASKED]` に置き換え
	customer.userAgent	`[MASKED]` に置き換え
	destCustomer.name	`[MASKED]` に置き換え
	destCustomer.nameKana	`[MASKED]` に置き換え
	destCustomer.companyName	`[MASKED]` に置き換え
	destCustomer.department	`[MASKED]` に置き換え
	destCustomer.postalCode	`[MASKED]` に置き換え
	destCustomer.address	`[MASKED]` に置き換え
	destCustomer.telephoneNumber	`[MASKED]` に置き換え
	items	`[MASKED]` に置き換え
	postalCode	`[MASKED]` に置き換え
	address	`[MASKED]` に置き換え
	companyName	`[MASKED]` に置き換え
	department	`[MASKED]` に置き換え

クレジットカード決済詳細

1. クレジットカード決済エラーコード一覧

リクエスト項目チェックエラー

主にrequestPropertyやクレジットカード固有の制限がある項目が正しく設定されていない場合に発生するエラーです。こちらのエラーが発生した場合はリクエスト内容を見直してください。詳細は各項目の説明をご参照ください。

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
1101	I008	`creditTerminalIdentifier`（端末識別番号）の項目に対しての入力チェックエラーが発生した
	I014	`receiveCompanyCode`（被仕向会社コード）の項目に対しての入力チェックエラーが発生した（提携カード判定利用の場合にカード会員番号から接続先アクワイアラを特定できなかった場合にも発生します）
	I015	`primaryAccountNumber`（カード会員番号）の項目に対しての入力チェックエラーが発生した
	I016	`expirationDate`（カード有効期限）の項目に対しての入力チェックエラーが発生した
	I019	`productCode`（商品コード）の項目に対しての入力チェックエラーが発生した
	I020	`amount.value`（取引金額）の項目に対しての入力チェックエラーが発生した
	I023	`paymentType`（支払区分）の項目に対しての入力チェックエラーが発生した
	I030	`terminalProcessingSerialNumber`（端末処理通番）の項目に対しての入力チェックエラーが発生した
	I031	`securityCode`（セキュリティコード）の項目に対しての入力チェックエラーが発生した
	I032	`ElectronicCommerceIndicator`（3Dセキュア項目）の項目に対しての入力チェックエラーが発生した
	I035	`TransactionStatus`（3Dセキュア項目）の項目に対しての入力チェックエラーが発生した
	I036	`MessageVersionNumber`（3Dセキュア項目）の項目に対しての入力チェックエラーが発生した
	I039	`firstPaymentMonth`（支払開始月）の項目に対しての入力チェックエラーが発生した
	I040	`numberOfInstallmentPayments`（分割回数）の項目に対しての入力チェックエラーが発生した
	I041	`installmentPaymentAmount[]`（分割金額）の項目に対しての入力チェックエラーが発生した
	I042	`firstPaymentAmount`（初回金額）の項目に対しての入力チェックエラーが発生した
	I047	`merchantCategoryCode`（加盟店分類コード）の項目に対しての入力チェックエラーが発生した
	I049	`DSTransactionID`（3Dセキュア項目）の項目に対しての入力チェックエラーが発生した
	I050	`ThreeDSServerTransactionID`（3Dセキュア項目）の項目に対しての入力チェックエラーが発生した
	I052	`AccountholderAuthenticationValue`（3Dセキュア項目）の項目に対しての入力チェックエラーが発生した
	I065	`amount.currencyCode`（通貨コード）の項目に対しての入力チェックエラーが発生した
	I077	`settleUnitID`（精算単位ID）の項目に対しての入力チェックエラーが発生した
	I079	`primaryAccountNumber`（カード会員番号）、`token`(トークン)を複数投入した場合（カード会員番号の解決方法を特定できません）の項目に対しての入力チェックエラーが発生した
	I080	`token`（トークン）の項目に対しての入力チェックエラーが発生した
	I081	`customerId`(顧客ID) もしくは`accountMethodId`(決済手段登録番号)の項目に対しての入力チェックエラーが発生した
	I105	`TransactionStatus`（3Dセキュア項目）が、登録されたセキュリティレベルの基準を満たさない
	I110	不正利用の疑いがあるため取引が拒否された ※本コードはクレジットマスターブロック機能を利用した場合に限り発行される可能性があるコードです。詳細はお問い合わせください。
	I111	ボーナス払い期間外のため取引が拒否された
	IA001	`endbeneficiaryName`（エンドベネフィシャリー名）の項目に対しての入力チェックエラーが発生した
	IA002	`endbeneficiaryStreet`（エンドベネフィシャリー住所）の項目に対しての入力チェックエラーが発生した
	IA003	`endbeneficiaryCity`（エンドベネフィシャリー都道府県）の項目に対しての入力チェックエラーが発生した
	IA004	`cardAcceptorPostalCode`（郵便番号）の項目に対しての入力チェックエラーが発生した
	IA005	`sellerId`（セラーID）の項目に対しての入力チェックエラーが発生した
	IA006	`sellerEmailAddress`（販売者メールアドレス）の項目に対しての入力チェックエラーが発生した
	IA007	`sellerTelephone`（販売者電話）の項目に対しての入力チェックエラーが発生した
	IA008	`merchantContactInformation`（加盟店連絡先情報）の項目に対しての入力チェックエラーが発生した
	IA009	`cardAcceptorBusinessCode`（カードアクセプタビジネスコード）の項目に対しての入力チェックエラーが発生した

各種サービス契約項目チェックエラー

対応していない機能の項目を利用しようとした場合の入力チェックエラーです。ご利用内容を確認の上、項目を見直してください。

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
1101	I301	セキュリティコード中継利用フラグ=falseかつ`securityCode`(セキュリティコード)を設定した場合
	I302	決済情報預かり利用フラグ=falseかつ`customerId`(顧客ID)か`accountMethodId`(決済手段登録番号)のいずれかを設定した場合
	I303	トークン決済利用フラグ=falseかつ`token`(トークン)を設定した場合
	I304	3Dセキュア認証利用フラグ=falseかつ`threeDSInfo`(3Dセキュア項目)を設定した場合
	I305	提携カード判定利用フラグ=falseかつ`receiveCompanyCode`(被仕向会社コード)が未指定の場合
	I306	使用可能期間外のブランドのクレジットカードを利用した場合
	I308	3Dセキュア認証必須フラグ=trueかつ`threeDSInfo`(3Dセキュア項目)が未指定の場合
	I309	ブランドトークン決済失敗時の決済中断フラグ=trueかつブランドトークン決済が失敗した場合
	I310	B2B決済において対応業務外の業務を実行しようとした

現取引と過去取引との整合性チェックエラー

実施したアクションにおいて、元取引の状態との整合性がとれない場合に発生するエラーです。実施したアクションと元取引の状態を再度見直してください。

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
1101	I401	引当出来ないアクションに関連する取引のIDを指定した
	I402	引当必須のアクションで関連する取引のIDが指定されなかった
	I403	正常終了してない電文を引当対象にしようとした
	I404	支払キャンセル、再支払、売上確定で、支払以外の引き当て元を指定しようとした
	I405	返金で、（確定後の）支払／同時売上以外の引き当て元を指定しようとした
	I407	売上確定済のデータに支払キャンセル、再支払を実施した
	I408	売上未確定のデータに返金を実施した
	I409	支払（オーソリ）した金額以上に支払キャンセルを実施した
	I410	支払（オーソリ）した金額以上に売上確定を実施したもしくは既に売上確定済みの取引に対して再度売上確定を実施した
	I411	売上確定額を越えた支払キャンセル／返金を実施した
	I412	障害取消不要な取引に対して障害取消をしようとした
	I417	会員番号解決手段（カード会員番号、トークンまたは顧客ID・決済手段登録番号）が指定されていなかった
	I418	会員番号解決手段（カード会員番号、トークンまたは顧客ID・決済手段登録番号）が複数指定された
	I419	引当に指定した取引が存在しなかった
	I420	支払キャンセル、再支払を実施した取引で、一部売上確定を実施した
	I422	金額の変更がない再支払を実施した
	I424	売上データ作成済みの取引に対して、障害取消を実施しようとした
	I426	金額補正処理中にエラーが発生したため、システム管理者へお問い合わせください
	I427	金額補正処理中にエラーが発生したため、システム管理者へお問い合わせください
	I428	取消済みの取引に対して、取引を実施しようとした
	I429	`captureTransaction`が`payTransaction`発行後の受付可能な期間を超過した
	I431	無効なトークンを設定した
	I432	決済情報預かりでクレジットカードの預かり情報が存在しなかった
	I433	決済情報預かり契約なし
	I434	決済情報預かりで無効なクレジットカードの預かり情報を指定した
	I451	`adviceTransaction`で指定した`payTransaction`が存在しない
	I452	`adviceTransaction`で指定した`payTransaction`が入力チェックエラー
	I453	`adviceTransaction`で指定した`payTransaction`に3Dセキュアが設定されてない
	I454	`adviceTransaction`で指定した`payTransaction`が処理済
	I455	`adviceTransaction`が`payTransaction`発行後の受付可能な時間を超過した
	I456	引当（支払キャンセル、返金、再支払）、障害取消で`payTransaction`が未完了

その他エラー

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
1101	I101	クレジットカード決済で未使用のアクションで連携された
1101	I104	既に実施済の取引のIDが連携されてきたまたは、前の処理が終わってない
2101	I207	既に取消済みの取引
	I208	CAFIS空経路なし（※1）
	I209	CAFIS接続エラー
	I213	取消時の元取引未存在エラー
	I900	Omni Processor-Credit内部エラー（CAFIS到達前）（※2）
3101	I901	Omni Processor-Credit内部エラー（CAFIS到達後）（※3）
3102	I210	CAFIS接続タイムアウト

※1 カード会社との接続に必要な経路がすべて使用中のため、新規の取引を中継できない
※2 カード会社中継処理前に、本サービスセンター内で内部エラーを検知
※3 カード会社中継処理後に、本サービスセンター内で内部エラーを検知

CAFIS送信中エラー（CXX）

CAFIS送信中に発生したエラーです。こちらのエラーが発生した場合は各チェック内容を参照し、時間をおいて再度送信してください。解決しない場合はシステム管理者にお問い合わせください。

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
5102	C01	リクエストの`receiveCompanyCode`（被仕向会社コード）がCAFISセンタに登録されていない
	C03	リクエストの電文長が規定値を超えている
	C12	被仕向センタの経路が全て使用中
	C13	被仕向センタが障害中
	C14	被仕向センタが終了している
	C15	CAFISセンタのオンラインが終了している
	C17	接続手順で許容されているエンコード種別を設定していない（例）エンコード種別＝１（Base64）の時、Base64で規定されている文字以外を使用した
	C33	CAFISが輻輳している
	C34	加盟店ショッピング業務のフォーマットが正しくない
	C35	アドバイス電文に対する支払キャンセル確認（再）指令受信時、元取引に対するアドバイス電文処理が正常に完了している
	C50	CAFISセンタでタイムアウトを検出した
	C51	使用中の仕向経路で再度電文を受信した
	C53	仕向会社コードが受信した会社と異なる
	C54	CAFISセンタのサービス対象外の電文種別を受信した
	C55	当該仕向センタで保有する経路範囲外
	C56	保障項目が保証されていない
	C57	当該被仕向センタで対センタ間サービスを行っていない
	C58	ニューメリックチェックでエラーとなった
	C60	受信不可能状態で電文を受信した（個別終了中、障害中のセンタからリクエストを受信した）

決済事業者エラー（GXX)

決済事業者からのエラー応答です。こちらのエラーが発生した場合は各チェック内容を参照し、リクエスト内容を再度見直してください。
解決しない場合はシステム管理者にお問い合わせください。
※ 本表で指定しているerrorCode(結果詳細コード)はあくまでも設定例です。設定するカード会社によっては、本表と設定内容が異なる場合があります。

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
5102	G02	カード残高が不足している
	G03	カード限度額を超えている
	G04	カード残高が不足している
	G05	カード限度額を超えている
	G06	デビットカードで口座の残高が不足している
	G07	カード限度額を超えている
	G12	カードが使用不可
	G22	カードが使用不可
	G30	取引の判定が保留と見なされた（有人判定）
	G42	お客様の入力した暗証番号が誤っている
	G43	誤入力許容回数オーバー
	G44	セキュリティコードが正しくない
	G45	セキュリティコードの入力が行なわれていない
	G46	JIS2面情報が正しく設定されていない
	G54	1日の利用回数または金額をオーバーしている
	G55	1日の利用限度額をオーバーしている
	G56	無効カードが使用され、カードの取り込みが必要
	G60	事故カードが使用された
	G61	無効カードが使用された
	G65	会員番号の入力が誤っている
	G67	商品コードの入力が誤っている
	G68	金額の入力が誤っている
	G69	税・その他の入力が誤っている
	G70	ボーナス回数の入力が誤っている
	G71	ボーナス月の入力が誤っている
	G72	ボーナス額の入力が誤っている
	G73	支払開始月が誤っている
	G74	分割回数が誤っている
	G75	分割払いの下限額を下回っている
	G76	初回金額が誤っている
	G77	業務区分が誤っている
	G78	支払方法が誤っている
	G79	照会区分が誤っている
	G80	取消区分が誤っている
	G81	取扱区分が誤っている
	G83	有効期限切れのカードが使用される
	G84	カードが使用不可
	G85	利用できないカードが使用される
	G91	カード会社のシステム障害中
	G92	カードが使用不可
	G94	取扱できない取引内容
	G95	当該業務が終了している
	G96	事故カードデータにエラーがある
	G97	何らかの理由によりリクエストを処理できない
	G98	対象業務以外の電文を受信した
	G99	契約のないセンタからデータを受信した

3Dセキュア項目チェックエラー

主にrequestPropertyの3Dセキュア項目が正しく設定されていない場合に発生するエラーです。こちらのエラーが発生した場合はリクエスト内容を見直してください。詳細は各項目の説明をご参照ください。

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
1301	T000	cardInfo
	T101	threeDSInfo
	T102	threeDSInfo.notificationUrl
	T103	threeDSInfo.authenticationData
	T104	threeDSInfo.authenticationData.authenticationIndicator
	T105	threeDSInfo.authenticationData.authenticationInfo
	T106	threeDSInfo.authenticationData.authenticationInfo.authenticationData
	T107	threeDSInfo.authenticationData.authenticationInfo.authenticationMethod
	T108	threeDSInfo.authenticationData.authenticationInfo.authenticationTimestamp
	T109	threeDSInfo.authenticationData.challengeIndicator
	T110	threeDSInfo.authenticationData.accountType
	T111	threeDSInfo.authenticationData.accountId
	T112	threeDSInfo.authenticationData.accountInfo
	T113	threeDSInfo.authenticationData.accountInfo.cardholderAccountAgeIndicator
	T114	threeDSInfo.authenticationData.accountInfo.cardholderAccountChange
	T115	threeDSInfo.authenticationData.accountInfo.cardholderAccountChangeIndicator
	T116	threeDSInfo.authenticationData.accountInfo.cardholderAccountDate
	T117	threeDSInfo.authenticationData.accountInfo.passwordChange
	T118	threeDSInfo.authenticationData.accountInfo.passwordChangeIndicator
	T119	threeDSInfo.authenticationData.accountInfo.purchaseCount
	T120	threeDSInfo.authenticationData.accountInfo.numberOfProvisioningAttemptsPerDay
	T121	threeDSInfo.authenticationData.accountInfo.numberOfTransactionsPerDay
	T122	threeDSInfo.authenticationData.accountInfo.numberOfTransactionsPerYear
	T123	threeDSInfo.authenticationData.accountInfo.paymentAccountAge
	T124	threeDSInfo.authenticationData.accountInfo.paymentAccountAgeIndicator
	T125	threeDSInfo.authenticationData.accountInfo.shippingAddressUsage
	T126	threeDSInfo.authenticationData.accountInfo.shippingAddressUsageIndicator
	T127	threeDSInfo.authenticationData.accountInfo.shippingNameIndicator
	T128	threeDSInfo.authenticationData.accountInfo.suspiciousAccountActivity
	T129	threeDSInfo.authenticationData.cardholderInfo
	T130	threeDSInfo.authenticationData.cardholderInfo.addressMatchIndicator
	T131	threeDSInfo.authenticationData.cardholderInfo.billingAddress
	T132	threeDSInfo.authenticationData.cardholderInfo.billingAddress.city
	T133	threeDSInfo.authenticationData.cardholderInfo.billingAddress.country
	T134	threeDSInfo.authenticationData.cardholderInfo.billingAddress.addressLine1
	T135	threeDSInfo.authenticationData.cardholderInfo.billingAddress.addressLine2
	T136	threeDSInfo.authenticationData.cardholderInfo.billingAddress.addressLine3
	T137	threeDSInfo.authenticationData.cardholderInfo.billingAddress.postalCode
	T138	threeDSInfo.authenticationData.cardholderInfo.billingAddress.state
	T139	threeDSInfo.authenticationData.cardholderInfo.cardholderName
	T140	threeDSInfo.authenticationData.cardholderInfo.email
	T141	threeDSInfo.authenticationData.cardholderInfo.homePhoneNumber
	T142	threeDSInfo.authenticationData.cardholderInfo.homePhoneNumber.countryCode
	T143	threeDSInfo.authenticationData.cardholderInfo.homePhoneNumber.subscriber
	T144	threeDSInfo.authenticationData.cardholderInfo.mobilePhoneNumber
	T145	threeDSInfo.authenticationData.cardholderInfo.mobilePhoneNumber.countryCode
	T146	threeDSInfo.authenticationData.cardholderInfo.mobilePhoneNumber.subscriber
	T147	threeDSInfo.authenticationData.cardholderInfo.shippingAddress
	T148	threeDSInfo.authenticationData.cardholderInfo.shippingAddress.city
	T149	threeDSInfo.authenticationData.cardholderInfo.shippingAddress.country
	T150	threeDSInfo.authenticationData.cardholderInfo.shippingAddress.addressLine1
	T151	threeDSInfo.authenticationData.cardholderInfo.shippingAddress.addressLine2
	T152	threeDSInfo.authenticationData.cardholderInfo.shippingAddress.addressLine3
	T153	threeDSInfo.authenticationData.cardholderInfo.shippingAddress.postalCode
	T154	threeDSInfo.authenticationData.cardholderInfo.shippingAddress.state
	T155	threeDSInfo.authenticationData.cardholderInfo.workPhoneNumber
	T156	threeDSInfo.authenticationData.cardholderInfo.workPhoneNumber.countryCode
	T157	threeDSInfo.authenticationData.cardholderInfo.workPhoneNumber.subscriber
	T158	threeDSInfo.authenticationData.instalmentPaymentDate
	T159	threeDSInfo.authenticationData.merchantRiskIndicator
	T160	threeDSInfo.authenticationData.merchantRiskIndicator.deliveryEmailAddress
	T161	threeDSInfo.authenticationData.merchantRiskIndicator.deliveryTimeframe
	T162	threeDSInfo.authenticationData.merchantRiskIndicator.giftCardAmount
	T163	threeDSInfo.authenticationData.merchantRiskIndicator.giftCardCount
T164	threeDSInfo.authenticationData.merchantRiskIndicator.giftCardCurrency
T165	threeDSInfo.authenticationData.merchantRiskIndicator.preOrderDate
T166	threeDSInfo.authenticationData.merchantRiskIndicator.preOrderPurchaseIndicator
T167	threeDSInfo.authenticationData.merchantRiskIndicator.reorderItemsIndicator
T168	threeDSInfo.authenticationData.merchantRiskIndicator.shippingIndicator
T169	threeDSInfo.authenticationData.messageCategory
T170	threeDSInfo.authenticationData.purchaseDate
T171	hreeDSInfo.authenticationData.recurringExpiry
T172	threeDSInfo.authenticationData.recurringFrequency
T173	threeDSInfo.authenticationData.transactionType

2. EMVCo Protocol and Core Functions Specificationの通貨コード

ISO Code	Value Not Permitted for 3-D Secure	意味
ISO 4217	955	European Composite Unit
	956	European Monetary Unit
	957	European Unit of Account 9
	958	European Unit of Account 17
	959	Gold
	960	I.M.F.
	961	Silver
	962	Platinum
	963	Reserved for testing
	964	Palladium
	999	No currency is involved
ISO 3166-1	901–999	Reserved by ISO to designate country names not otherwise defined

※EMVCo Protocol and Core Functions Specificationに準ずる

3. カード会員名で利用可能な英数字及び特殊文字

				b8	0	0	0	0	0	0	0	0
				b7	0	0	0	0	1	1	1	1
				b6	0	0	1	1	0	0	1	1
				b5	0	1	0	1	0	1	0	1
b4	b3	b2	b1		00	01	02	03	04	05	06	07
0	0	0	0	00			SP	0	@	P	`	p
0	0	0	1	01			!	1	A	Q	a	q
0	0	1	0	02			"	2	B	R	b	r
0	0	1	1	03			#	3	C	S	c	s
0	1	0	0	04			$	4	D	T	d	t
0	1	0	1	05			%	5	E	U	e	u
0	1	1	0	06			&	6	F	V	f	v
0	1	1	1	07			'	7	G	W	g	w
1	0	0	0	08			(	8	H	X	h	x
1	0	0	1	09			)	9	I	Y	i	y
1	0	1	0	10			*	:	J	Z	j	z
1	0	1	1	11			+	;	K	[	k	{
1	1	0	0	12			,	<	L	\	l	\|
1	1	0	1	13			-	=	M	]	m	}
1	1	1	0	14			.	>	N	^	n	~
1	1	1	1	15			/	?	O	_	o

※ISO/IEC 8859に準ずる

4. 3DセキュアのnotificationUrlに通知される情報

以下の認証結果情報がブラウザ（認証を開始したiFrame/Lightbox）からPostされます。

項目名	説明
userId	一意に特定するためのID。
threeDSMerchantTransID	取引を加盟店様で一意に特定するためのUUID。
threeDSRequestorTransID	取引を3Dセキュア上で一意に特定するためのUUID。
keyAlias	暗号鍵のエイリアス名。
threeDSRequestorErrorCode	3Dセキュアでエラーを検知した場合に設定されます。 ※詳細のエラーコードは以下の『threeDSRequestorErrorCode一覧』をご参照ください。
messageDigest	3Dセキュアで生成されるメッセージダイジェスト。 ※メッセージダイジェストの検証方法は以下の『メッセージダイジェストの設定方法・検証方法』をご参照ください。
authenticationResultResponse	認証処理が実行されたら、設定されます。 JSON型のオブジェクトです。

authenticationResultResponseの詳細項目

項目名	説明
acsReferenceNumber	string (ACSReferenceNumber) [ 1 .. 32 ] characters テストおよび承認時にEMVCoによって割り当てられた一意の識別子。長さ：最大32文字
acsTransID	string (ACSTransactionID) 36 characters 単一の取引を識別するためにACSによって割り当てられた一意の取引識別子。
authenticationType	string (AuthenticationType) 2 characters Enum: "01" "02" "03" イシュアがチャレンジ認証で使用する認証方法を指定できます。 01 = Static 02 = Dynamic 03 = OOB 04-79 = EMVCoによる返却 80-99 = DSによる返却
authenticationValue	string (AuthenticationValue) 28 characters サポートされている個々のDSに対するACSの登録の一部として提供される決済システムに固有の値。
cardholderInfo	string (CardholderInformationText) [ 1 .. 128 ] characters ACSによって認証されなかったフリクションレス取引の実行中にACS / イシュアによってカード会員に提供されるテキスト。イシュアはオプションでカード会員に情報を提供できます。例） “Additional authentication is needed for this transaction, please contact (Issuer Name) at xxx-xxx-xxxx.” string (CardholderInformationText) [ 1 .. 128 ] characters
challengeCancel	string (ChallengeCancel) 2 characters Enum: "01" "02" "03" "04" "05" "06" "07" "08" チャレンジ認証がキャンセルされたことを示すインジケータ。 01 = カード所有者が「キャンセル」を選択 02 = EMVCoによって将来的に定義されます（EMVCoによって定義されるまで値は無効です） 03 = 取引がタイムアウトしました—Decoupled認証 04 = ACSで取引がタイムアウトしました—その他のタイムアウト 05 = ACSで取引がタイムアウトしました—ACSが最初のCReqを受信していません 06 = 取引エラー 07 = 不明 08 = SDKで取引がタイムアウトしました
dsReferenceNumber	string (DSReferenceNumber) [ 1 .. 32 ] characters DS参照番号。承認されたDSを追跡するためのEMVCoが割り当てた一意の識別子。長さ：最大32文字
dsTransID	string (DSTransactionID) 36 characters 単一の取引を識別するためにDSによって割り当てられる一意なUUID。
eci	string (ElectronicCommerceIndicator) 2 characters カード会員を認証する試行の結果を示すためにACSによって提供される決済システムに固有の値。DSによって定義されます。
errorCode	string (ErrorCode) [ 3 .. 4 ] characters メッセージで識別された問題のタイプを示すコード。 ※詳細のエラーコードは以下の『errorCode一覧』をご参照ください。
errorComponent	string (ErrorComponent) 1 characters Enum: "C" "S" "D" "A" エラーを識別した3Dセキュアコンポーネントを示すコード。 C = 3DS SDK S = 3DS Server D = DS A = ACS
errorDescription	string (ErrorDescription) [ 1 .. 2048 ] characters メッセージで識別された問題をdescriptionするテキスト。
errorDetail	string (ErrorDetail) [ 1 .. 2048 ] characters メッセージで識別された問題に関する追加の詳細情報。
errorMessageType	string (ErrorMessageType) 4 characters エラーとして識別されたメッセージタイプを識別します。
interactionCounter	string (InteractionCounter) 2 characters カード所有者がチャレンジ認証で試行した認証サイクルの数を示します。
messageVersion	string (MessageVersionNumber) [ 5 .. 8 ] characters プロトコルバージョン識別子。こちらは、こちらのメッセージを作成するシステムが利用する仕様のプロトコルバージョン番号です。メッセージバージョン番号は、AReqメッセージを送信する3DS Serverによって設定されます。メッセージバージョン番号は、3Dセキュア取引中に変更されません。
resolvedCardScheme	string (ResolvedCardScheme) Enum: "VISA" "MASTERCARD" "AMERICANEXPRESS" "JCB" "DISCOVER" PANが属する国際ブランドです。ActiveServerによって判定されます。
threeDSServerTransID	string (3DSServerTransactionID) 36 characters 単一の取引を識別するために3DS Serverによって割り当てられる一意なUUID。
transStatus	string (TransactionStatus) 1 characters Enum: "Y" "N" "U" "A" "R" 取引が認証済み取引として適格であるかどうかを示します。 Y = 認証 / 口座確認に成功 N = 未認証 / 口座未確認；取引拒否 U = 認証 / 口座確認を実行できなかった；AResまたはRReqで示される技術的な問題またはその他の問題 A = 処理の試行が実施された；認証 / 確認は行われなかったが、認証 / 確認を試行したことの証拠は提供されている R = 認証 / 口座確認が拒否された；イシュアが認証 / 確認を拒否しており、承認を試行しないよう要求している。
transStatusReason	string (TransactionStatusReason) 2 characters Enum: "01" "02" "03" "04" "05" "06" "07" "08" "09" "10" "11" "12" "13" "14" "15" "16" "17" "18" "19" "20" "21" 「transStatus」の値に関する補足情報を提供します。 01 = カード認証に失敗した 02 = 不明なデバイス 03 = サポートされていないデバイス 04 = 認証頻度の上限を超えた 05 = 有効期限切れのカード 06 = 無効なカード番号 07 = 無効な取引 08 = カードのレコードが存在しない 09 = セキュリティ障害 10 = 盗難カード 11 = 不正の疑い 12 = カード会員に取引が許可されていない 13 = カード会員がサービスに登録されていない 14 = 取引がACSでタイムアウトした 15 = 信頼度が低い 16 = 信頼度が中程度 17 = 信頼度が高い 18 =信頼度が非常に高い 19 = ACSの最大チャレンジを超える 20 = 非決済取引はサポートされていません 21 = 3RI取引はサポートされていません 22-79 = EMVCoによる返却 80-99 = DSによる返却

メッセージダイジェストの設定方法・検証方法

メッセージダイジェストの検証対象API一覧

以下API受信時にメッセージダイジェストを検証いただきます。

No	業務	API	ペイロード生成項目
1	認証業務	ブラウザベース認証結果通知	http.body:form

メッセージダイジェストの設定方法

ペイロードの生成
ハッシュ化
16進数文字列に変換
ハッシュ化アルゴリズムコードの付与

1. ペイロードの生成

受信項目の「KEY=VALUE」のVALUEのみを文字列連結します。
連結する際に区切り文字はありません。
VALUEの連結順はKEYの辞書順昇順です。

ペイロード生成項目の取得元は
前述のメッセージダイジェストの検証対象API一覧の『対象API』「ペイロード生成項目」をご参照ください。
但し、messageDigestの項目は含まないでください。

例：ブラウザベース認証

userId=user001
threeDSMerchantTransID=11250032-e29b-41d4-a7s6-44665d440550
threeDSRequestorTransID=11fc642b-a261-4568-b023-ae621e407736
keyAlias=alias001
threeDSRequestorErrorCode=R3100
messageDigest=10E000F9B1B5F6651E6CEF6BE32229B771B6D2C448A6A4680AFC1EB6E016CC8826
authenticationResultResponse=ENCRYPTED_DATA

↓

 ペイロード：ENCRYPTED_DATAalias00111250032-e29b-41d4-a7s6-44665d440550R310011fc642b-a261-4568-b023-ae621e407736user001

2. ハッシュ化

対応しているハッシュ化アルゴリズムは以下表の通りです。
ソルト値はお客様ごとに払い出しします。
ペイロードの先頭にソルト値を付与して、ハッシュ化を行ってください。
ハッシュ値　＝　Hash化(ソルト＋ペイロード)

ハッシュ化アルゴリズムコード	ハッシュ化アルゴリズム名	ソルト長
10	SHA-256	32バイト
30	SHA-512	32バイト

例：ブラウザベース認証

ペイロード：ENCRYPTED_DATAalias00111250032-e29b-41d4-a7s6-44665d440550R310011fc642b-a261-4568-b023-ae621e407736user001
ソルト：6E581AD1299B32AE6AE9F81614C63F81
ハッシュ化アルゴリズム：SHA-256

↓

ハッシュ値(byte配列)：[-32, 0, -7, -79, -75, -10, 101, 30, 108, -17, 107, -29, 34, 41, -73, 113, -74, -46, -60, 72, -90, -92, 104, 10, -4, 30, -74, -32, 22, -52, -120, 38]

3. 16進数文字列に変換

ハッシュ結果のbyte配列を16進数表記の文字列に変換します。

例：ブラウザベース認証

ハッシュ値(byte配列)：[-32, 0, -7, -79, -75, -10, 101, 30, 108, -17, 107, -29, 34, 41, -73, 113, -74, -46, -60, 72, -90, -92, 104, 10, -4, 30, -74, -32, 22, -52, -120, 38]

↓

16進数文字列：E000F9B1B5F6651E6CEF6BE32229B771B6D2C448A6A4680AFC1EB6E016CC8826

4. ハッシュ化アルゴリズムコードの付与

使用したハッシュ化アルゴリズムに対応したハッシュ化アルゴリズムコードを16進数文字列の先頭に付与してください。

例：ブラウザベース認証

16進数文字列：E000F9B1B5F6651E6CEF6BE32229B771B6D2C448A6A4680AFC1EB6E016CC8826
ハッシュ化アルゴリズムコード：10

↓

メッセージダイジェスト：10E000F9B1B5F6651E6CEF6BE32229B771B6D2C448A6A4680AFC1EB6E016CC8826

メッセージダイジェストの検証方法

以下の手順でメッセージダイジェストの検証を行ってください。

ボディ部のmessageDigestからメッセージダイジェストを取得
メッセージダイジェストからハッシュ化アルゴリズムコードを取得
メッセージダイジェストの生成と同じ手順でメッセージダイジェストを生成
メッセージダイジェストを比較
ボディ部のmessageDigestからメッセージダイジェストを取得

ボディ部のmessageDigestからメッセージダイジェストを取得する。

例：ブラウザベース認証

ボディ部のmessageDigest : 10E000F9B1B5F6651E6CEF6BE32229B771B6D2C448A6A4680AFC1EB6E016CC8826

↓

メッセージダイジェスト：10E000F9B1B5F6651E6CEF6BE32229B771B6D2C448A6A4680AFC1EB6E016CC8826

メッセージダイジェストからハッシュ化アルゴリズムコードを取得

ボディ部のmessageDigestから取り出したメッセージダイジェストの先頭2文字をハッシュ化アルゴリズムコードとします。

例：ブラウザベース認証

メッセージダイジェスト：10E000F9B1B5F6651E6CEF6BE32229B771B6D2C448A6A4680AFC1EB6E016CC8826

↓

ハッシュ化アルゴリズムコード：10

メッセージダイジェストの設定と同じ手順でメッセージダイジェストを生成

前述の「メッセージダイジェストの設定方法」と同じ手順で、メッセージダイジェストを生成します。
ハッシュ化アルゴリズムは、２.で取得したハッシュ化アルゴリズムコードに対応したものを使用してください。
ソルトはお客様ごとに払い出されたソルト値を使用してください。

メッセージダイジェストを比較

1.で取得したボディ部のmessageDigestのメッセージダイジェストと3.で生成したメッセージダイジェストを文字列比較してください。
完全一致すれば、検証OKです。
不一致の場合は、伝送途中でメッセージの改ざんが行われた可能性があるため、取引を破棄してください。

メッセージダイジェスト検証サンプル

/**
 * メッセージダイジェストの検証サンプル。
 *
 * @param request 受信したHttp Request
 * @param salt ソルト
 * @return 検証結果
 * @throws Exception 例外
 */
private static boolean checkMessageDigest(HttpServletRequest request, String salt)
        throws Exception {
 
  // ======================================
  // 1.HTTP パラメータからメッセージダイジェストを取得
  // ======================================
  String messageDigestInput = request.getParameter("messageDigest");
 
  // ======================================
  // 2.メッセージダイジェストからハッシュ化アルゴリズムコードを取得
  // ======================================
  String hashAlgorithmCd = messageDigestInput.substring(0, 2);
 
  // ======================================
  // 3.メッセージダイジェストの生成と同じ手順でメッセージダイジェストを生成
  // ======================================
  // 3-1.ペイロードの生成
  StringBuilder sb = new StringBuilder();
  // キーの辞書順に値を文字連結
  // StringUtils.defaultStringにより、値がnullの場合に空文字に変換している。
  // キー項目が増えた場合は、辞書順で追加が必要
  sb.append(StringUtils.defaultString(request.getParameter("authenticationResultResponse")));
  sb.append(StringUtils.defaultString(request.getParameter("keyAlias")));
  sb.append(StringUtils.defaultString(request.getParameter("threeDSMerchantTransID")));
  sb.append(StringUtils.defaultString(request.getParameter("threeDSRequestorErrorCode")));
  sb.append(StringUtils.defaultString(request.getParameter("threeDSRequestorTransID")));
  sb.append(StringUtils.defaultString(request.getParameter("userId")));
 
  String payload = sb.toString();
 
  // 3-2.ハッシュ化
 
  // ハッシュ化アルゴリズムコードからハッシュ化アルゴリズムを判断
  String hashAlgorithm = null;
  if ("10".equals(hashAlgorithmCd)) {
    hashAlgorithm = "SHA-256";
  } else if ("30".equals(hashAlgorithmCd)) {
    hashAlgorithm = "SHA-512";
  } else {
    throw new Exception("ハッシュ化アルゴリズムコード不正");
  }
  // ハッシュ化
  MessageDigest md = MessageDigest.getInstance(hashAlgorithm);
  // ソルトを先頭に付与
  md.update(salt.getBytes(StandardCharsets.UTF_8));
  // ハッシュ化の実行
  byte[] hashByteArray = md.digest(payload.getBytes(StandardCharsets.UTF_8));
 
  // 3-3.16進数文字列に変換
  sb = new StringBuilder();
  for (int i = 0; i < hashByteArray.length; i++) {
    sb.append(String.format("%02X", hashByteArray[i]));
  }
  String hexString = sb.toString();
 
  // 3-4.ハッシュ化アルゴリズムコードの付与
  String messageDigest = hashAlgorithmCd + hexString;
 
  // ======================================
  // 4.メッセージダイジェストを比較
  // ======================================
  boolean checkResult;
  if (messageDigest.equals(messageDigestInput)) {
    checkResult = true;
  } else {
    checkResult = false;
  }
 
  return checkResult;
}

errorCode一覧

ActiveServerから返却されるエラーコードは、3Dセキュアエラーコード、取引エラーコード、汎用エラーコードの3種類があります。最新のエラーコードについては以下リンクをご参照ください。

英語版：https://docs.activeserver.cloud/en/errors/

3Dセキュアエラーコード一覧

3Dセキュアエラーコード一覧は、EMVCo Core Protocol Specificationsによって定義されているエラーコードです。
こちらのエラーコードはActiveServer、DS、ACSのいずれかがエラー応答をします。
どのシステムがエラーを応答したかは「errorComponent」にて確認できます。

エラーコード	内容	説明	後続の想定アクション
101	MESSAGE_RECEIVED_INVALID	受信したメッセージが無効です。	加盟店様判断で支払(オーソリ)処理に遷移または取引を中止する
102	MESSAGE_VERSION_NUMBER_NOT_SUPPORTED	サポートされていないメッセージバージョン番号です。
201	REQUIRED_DATA_ELEMENT_MISSING	仕様に従って定義された必須のメッセージ要素がありません。
202	CRITICAL_MESSAGE_EXTENSION_NOT_RECOGNISED	重要なメッセージ拡張が存在しません。
203	FORMAT_OF_ONE_OR_MORE_DATA_ELEMENTS_IS_INVALID_ACCORDING_TO_THE_SPECIFICATION	データ要素が要求されている形式ではないか、仕様に従って定義された値が無効です。
204	DUPLICATE_DATA_ELEMENT	重複したデータ要素が見つかりました。
301	TRANSACTION_ID_NOT_RECOGNISED	コンポーネントの受信について、受信した取引IDは無効です。
302	DATA_DECRYPTION_FAILURE	データの暗号化が失敗しました。
303	ACCESS_DENIED_INVALID_ENDPOINT	APIリクエストのエンドポイントが無効です。リクエストURLを確認してください。
304	ISO_CODE_INVALID	ISOコードが無効です。
305	TRANSACTION_DATA_NOT_VALID	取引データが無効です。
306	MERCHANT_CATEGORY_CODE_MCC_NOT_VALID_FOR_PAYMENT_SYSTEM	加盟店カテゴリーコードが無効です。
402	TRANSACTION_TIMED_OUT	取引がタイムアウトしました。	再度認証を行うまたは加盟店様判断で支払(オーソリ)処理に遷移または取引を中止する
403	TRANSIENT_SYSTEM_FAILURE	システムが短期間故障しました。	加盟店様判断で支払(オーソリ)処理に遷移または取引を中止する
404	PERMANENT_SYSTEM_FAILURE	システムが恒久的に故障しました。	加盟店様判断で支払(オーソリ)処理に遷移または取引を中止する
405	SYSTEM_CONNECTION_FAILURE	システムに接続できませんでした。	再度認証を行うまたは加盟店様判断で支払(オーソリ)処理に遷移または取引を中止する
XXX		その他の例外	加盟店様判断で支払(オーソリ)処理に遷移または取引を中止する

取引エラーコード

ActiveServerによって定義されたエラーコードです。「errorComponent」には常に「S」が設定されます。

エラーコード	内容	説明	後続の想定アクション
1000	DIRECTORY_SERVER_NOT_AVAILABLE	ディレクトリー・サーバーとの通信時にエラーが発生した際に返却されるエラーコードです。 ※原因がタイムアウトの場合は、エラーコード402が返されます。	再度認証を行うまたは加盟店様判断で支払(オーソリ)処理に遷移または取引を中止する
1001	DIRECTORY_SERVER_NOT_FOUND	指定されたプロバイダーのディレクトリ・サーバーが見つかりませんでした	加盟店様判断で支払(オーソリ)処理に遷移または取引を中止する
1002	ERROR_SAVE_TRANSACTION	取引の保存中にエラーが発生しました
1004	UNHANDLED_EXCEPTION	未処理の例外
1011	INVALID_LICENSE	加盟店様に有効なライセンスがありません
1013	INVALID_TRANSACTION_ID	3DSサーバーの取引IDを認識できません
1014	INVALID_REQUESTOR_TRANSACTION_ID	3DSリクエスターの取引IDを認識できません
1016	MISSING_REQUIRED_ELEMENT	必須要素がありません。
1020	ERROR_TRANSMISSION_DATA	データ転送中にエラーが発生しました。
1021	PRIOR_TRANS_ID_NOT_FOUND	リクエスターの事前取引IDの設定中にエラーが発生しました。事前取引IDが見つかりませんでした。
1022	INVALID_FORMAT	仕様に従って、1つ以上の要素の形式が無効です。
1026	MERCHANT_ID_THREEDS_REQUESTOR_ID_INVALID	acquirerMerchantID/threeDSRequestorIDが無効です
1027	UNSUPPORTED_API_VERSION	サポートされていないAPIバージョン番号です。
XXXX		その他の例外

汎用エラーコード

ActiveServerによって定義されたエラーコードです。
3Dセキュアエラーコード、取引エラーコードに含まれないエラーコードは全て以下が応答されます。
また、「errorComponent」には常に「S」が設定されます。

エラーコード	内容	説明	後続の想定アクション
2002	VALIDATION_ERROR	入力が無効です。	加盟店様判断で支払(オーソリ)処理に遷移または取引を中止する
2005	ACCESS_DENIED	アクセスが拒否されました。
2007	INTERNAL_SERVER_ERROR	内部サーバーエラー。
2009	SESSION_TIMED_OUT	セッションがタイムアウトしました。	再度認証を行うまたは加盟店様判断で支払(オーソリ)処理に遷移または取引を中止する
XXXX		その他の例外	加盟店様判断で支払(オーソリ)処理に遷移または取引を中止する

threeDSRequestorErrorCode一覧

エラーが返却される処理	エラーコード	説明	後続の想定アクション
ブラウザベース認証要求	R1000	システムエラーが発生しました。	加盟店様判断で支払（オーソリ）処理に遷移または取引を中止する
	R1001	システムに接続できませんでした。	再度認証を行うまたは加盟店様判断で支払（オーソリ）処理に遷移または取引を中止する
	R1002	取引がタイムアウトしました。	再度認証を行うまたは加盟店様判断で支払（オーソリ）処理に遷移または取引を中止する
	R1003	取引ステータスが異常です。	加盟店様判断で支払（オーソリ）処理に遷移または取引を中止する
	R1005	加盟店情報が不正です。
	R1100	必須項目チェックエラーが発生しました。
	R1101	レングスチェックエラーが発生しました。
	R1102	報告電文チェックエラーが発生しました。
	R1103	3DSMerchantTransIDが重複しています。(ページリロード等により発生)
リスクベース認証要求(AReqの実行)	R2000	システムエラーが発生しました。	加盟店様判断で支払（オーソリ）処理に遷移または取引を中止する
	R2001	システムに接続できませんでした。	再度認証を行うまたは加盟店様判断で支払（オーソリ）処理に遷移または取引を中止する
	R2002	取引がタイムアウトしました。	再度認証を行うまたは加盟店様判断で支払（オーソリ）処理に遷移または取引を中止する
	R2003	取引ステータスが異常です。	加盟店様判断で支払（オーソリ）処理に遷移または取引を中止する
	R2005	加盟店情報が不正です。
	R2100	必須項目チェックエラーが発生しました。
	R2101	レングスチェックエラーが発生しました。
	R2102	報告電文チェックエラーが発生しました。
ACSからのチャレンジ認証完了通知	R3000	システムエラーが発生しました。	加盟店様判断で支払（オーソリ）処理に遷移または取引を中止する
	R3001	システムに接続できませんでした。	再度認証を行うまたは加盟店様判断で支払（オーソリ）処理に遷移または取引を中止する
	R3002	取引がタイムアウトしました。	再度認証を行うまたは加盟店様判断で支払（オーソリ）処理に遷移または取引を中止する
	R3003	取引ステータスが異常です。	加盟店様判断で支払（オーソリ）処理に遷移または取引を中止する
	R3100	必須項目チェックエラーが発生しました。
	R3101	レングスチェックエラーが発生しました。
	R3102	報告電文チェックエラーが発生しました。
ブラウザリダイレクト	R4000	システムエラーが発生しました。	加盟店様判断で支払（オーソリ）処理に遷移または取引を中止する
	R4001	必須項目チェックエラーが発生しました。
	R4002	メッセージダイジェスト不一致でエラーが発生しました。
	R4003	冪等性チェックエラーが発生しました。
	R4004	有効性チェックエラーが発生しました。
	R4005	復号処理にエラーが発生しました。
その他の例外	RXXXX（上記以外のエラーコードの場合）	システムエラーが発生しました。	加盟店様判断で支払（オーソリ）処理に遷移または取引を中止する

※決済事業者によって新規でエラーコードが採番された場合、上記に記載されていない場合があります。
※RXXXXのXには半角数字が入ります。

5. JavaScriptによるトークンの取得

トークンJavaScriptを読み込む

加盟店様サイトで、以下のJavaScript例を利用するか、参考に実装してください。
JavaScript例

function OmnipfToken() {
  this.URL = "https://(本サービスのドメイン)/v1/tokenize",
  this.TIMEOUT = 35e3
}
OmnipfToken.prototype = {
  createToken: function(accessToken, routingKey, cardObj, callBackFunc) {
    var o = this;
    try {
      var xhr = new XMLHttpRequest();
      xhr.open("POST", this.URL);
      xhr.responseType = 'json';
      xhr.setRequestHeader("Content-Type", "application/json");
      xhr.setRequestHeader("Authorization", "Bearer " + accessToken);
      xhr.setRequestHeader("X-Routing-Key", routingKey);
      xhr.onload = () => {
        return callBackFunc(xhr.response);
      };
      xhr.onerror = () => {
        return callBackFunc(o.createErrObj("500", "unexpected error"))
      };
 
      xhr.timeout = this.TIMEOUT;
      xhr.send(JSON.stringify(cardObj));
    } catch (e) {
      return callBackFunc(o.createErrObj("500", e))
    }
  },
  createErrObj: function(code, message) {
    return {
        code: code,
        message: message
    }
  }
}

クレジットカード情報をトークン化する

createToken()のインターフェース

引数	名称	プロパティ名	必須/任意	説明
第1引数	アクセストークン		必須	createEndUserAccessTokenで返却された"token"を設定してください。
第2引数	ルーティングキー		必須	authで返却された"routingKey"を設定してください。
第3引数	カード情報	accountNumber	必須	カード番号。半角数字14文字以上16文字以下。
		accountName	任意	カード名義。最大30文字。
		expiryDate	必須	有効期限。YYMM形式。数字4文字。
		securityCode	任意	セキュリティコード。半角数字3文字もしくは4文字。
第4引数	コールバック関数		必須	トークン化した後に実行するJavaScript関数名。

createToken()のインターフェース例

<script type="text/javascript">
function postForm() {
    var omnipfToken = new OmnipfToken();
    omnipfToken.createToken(
        "abcdefghijklmnopqrstuvwxyz",     // アクセストークン
        "az1",                            // ルーティングキー
        {
            accountNumber: document.getElementById('account_num').value, // カード番号
            accountName: document.getElementById('account_name').value, // カード名義
            expiryDate: document.getElementById('expiry_year').value + document.getElementById('expiry_month').value, // 有効期限
            securityCode: document.getElementById('security_code').value // セキュリティコード
        },
        callBackFunc                      // トークン作成処理後に実行したい関数
    );
}
</script>

取得したトークンを加盟店様サイトに送信する

createToken()の処理後には、以下のJavaScriptオブジェクトが応答されます。

名称	プロパティ名	説明
エラーコード	code	エラーコードです。正常に処理された場合は設定されません。
エラーメッセージ	message	エラーメッセージです。正常に処理された場合は設定されません。
エラー詳細	details	エラー詳細です。正常に処理された場合は設定されません。
トークン	token	決済用のトークンです。
有効期限	expires_at	トークンの有効期限です。 YYYY-MM-DDThh:mm:ss+09:00形式
マスクされたカード番号	masked_account_number	カード番号の下4桁以外をマスク化します。 ************0000。

createToken()のレスポンス例

<script type="text/javascript">
function callBackFunc(response) {
    f (response.code == undefined) {  // トークン処理結果が正常の場合
        //カード情報削除
        document.getElementById('account_num').value = "";
        document.getElementById('expiry_year').value = "";
        document.getElementById('expiry_month').value = "";
        document.getElementById('security_code').value = "";
        document.getElementById('account_name').value = "";
 
        //tokenフィールドに値を設定
        document.getElementById('token').value = response.token;
        document.getElementById('expires_at').value = response.expiresAt;
        document.getElementById('masked_account_number').value = response.maskedAccountNumber;
         
        //スクリプトからフォームをsubmit
        document.getEmentsById('purchaseForm').submit()
 
    } else {  // トークン処理結果が異常の場合
        // エラー時の処理をここに記述する
    }
}
</script>

購入フォーム全体のイメージ

<!DOCTYPE html>
<html>

<head>
    <meta charset="UTF-8">
    <script src="https://(提供するJavaScriptのURL)"></script>
    <title>加盟店様購入画面</title>
    <script>
        function callBackFunc(response) {
            if (response.code == undefined) {  // トークン処理結果が正常の場合
                //カード情報削除
                document.getElementById('account_num').value = "";
                document.getElementById('expiry_year').value = "";
                document.getElementById('expiry_month').value = "";
                document.getElementById('security_code').value = "";
                document.getElementById('account_name').value = "";

                //tokenフィールドに値を設定
                document.getElementById('token').value = response.token;
                document.getElementById('expires_at').value = response.expiresAt;
                document.getElementById('masked_account_number').value = response.maskedAccountNumber;

                //スクリプトからフォームをsubmit
                // document.getEmentsById('purchaseForm').submit() 
            } else {  // トークン処理結果が異常の場合
                // エラー時の処理をここに記述する
            }
        }

        function postForm() {
            console.log("start create token");
            var omnipfToken = new OmnipfToken(); 
            omnipfToken.createToken(
                "abcdefghijklmnopqrstuvwxyz",     　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　// アクセストークン
                "az1",                            　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　// ルーティングキー
                {
                    accountNumber: document.getElementById('account_num').value, 　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　// カード番号
                    accountName: document.getElementById('account_name').value, 　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　// カード名義
                    expiryDate: document.getElementById('expiry_year').value + document.getElementById('expiry_month').value, // 有効期限
                    securityCode: document.getElementById('security_code').value 　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　// セキュリティコード
                },
                callBackFunc                      　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　// トークン作成処理後に実行したい関数
            );
        }
    </script>
</head>

<body>
    <form id='getTokenForm'>
        <p> カード番号：<input type='text' value='' name='account_num' id='account_num' />
        </p>
        <p> カード有効期限：<input type='text' value='' name='expiry_year' id='expiry_year' />/ <input type='text' value=''
                name='expiry_month' id='expiry_month' />
        </p>
        <p> セキュリティコード：<input type='text' value='' name='security_code' id='security_code' />
        </p>
        <p> 名義人：<input type='text' value='' name='account_name' id='account_name' />
        </p>
        <p>
            <input type='button' value='購入する' onclick="postForm()" />
        </p>
    </form>
    <form id='purchaseForm' action='(加盟店様URL)' method='post'>
        <p>
            <input type='hidden' value='' name='token' id='token' />
        </p>
        <p>
            <input type='hidden' value='' name='expires_at' id='expires_at' />
        </p>
        <p>
            <input type='hidden' value='' name='masked_account_number' id='masked_account_number' />
        </p>
    </form>
    <p>
</body>

</html>

6. クレジットカード決済固有の制限事項

captureTransactionの制限

一度売上確定をした取引に対して再度売上確定を実施することはできません。
支払キャンセル、再支払を実施した取引に対して一部売上確定を実施することはできません。再度支払キャンセル、再支払で差分を設定した上で、全額売上確定を実施してください。

7. 支払区分設定方法

paymentType(支払区分)の設定方法

支払区分	paymentTypeに設定する数字
一括払い	10
ボーナス払い	21
分割払い	61
リボ払い	80

支払区分によって設定有無、方法が異なる項目
◎：必須、ー：設定しない

		分割回数 numberOfInstallmentPayments
支払区分	10	ー
	61	◎
	80	ー

8. 3Dセキュアで使用できる都道府県コード

都道府県名	英語表記	ISO 3166-2における都道府県コード
北海道	Hokkaido	01
青森県	Aomori	02
岩手県	Iwate	03
宮城県	Miyagi	04
秋田県	Akita	05
山形県	Yamagata	06
福島県	Fukushima	07
茨城県	Ibaraki	08
栃木県	Tochigi	09
群馬県	Gunma	10
埼玉県	Saitama	11
千葉県	Chiba	12
東京都	Tokyo	13
神奈川県	Kanagawa	14
新潟県	Niigata	15
富山県	Toyama	16
石川県	Ishikawa	17
福井県	Fukui	18
山梨県	Yamanashi	19
長野県	Nagano	20
岐阜県	Gifu	21
静岡県	Shizuoka	22
愛知県	Aichi	23
三重県	Mie	24
滋賀県	Shiga	25
京都府	Kyoto	26
大阪府	Osaka	27
兵庫県	Hyogo	28
奈良県	Nara	29
和歌山県	Wakayama	30
鳥取県	Tottori	31
島根県	Shimane	32
岡山県	Okayama	33
広島県	Hiroshima	34
山口県	Yamaguchi	35
徳島県	Tokushima	36
香川県	Kagawa	37
愛媛県	Ehime	38
高知県	Kochi	39
福岡県	Fukuoka	40
佐賀県	Saga	41
長崎県	Nagasaki	42
熊本県	Kumamoto	43
大分県	Oita	44
宮崎県	Miyazaki	45
鹿児島県	Kagoshima	46
沖縄県	Okinawa	47

※ISO 3166-2に準ずる

コンビニ決済（番号払い）詳細

1. コンビニ決済（番号払い）エラーコード一覧

リクエスト項目チェックエラー

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
1501	CVC100	requestId（リクエストを識別するID）
	CVC101	amount（取引金額情報）
	CVC102	currencyCode（通貨コード）
	CVC103	value（取引金額）
	CVC104	requestProperty（決済手段固有の情報）
	CVC106	captureNow（同時売上）
	CVC110	customerInfo（利用者情報）
	CVC111	telephoneNumber（電話番号）
	CVC112	emailAddress（メールアドレス）
	CVC113	firstName（名）
	CVC114	lastName（姓）
	CVC115	予備領域
	CVC116	itemName（代表商品名）
	CVC119	payLimitDay（支払期限日）
	CVC120	company（払込先）
	CVC121	orderDescription（注文情報）
	CVC122	sendEmail（注文情報）
	CVC123	payLimitDateTime（支払期限日時）

各種サービス契約項目チェックエラー

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
2501	CVC200	契約情報が正常に登録されていない
	CVC201
	CVC202
	CVC203
	CVC204
	CVE200
	CVE201
	CVE202
	CVE203
	CVS200
	CVS201
	CVS202
	CVS203
	CVS204
	CVW200
	CVW201
	CVW202
	CVW203
	CVW204

決済システムエラー(リトライにより解消する場合あり)

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
4501	CVC400	決済システムの一時エラー
	CVE400
	CVS400
	CVW400

決済事業者エラー

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
5501	CVE500	決済事業者システムの一時的エラー(※1)
	CVE501	既に決済が成立している
	CVE502	サイト契約がされていない
	CVE503	決済事業者システムの一時的エラー(※1)
	CVE509	決済事業者システムのその他エラー
	CVS500	決済事業者システムの一時的エラー(※1)
	CVS501	サイト契約がされていない
	CVS502	決済事業者システムの一時的エラー(※1)
	CVS503	流量過多が検知された(※1)
	CVS509	決済事業者システムのその他エラー
	CVW500	決済事業者システムの一時的エラー(※1)
	CVW501	既に決済が成立している
	CVW502	サイト契約がされていない
	CVW509	決済事業者システムのその他エラー

※1　リトライにより解消する場合があります

2. コンビニ決済（番号払い） POSスキャナ読取仕様

バーコード(code128)を読み取るPOSスキャナ仕様は以下の通りです。

ファミリーマート

バーコードの反射値
白バー: 0.45以上
黒バー: 0.25以下
PCS値: 0.45以上
バーコード長: 65mm max
バーコード高さ: 10mm min(推奨値)

PayPay 詳細

webviewからのappinvoke方法

NativeWebviewアプリケーションが同じウインドウ内でPayPayのWebCashierURLをロードするとき、リダイレクト処理を適切に利用者に要求できないことが課題となっています。こちらを解決するために加盟店様Native Webviewアプリケーションに対し、スニペットの実装をお願いいたします。 iOSでは以下の1を実装してください。Androidでは以下の2を実装してください（難しい場合は1を実装してください）。

1.iOS/Android共通

JavaScriptにより外部ブラウザをオープンし、PayPayアプリを起動してください。

window.open("<web_cashier URL>", "_blank");

2.Android

「Intent」を使用し、PayPayアプリへのリダイレクトをハンドリングできるようにwebviewの設定を上書きしてください。

val codeWeb: WebView = WebView(this)
val settings = codeWeb.settings
settings.domStorageEnabled = true
settings.javaScriptEnabled = true
codeWeb.loadUrl("<merchant web URL>")
codeWeb.webViewClient = object : WebViewClient() {
    override fun shouldOverrideUrlLoading(
        view: WebView?,
        url: String?
    ): Boolean {
        Log.i("shouldOverrideUrlLoading", "shouldOverrideUrlLoading: $url")
        val intent: Intent
        if (url != null) {
            if (url. contains("<web cashier host>")) {
                // Current value of web cashier host:
                // https://www.paypay.ne.jp/app/cashier
    // STG (Sandbox) is below:
    // https://stg-www.sandbox.paypay.ne.jp/app/cashier
                intent = Intent(Intent.ACTION_VIEW)
                intent.data = Uri.parse(url)
                startActivity(intent)
                return true
            }
        }
        return false
    }
}

加盟店様アプリから離れてPayPayアプリで決済後、加盟店様Native Webview アプリケーションにリダイレクトする場合、以下の2つの方法で実現可能です。

1.Universal links/App linksを用意する

加盟店様で、iOSアプリであればUniversal linksを、AndroidアプリであればApp linksをそれぞれご用意いただき、 PayPayの「 Create a Code API 」のredirectUrlオプションに HTTPスキームのURLを指定してください。

2.Deeplinkを用意する

加盟店様で、deeplinkをご用意いただき、 PayPayの「Create a Code API」のredirectUrlオプションにカスタムスキームのURLを指定してください。 ※redirectTypeは「APP_DEEP_LINK」を指定してください。

※ ログイン実装でSSO(シングルサインオン)を導入している場合、 PayPayアプリからの戻りの際にセッション切れを起こす可能性があり、セッション維持方法について検討していただく必要があります。

注文完了判定方法

決済時にPayPayアプリに遷移する方式（リンク型またはWebPayment）の場合、PayPay決済完了後、加盟店様サイトに遷移しなかった場合でも注文成立となるよう実装をお願いいたします。自動遷移実装しない場合、PayPayキャンペーンにご参加いただけません（決済取消によってキャンペーン当選も取消となり、クレーム化した経緯があります）。決済完了を検知できなかった場合、取引情報取得を実施し、決済完了されているかをご参照ください。

PayPay_注文完了判定方法

楽天ペイ詳細

1. 楽天ペイエラーコード一覧

リクエスト項目チェックエラー

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
1901	R101	`amount.value`（取引金額）の項目に対しての入力チェックエラーが発生した
	R102	`amount.currencyCode`（通貨コード）の項目に対しての入力チェックエラーが発生した
	R104	`orderDescription`（加盟店様側で自由で設定できる説明文）の項目に対しての入力チェックエラーが発生した
	R105	`redirectUrl`（利用者の支払い同意成功後に遷移する加盟店様のURL）の項目に対しての入力チェックエラーが発生した
	R106	`failureUrl`（利用者の支払い同意失敗後に遷移する加盟店様のURL）の項目に対しての入力チェックエラーが発生した

取引情報引当時の整合性チェックエラー

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
1901	R401	楽天ペイで対応していない機能を使おうとした
	R402	指定した関連取引が存在しなかった
	R403	要求された処理が実行できる状態ではない（キャンセル済みの取引を売上確定しようとした場合などに返却されます）
	R404	最新の支払金額と異なる金額で売上確定しようとした
	R405	最新の支払金額と異なる金額で支払キャンセルしようとした
	R406	最新の売上確定金額を上回る金額で返金しようとした
	R408	売上確定残高が1円になる金額で部分返金しようとした
	R409	障害取消対象の取引が存在しない
	R410	支払（オーソリ）・同時売上以外の取引を障害取消しようとした

その他エラー

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
2901	R900	内部エラー
4901	R901	内部エラー（障害取消もしくは運用対処によるリカバリ要）

決済事業者エラー

詳細は決済事業者にお問い合わせください。

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
5901	R501	該当の取引が既に処理済みの場合
	R502	決済事業者でシステムエラーが発生した場合
	R503	決済事業者で事業者で該当の取引が有効期限切れになった場合
	R504	決済事業者で他リクエストを処理中の場合
	R505	利用者が利用したカード情報に不正・不備があった場合
	R506	利用者の楽天ポイントが残高不足の場合
	R507	決済事業者が定めるリトライのリミット回数に到達した場合
	R508	決済事業者または決済事業者の接続しているクレジットカード会社のシステムエラーが発生した場合
	R509	決済事業者のAPI スロットリングの上限数を超過した場合
	R510	楽天ポイント利用不可のため一時的に決済不可な場合
	R511	利用できない利用者のカードのため決済不可な場合
	R512	決済事業者のメンテナンス中のため決済不可な場合
	R513	加盟店様が決済事業者に事前に連絡し、決済事業者側サービスを一時的に停止している場合

支払（オーソリ）時に上記エラーが発生した場合、決済離脱を可能な限り避けるべくサイトにて利用者向けに通知を推奨している文言例をサービス仕様書のサービス仕様書＞補足資料＞各種決済手段＞楽天ペイ（オンライン決済）に記載しています。併せてご確認ください。

2. 楽天ペイ初回支払い後の与信再取得について

初回取引もしくは再支払（再オーソリ）から30日経過以降に、金額変更なしの再支払再支払（再オーソリ）を実施せずに金額変更ありの再支払（再支払（再オーソリ）または売上確定を実施した場合は、与信を再取得した後に売上確定・金額変更処理が行われます。
初回取引もしくは再支払（再支払（再オーソリ））から160日経過以降に売上確定/金額変更ありの再支払（再オーソリ）を実施する場合は、事前に金額変更なしの再支払（再オーソリ）を利用して与信の再取得を行ってください。処理期限が延長されます。
初回支払い時に3D セキュア認証を行っていたとしても、下記の場合において与信再取得を行った場合3Dセキュアが無効です。3Dセキュア認証が無効の状態で不正利用が発生した場合には、従来通りチャージバックは加盟店様のご負担ですのでご注意ください。
- 再支払（再オーソリ）　
- 初回取引もしくは再支払（再オーソリ）から30日経過以降の売上確定

d払い詳細

1. d払いエラーコード一覧

リクエスト項目チェックエラー

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
1701	D101	`successUrl`(リダイレクトURL)の項目に対しての入力チェックエラーが発生した
	D102	`failureUrl`(リダイレクトURL)の項目に対しての入力チェックエラーが発生した
	D103	`cancelUrl`(リダイレクトURL)の項目に対しての入力チェックエラーが発生した
	D105	`amount.value`(決済金額)
	D106	`amount.currencyCode`(通貨コード)
	D107	`displayedContents1`(表示項目内容1)の項目に対しての入力チェックエラーが発生した
	D108	`displayedContents2`(表示項目内容2)の項目に対しての入力チェックエラーが発生した
	D109	`merchantParameter`(加盟店パラメータ)の項目に対しての入力チェックエラーが発生した
	D110	`connectionMode`(ISP種別)の項目に対しての入力チェックエラーが発生した
	D111	`contactInfo`(連絡情報)の項目に対しての入力チェックエラーが発生した
	D112	`requestId` (リクエストを識別するID)
	D113	`customerId` (顧客ID)
	D114	`accountMethodId` (決済手段登録番号)

取引情報引当時の整合性チェックエラー

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
1701	D601	引当必須のアクションで関連する取引のIDが指定されなかった
	D602	正常終了しない決済を取引対象にしようとした
	D603	支払キャンセル、売上確定で、支払以外の引当元を指定しようとした（該当取引が支払キャンセルなど支払以外の後続アクションに進んでいる場合も含む）
	D604	売上確定した決済に対して支払キャンセルを実施した
	D605	売上未確定の決済に対して返金を実施した
	D606	支払した金額以外の金額で支払キャンセルを実施した
	D607	支払した金額以外の金額で売上確定を実施した
	D608	障害取消済の決済に引き当てをしようとした
	D609	引当に指定した取引が存在しなかった
	D610	d払い決済で未使用のアクションで連携された
	D611	現在の売上確定額よりも多い金額で、返金を実施した
	D612	障害取消不可の決済を取引対象にしようとした
	D613	支払した金額と異なる金額で全額返金を実施した
	D614	障害取消が必要な取引に対して障害取消を実施せずに後続アクションを実施しようとした
	D615	決済事業者が処理中の支払または同時売上に対して、障害取消を実施した

その他エラー

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
2701	D700	内部エラー
3701	D701	内部エラー（障害取消要）

決済事業者エラー

詳細は決済事業者にお問い合わせください。

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
5701	D801	利用者認証中にエラーが発生した場合
	D802	決済事業者で問題が発生した場合
	D803	認証情報の不一致を検知した場合
	D804	認証セッションの有効期限切れを検知した場合
	D805	提供された認可を得ていることを示す値(認可コード、利用者を示す値)が不正/有効期限切れ/失効している場合
	D806	決済事業者で問題が発生した場合
	D807	利用者に対して認証画面の表示が必要であると決済事業者が判定した場合
	D808	利用者に対して認可画面の表示が必要であると決済事業者が判定した場合
	D809	利用者認証中にエラーが発生した場合
	D810	利用者認証中にエラーが発生した場合
	D811	利用者認証中にエラーが発生した場合
	D812	提供された認可を得ていることを示す値(認可コード、利用者を示す値)が不正/有効期限切れ/失効している場合
	D813	決済事業者で問題が発生した場合
	D814	決済事業者で問題が発生した場合
	D815	決済事業者で問題が発生した場合
	D816	決済事業者で問題が発生した場合
	D817	要求受付済みの決済に対し、再度要求を行った場合
	D818	完了要求実施最終期限（返金可能期限）超過後に売上確定やキャンセルを行った場合
	D819	リクエストパラメータに指定した内容に該当する決済がない、または決済事業者で決済情報を保持する期限を超過したため決済がない場合
	D820	要求を行った決済が、すでに処理済みの場合
	D821	決済事業者で問題が発生した場合
	D822	要求を行った決済が、利用判定がNGとなった場合
	D823	電話料金合算払いの決済で決済事業者の回線を解約後6ヵ月以降に要求を行った場合
	D824	利用者の決済手段がdカードまたはdカード以外のクレジットカードを利用した決済において、利用判定がNG、または、返金可能期限超過後に、キャンセル要求を行った場合
	D825	決済事業者内でのタイムアウト（決済事業者での処理開始から最大15分）などの場合
	D826	決済事業者が、システムメンテナンス中など何らかの理由により受付できない場合
	D827	決済金額に、決済上限金額を超える値が設定された場合
	D828	決済事業者側に必須情報が登録されていない場合
	D829	利用承諾時に利用した回線契約情報やdアカウント情報が解約などで存在しない場合
	D830	決済事業者の利用判定でNGとなり、利用できない場合
	D831	決済金額が利用者の電話料金合算払いご利用限度額を超える場合
	D832	決済金額が利用者のクレジットカードご利用限度額を超える場合
	D833	利用者のクレジットカード有効期限切れの場合
	D834	決済金額が利用者のクレジットカードご利用限度額（当月の「dカード」と「dカード以外のクレジットカード」利用合計金額の上限）を超える場合
	D835	利用者のdアカウントがビジネスdアカウントの場合
	D836	決済事業者で問題が発生した場合
	D837	同一の利用者に対し複数件の処理が同時に行われた場合
	D838	要求を受け付け、ドコモ内で処理中の場合
	D839	利用者が決済を中断した場合
	D840	決済事業者が、システムメンテナンス中など何らかの理由により受付できない場合
	D841	本サービスまたは決済事業者が決済を中断した場合

au PAY 詳細

returnUrlに付与されるクエリパラメータ

au PAYで支払を行った後の遷移先となるreturnUrlには処理結果としてクエリパラメータにresultCdが付与されます。

resultCd詳細

resultCd	内容	備考
001	成功
101	決済中断	auPAYアプリの確認画面で×ボタン押下
202	決済失敗

returnUrlの例

payTransactionのrequestProperty.returnUrlがhttps://sample.com/returnの場合、実際のreturnUrlはhttps://sample.com/return?resultCd=001となります。

※ au PAYアプリでの支払処理時にタイムアウトが発生した場合やブラウザのタブを閉じる等の操作を行った場合、au PAYサイトで決済が成功とも失敗とも判断出来ないためresultCdが付与されません。
returnUrlにresultCdが付与されない場合の処理の成否は、決済完了通知でご確認ください。

AmazonPay 詳細

1. Amazon Pay エラーコード一覧

決済取引

リクエスト項目チェックエラー

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
1801	AMZ101	`amount.value`（取引金額）の項目に対しての入力チェックエラーが発生した
	AMZ102	`amount.currencyCode`（通貨コード）の項目に対しての入力チェックエラーが発生した
	AMZ103	`checkoutSessionId`（`Checkout Session`を一意に特定するID）の項目に対しての入力チェックエラーが発生した
	AMZ104	`returnUrl`（決済事業者のオーソリ処理画面のURL）の項目に対しての入力チェックエラーが発生した
	AMZ105	`requestProperty`（決済手段固有の情報）の項目に対しての入力チェックエラーが発生した
	AMZ106	`transactionId`（再支払（再オーソリ）の場合`relatedTransactionId`）が支払時の取引IDではない

取引情報引当時の整合性チェックエラー

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容	備考
1801	AMZ201	売上確定金額が支払（オーソリ）時の金額と一致しない
	AMZ202	キャンセル金額が支払（オーソリ）時の金額と一致しない
	AMZ203	元取引が支払（オーソリ）に失敗している
	AMZ204	支払（オーソリ）可能金額を超えている
	AMZ205	対象の取引は`adviceTransaction`が完了していない	`adviceTransaction`を実行してください。
	AMZ206	対象の取引は`adviceTransaction`が完了している	実行可能な操作は再オーソリ、売上確定、取消のいずれかです。
	AMZ207	対象の取引は売上確定または返金が完了している	実行可能な操作は返金です。
	AMZ208	対象の取引は取消が完了している	対象の取引に実行可能な操作はありません。
	AMZ209	対象の取引の返金期限が切れている	対象の取引に実行可能な操作はありません。
	AMZ210	対象の取引は売上確定が完了していない

決済システムエラー

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
2801	AMZ301	内部エラー（決済事業者の接続前のDBへの接続エラー等）
2802	AMZ303	登録情報不正エラー（登録されたマスタ情報不正エラー等）
	AMZ304
	AMZ305

決済事業者エラー

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容	備考
5801	AMZ401	支払（オーソリ）から30日以上経過して売上確定を実施した	改めてオーソリから実施いただくか、再支払（再オーソリ）を実施後に売上確定してください。
	AMZ402	売上確定でエラーが発生した	注文をキャンセルして、利用者に異なる支払い方法を使用して決済しなおすよう依頼してください。
	AMZ403	返金でエラーが発生した	別の方法（ギフトカードなど）で利用者に返金してください。
	AMZ404	支払い方法の更新が必要	利用者に支払い方法の更新を依頼してください。
	AMZ405	支払い方法が削除されている	利用者に支払い方法を設定し直すか、別の支払い方法を選択するよう依頼してください。
	AMZ406	支払い方法の請求先住所が削除されている	利用者に支払い方法の請求先住所を設定するよう依頼してください。
	AMZ407	選択した支払い方法の有効期限が切れている	利用者に別の支払い方法を設定するよう依頼してください。
	AMZ408	支払方法が設定されていない	利用者に支払い方法を設定するよう依頼してください。
	AMZ409	別の支払い方法を設定する必要がある	利用者に別の支払い方法を設定するよう依頼してください。
	AMZ410	Amazon未ログイン状態で`payTransaction`を実施した	Amazon PayボタンからAmazonログイン後に再度実施してください。
	AMZ411	支払（オーソリ）後、`payUrl`にリダイレクトせずに`adviceTransaction`を実施した	`payUrl`にアクセス後に`adviceTransaction`を実施してください。
	AMZ413	支払金額の請求上限を超えての再支払（再オーソリ）を実施した。もしくは支払金額の請求上限に達した状態で再支払（再オーソリ）を実施した	金額を見直してください。Amazon Payでは増額の再支払の場合、70000円か支払（オーソリ）で指定した金額の900%の高い方が上限となっています。上限に達した場合、それ以降は増額・減額いずれの再支払（再オーソリ）もできません。
	AMZ414	返金金額の請求上限を超えての返金を実施した	金額を見直してください。Amazon Payでは請求金額の15％または75USD/GBP/EURまたは8,400円いずれか低い方を追加返金することが可能です。
	AMZ415	決済事業者との取引がタイムアウトした	時間をおいて再度実施してください。
	AMZ416	決済事業者がリクエスト制限中により取引を受付できない
	AMZ417	決済事業者がシステムメンテナンスにより取引を受付できない
	AMZ418	決済事業者で不明なエラーが発生した場合（再試行可）
	AMZ419	11回以上返金処理を実施した	対象の取引ではこれ以上返金が出来ません。Amazon Payでは取引あたり10回が返金の上限となります。
	AMZ420	初回取引から30日以上経過した。もしくは存在しない`Checkout Session`に対してリクエストを行った	改めてAmazonログイン後に支払（オーソリ）から実施いただくか、リクエスト内容を見直して再送してください。Amazon Payでは`Checkout Session`は、30日後に完全に削除されます。
	AMZ421	初回取引から180日以上経過した	この取引は期限が切れており利用できません。
	AMZ422	決済事業者側で不明なエラーが発生した	システム管理者にお問い合わせください。
	AMZ423	`checkoutSessionId`不正	`checkoutSessionId`が不正な値です。リクエスト内容を見直した後、再度実施してください。
	AMZ424	決済事業者からリクエストエラーが返却された	時間をおいて再度実施してください。

住所・支払情報取得

errorCode(結果詳細コード)	チェック内容	備考
AMZ211	`CheckoutSession`の状態が`Canceled`の場合	この取引は失敗しており利用できません。改めてAmazonログイン後、新しく`checkoutSessionId`を払い出してから再度実施してください。
AMZ420	初回取引から30日以上経過した。もしくは存在しない`Checkout Session`に対してリクエストを行った	改めてAmazonログイン後に実施いただくか、リクエスト内容を見直して再送してください。Amazon Payでは`Checkout Session`は、30日後に完全に削除されます。
AMZ423	`checkoutSessionId`不正	`checkoutSessionId`が不正な値です。リクエスト内容を見直した後、再度実施してください。

2. Amazon Pay 注意事項

Amazon Pay 住所・支払情報取得の補足

Amazon Pay住所・支払情報取得(getAmazonAccount)で取得できる情報はAmazon Payの仕様に依ります。以下に取得条件をまとめます。

項目	productType: PayAndShip	productType: PayOnly
`shippingAddress`（配送先住所）	〇	×
`paymentPreferences`（支払方法）	△ ※1	△ ※1
`buyer`（利用者情報）	△ ※2	△ ※2
`billingAddress`（請求先住所）	△ ※3	△ ※4

〇: 取得可、△: 条件付き取得可、×：取得不可

※1 paymentPreferencesは、Checkout Sessionが完了した後（adviceTransactionの正常終了後）には参照できなくなります。
※2 buyerはAmazon Payボタンに設定するscopesによって取得項目を選択可能です。ただし、支払方法がギフトカードのみの場合は、scopesに依らずphoneNumber（電話番号）は取得できません。
※3 billingAddressはAmazon Payボタンに設定するscopesによって要否を選択可能で、支払方法に紐づく請求先住所情報が返却されます。なお、支払方法がギフトカードのみの場合やペイディで請求先住所情報が未設定の場合は、請求先住所情報には配送先住所の値が入力され返却されます。
※4 billingAddressはAmazon Payボタンに設定するscopesによって要否を選択可能で、支払方法に紐づく請求先住所情報が返却されます。なお、支払方法がギフトカードのみの場合やペイディで請求先住所情報が未設定の場合は、請求先住所情報は取得できません。

scopesについて

scopesには以下の4つの値が設定可能です。

'name' - 利用者の氏名
'email' - 利用者のメールアドレス
'phoneNumber' - 既定の請求先住所に紐づく電話番号
'billingAddress' - 既定の請求先住所

scopesに何も設定しない場合は、productTypeで取得される情報が変わります。
PayOnlyの場合は上記４項目が返却されます。
PayAndShipの場合はname, emailが返却されます。

初回支払い後の与信再取得について

初回取引(adviceTransactionが成功し与信確保した日)もしくは再支払から30日経過以降に売上確定を実施する場合は、事前に金額変更なしの再支払（再オーソリ）を利用して与信の再取得を行ってください。取引期限が更新されます。
※再支払（再オーソリ）を利用して与信の再取得を行える期間は、初回取引から180日間です。取引期限に関しましては、詳しくは各決済手段の取引期限をご覧ください。

決済取引状態についての補足

決済取引で返却されるstateのそれぞれの意味は以下の通りです。

state	状態
`Open`	支払（オーソリ）要求完了
`Completed`	支払（オーソリ）完了
`Authorized`	再支払（再オーソリ）完了
`CaptureInitiated`※	売上確定依頼完了
`Captured`	売上確定完了
`Closed`	支払キャンセル完了
`RefundInitiated`※	返金依頼完了
`Refunded`	返金完了

※売上確定依頼、返金依頼完了状態の場合、決済事業者にてそれぞれの取引が、売上確定、返金完了状態に遷移した際、subscribeTransactionで指定したcallbackUrlに最新の取引状態の通知が送信されます。詳しくはAmazon Pay処理シーケンスの売上確定（支払後7日を超えた場合）と返金をご覧ください。

3. Amazon Pay ボタン

Amazon Payをご利用いただくには、Amazon Payボタンを加盟店サイトへ設置する必要があります。 Amazon Payボタンの生成には、Amazon社提供の専用ツール「Code Generator」をご利用いただくと便利です。

また、ご利用にあたって以下2つのAmazon社のサイトに記載されている事項も併せてご確認ください。

Code Generator 利用手順

「Code Generator」を起動いただき、各種設定値を入力いただきます。

以下、入力項目については本サービスが提供するAmazon Payをご利用いただく前提で記載しています。

Code Generator - 必須入力項目

入力項目	内容
MerchantId	Amazon Payが加盟店様を識別するためのID セラーセントラル上から「出品者ID」として取得いただけます※
Type	「Onetime：都度課金」を指定してください
Store ID	Amazon PayのStore ID セラーセントラル上から「Store ID」として取得いただけます※
Public Key Id	Amazon PayのAPIを呼び出す際に使用するID セラーセントラル上から「Public Key ID」として取得いただけます※
Checkout Review ReturnUrl	購入内容表示画面などのAmazonログイン後の遷移先URL
Region	「JP」を設定してください
Private Key	Amazon PayのAPIを呼び出す際に使用するキーセラーセントラル上から「Private Key」として取得いただけます※
Placement	Amazon Payボタンをサイト内のどのページに表示するのかを示すもの。詳しくはこちらをご参照ください。・Home - 初期ページまたはメインページ・Product - 商品詳細ページ・Cart - 購入者が決済を開始する前のカート確認ページ・Checkout - 購入者が決済を開始した後の任意のページ・Other - 上記説明に当てはまらないページ

※Amazon社が提供している加盟店向けのサイトのセラーセントラルから取得いただけます。詳細は取得手順をご参照ください。

Code Generator - 任意入力項目

入力項目	内容
Restrictions	利用者の配送先選択において制限ができます。ただし、日本国内での制限に限定されます。 use addressRestrictionsを選択 Type：「Allowed」 Regions.CountryCode：「JP」
Product Type	住所情報の利用要否・PayAndShip：住所情報を利用する・PayOnly：住所情報を利用しない（商品がデジコン、加盟店様が保持している住所情報を利用する場合） ※手動でボタンを生成する場合、本項目に「SignIn」は設定しないでください。デフォルト：PayAndShip
Scopes	住所・支払情報取得API実行時に、追加で取得できる項目選択・name：利用者名・email：利用者のメールアドレス・phoneNumber：利用者の電話番号・billingAddress：請求先住所 ※住所・支払情報取得APIで取得できる値に関しましては、getAmazonAccount及び、Amazon Pay 住所・支払情報取得の補足をご確認ください。
Checkout Cancel Url	利用者が決済をキャンセルした際にリダイレクトするURL
Button Color	Amazon Payボタンのカラー指定・Gold ・LightGray ・DarkGray デフォルト： Gold
Sandbox	sandboxを利用するか否かを設定する項目。試験環境で利用する場合はtrue、本番環境で利用する場合はfalseに設定する必要があります。デフォルト：true
Allow Overcharge	増額の再支払（再オーソリ）を許可するか否かを設定する項目許可する場合は、本項目をtrueに設定する必要があります
Extend Expiration	設定不要です（設定しないでください）

「Generate Button Code Sample」ボタンを押下すると、Signature、Payload、Code Sample が生成されます。

Code Generator - 出力項目

「Generate Button Code Sample」ボタンを押下して生成される項目です。

返却項目	内容
Signature	生成されたSignature
Payload	生成されたPayload
Code Sample	Amazon Pay ボタンのソースコード加盟店サイトのHTMLコンテナ要素として、そのまま貼り付けてご利用ください

生成された Signature、Payload、Code Sample を使用して、Amazon Pay ボタンを加盟店様サイトへ設置いただきます。

注意

手動でAmazon Payボタン生成を実施する場合、以下パラメータは設定しないでください。設定されたとしても設定値は反映されません。

項目
canHandlePendingAuthorization
paymentIntent

上記指定不可のパラメータ以外に本手順に記載されていないパラメータ、値を設定した場合、動作の保証はできかねますのでご注意ください。

配送先住所・支払方法変更ボタンの設置

配送先住所や支払方法をAmazonアカウントに複数登録している利用者が加盟店サイト（注文確認画面）から別の住所/ 支払方法へ変更できるよう、「変更」ボタンの設置をお願いいたします。
実装に関する詳細はAmazon Payインテグレーションガイドをご参照ください。

※このタイミングでAmazon Pay以外の支払方法へ変更するようなフローは避けてください。
「変更」ボタンはあくまでAmazonアカウントに登録済みの別の支払方法へ変更するためのボタンです。

銀行ネット決済詳細

銀行ネット決済エラーコード一覧

リクエスト項目チェックエラー

resultCode	errorCode(エラー詳細コード)	チェック内容
11001	NB101	`amount.value`（取引金額）の項目に対しての入力チェックエラーが発生した
	NB102	`amount.currencyCode`（通貨コード）の項目に対しての入力チェックエラーが発生した
	NB103	`paymentDetail`（決済内容）の項目に対しての入力チェックエラーが発生した
	NB104	`paymentDetailKana`（決済内容カナ）の項目に対しての入力チェックエラーが発生した
	NB105	`firstName`（利用者の名）、または`lastName`（利用者の姓）の項目に対しての入力チェックエラーが発生した
	NB106	`firstNameKana`（利用者の名（カタカナ））、または`lastNameKana`（利用者の姓（カタカナ））の項目に対しての入力チェックエラーが発生した
	NB107	`payLimitDateTime`（支払期限日時）の項目に対しての入力チェックエラーが発生した
	NB108	`requestProperty`（決済手段固有の情報）の項目に対しての入力チェックエラーが発生した

取引情報引当時の整合性チェックエラー

resultCode	errorCode(エラー詳細コード)	チェック内容	備考
11001	NB151	オーソリ、再オーソリ、売上確定、返金の取引がリクエストされる場合	実行可能な操作は同時売上もしくは取消です。
	NB152	消費者の入金（消込）済み、支払期限切れ、取消済みの取引に対して取消が実行される場合	対象の取引で可能な操作ではありません。現在の取引状態で実行可能な操作はありません。
	NB153	取消金額が支払申込金額と一致しない場合	支払申込時に設定した金額と一致させてから、再送してください。

決済システムエラー

resultCode	errorCode(エラー詳細コード)	チェック内容	備考
21001	NB201	内部エラー（決済事業者の接続前のDBへの接続エラー等）	時間をおいて再送していただくか、システム管理者にお問い合わせください。
21002	NB202	登録情報不正エラー（登録されたマスタ情報不正エラー等）	システム管理者にお問い合わせください。

支払期限日時超過エラー

resultCode	errorCode(エラー詳細コード)	チェック内容	備考
61001	NB601	指定された支払期限日時までに支払（消込）が行われなかった場合	必要に応じて再度支払申込を実施してください。

Bank Pay 詳細

1. Bank Pay エラーコード一覧

Bank Pay固有操作エラーコード一覧

以下に該当するAPIで使用されるエラーコードの一覧です。

Bank Pay固有操作
決済情報預かり（※）

※Bank Payの決済手段を操作する場合のみです。

取引情報の整合性エラー

errorCode(結果詳細コード)	チェック内容
BP207	登録対象のBank Pay口座登録番号が、決済事業者に存在しない、もしくは無効化されている
BP208	指定の顧客IDに紐づくBank Payの決済手段登録がされていない
BP209	指定の顧客IDが存在しない
BP210	利用対象外のカテゴリを指定した

その他内部エラー

errorCode(結果詳細コード)	チェック内容	備考
BP006	内部エラー	本サービス内でシステムエラーが発生したため再度リクエストをしてください。解消しない場合はシステム管理者へお問い合わせください。

決済事業者エラー

errorCode(結果詳細コード)	チェック内容	備考
BP001	決済事業者でシステムエラーが発生した場合	決済事業者への接続時にシステムエラーが発生したため再度リクエストをしてください。解消しない場合はシステム管理者へお問い合わせください。
BP004	決済事業者の一時的メンテナンス中の場合	決済事業者にてメンテナンス作業を行っているため、サービスが利用できません。メンテナンス終了までしばらくお待ちください。
BP007	決済事業者で想定外のエラーが発生した場合	決済事業者への接続時に想定外のエラーが発生したため再度リクエストをしてください。解消しない場合はシステム管理者へお問い合わせください。
BP008	決済事業者へのアクセスが集中している場合	決済事業者へのアクセスが集中しているため、一時的にサービスが利用できません。時間を空けて、再度リクエストしてください。
BP409	更新対象の情報が処理中	一度`listRegisteredBankAccounts`で状態を確認したうえで、必要であれば再度リクエストをしてください。

決済取引エラーコード一覧

以下に該当するAPIで使用されるエラーコードの一覧です。

決済取引（※）

※Bank Payの決済取引を実施する場合のみです。

リクエスト単項目チェックエラー

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
11101	BP102	`customerId`の項目に対しての入力チェックエラーが発生した
	BP103	`accountMethodId`の項目に対しての入力チェックエラーが発生した
	BP104	`category`の項目に対しての入力チェックエラーが発生した
	BP105	`fixedBankbookMerchantName`の項目に対しての入力チェックエラーが発生した
	BP106	`optionalBankbookMerchantName`の項目に対しての入力チェックエラーが発生した
	BP107	`amount.value`の項目に対しての入力チェックエラーが発生した
	BP108	`amount.currencyCode`の項目に対しての入力チェックエラーが発生した

取引情報の整合性エラー

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
11102	BP321	利用対象外のカテゴリを指定した
	BP322	指定の顧客IDと決済手段登録番号に紐づく、Bank Payの決済手段登録がされていない
	BP323	返金を「売上確定」の状態以外の取引に実施した
	BP324	引き当て対象の取引が存在しなかった
	BP325	Bank Payでは対応していない取引アクションを指定した
	BP328	売上確定金額と返金金額が一致していない
	BP329	リクエストの顧客IDに紐づく会員情報が未登録
	BP330	対象の口座が無効化されている
	BP332	障害取消を「売上確定」の状態以外の取引に実施した

その他内部エラー

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容
21101	（設定なし）	※内容はresultCodeを参照ください
31101	（設定なし）	※内容はresultCodeを参照ください

決済事業者エラー

resultCode(結果コード)	errorCode(結果詳細コード)	チェック内容	備考
51101	BP402	決済1回の利用金額が、金融機関の利用上限金額を超えている	エラー内容に従いリクエストの見直し等をしてください。解消しない場合はシステム管理者へお問い合わせください。
	BP403	決済1回の利用金額が、会員の利用上限金額を超えている
	BP404	当日利用金額が、金融機関の利用上限金額を超えている
	BP405	当日利用金額が、会員の利用上限金額を超えている
	BP408	対象の会員は処理中
	BP409	更新対象の情報が処理中
	BP410	対象の会員が無効化されている
	BP411	指定の金融機関がBank Payに対応していない
	BP412	指定の金融機関が口座振替に対応していない
	BP413	返金、及び障害取消の操作可能期限を超過している
51102	BP001	決済事業者でシステムエラーが発生した場合	決済事業者への接続時にシステムエラーが発生したため再度リクエストをしてください。解消しない場合はシステム管理者へお問い合わせください。
	BP004	決済事業者のメンテナンス中の場合	決済事業者にてメンテナンス作業を行っているため、一時的にサービスが利用できません。メンテナンス終了までしばらくお待ちください。
	BP007	決済事業者で想定外のエラーが発生した場合	決済事業者への接続時に想定外のエラーが発生したため再度リクエストをしてください。解消しない場合はシステム管理者へお問い合わせください。
	BP008	決済事業者へのアクセスが集中している場合	決済事業者へのアクセスが集中しているため、一時的にサービスが利用できません。時間を空けて、再度リクエストしてください。
51103	BP002	決済事業者でシステムエラーが発生した場合（障害取消が必要）	決済事業者への接続後にエラーが発生したため、`payTransaction`実行時に本`errorCode`が返却された場合、障害取消を実施したうえで、再度リクエストをしてください。それ以外の場合は、再度リクエストしてください。また、解消しない場合はシステム管理者へお問い合わせください。 ※BP003は解消しない場合、時間を空けて対応をしてください ※BP005は解消しない場合、メンテナンス完了後に対応をしてください。
	BP003	決済事業者へのアクセスが集中している場合（障害取消が必要）
	BP005	決済事業者のメンテナンス中の場合（障害取消が必要）
51104	G06	口座の残高が不足している	こちらのエラーが発生した場合は各チェック内容を参照し、リクエスト内容を再度見直してください。解決しない場合はシステム管理者にお問い合わせください。
	G07	限度額を超えている
	G42	お客様の入力した暗証番号が誤っている
	G43	誤入力許容回数をオーバーしている
	G60	事故カードが使用された
	G65	会員番号の入力が誤っている
	G68	金額の入力が誤っている
	G77	業務区分が誤っている
	G78	支払方法が誤っている
	G80	取消区分が誤っている
	G81	取扱区分が誤っている
	G83	有効期限切れのカードが使用される
	G85	利用できないカードが使用される
	G91	金融機関側のシステムが障害中
	G94	取扱できない取引内容
	G95	当該業務が終了している
	G97	何らかの理由によりリクエストを処理できない
	G98	対象業務以外の電文を受信した
	G99	契約のないセンタからデータを受信した

Bank Pay口座登録リダイレクトエラー

口座リダイレクトAPIで使用されるエラーコードの一覧です。
口座リダイレクトAPIの詳細はBank Pay 口座登録リダイレクトを参照ください。

HTTPステータス	errorCode	チェック内容	備考
400	E000001	リクエストパラメータに必須パラメータが未設定の場合	リクエストパラメータに不正がある場合に設定します。対象パラメータが複数ある場合は結果詳細説明文にカンマ繋ぎでパラメータ名を複数設定します。例)パラメータチェックでエラーが発生しました。対象パラメータ : [bankCode,branchCode]
	E000002	リクエストパラメータの桁数が間違っていた場合
	E000003	リクエストパラメータの属性が間違っていた場合
	E000004	リクエストパラメータの値が間違っていた場合
	E110027	対象の会員情報が処理中の場合	口座登録時に対象の会員情報が処理中の場合（複数端末から同時に実行した場合）に設定します。
	E110029	利用可能な金融機関でない場合	対象の金融機関が利用可能な金融機関でない場合に設定します。
	E110040	口座登録数が上限を超えた場合	口座登録時に登録可能上限数まで、口座が登録済の場合に設定します。
	E110041	口座振替受付対象でない場合	口座振替受付対象外の金融機関に対して、口座登録時に、銀行口座振替有（口座振替受付フラグ = true）が指定した場合に設定します。
	E110045	不正なセッション情報を指定した場合	登録結果通知時に不正なセッション情報を指定した場合に設定します。
	E110057	リクエストと異なる口座を登録した場合	登録結果通知で、金融機関での処理結果が口座登録（銀行口座振替有）のリクエストと異なる金融機関となった場合に設定します。
	E500005	更新対象の情報が存在しない場合	口座ステータス変更時に更新対象の会員情報、口座情報がBank Payに存在しない場合に設定します。
	E500007	会員情報が未登録の場合	口座登録、口座入力情報照会、金融機関上限金額照会時に更新対象の会員情報がBank Payに存在しない場合に設定します。
	E500013	口座登録済みの場合	登録しようとした口座情報がすでにBank Payに存在する場合、設定します。
	E520001	決済事業者で問題が発生した場合	口座登録時に取引時間外、銀行コード不正など何らかの理由で金融機関が処理を拒否した場合に設定します。
	E710001	口座登録リダイレクト式で口座の二重登録が発生した場合	口座登録リダイレクト式でユーザがブラウザの戻るボタンを押下した場合などで再度同じ口座情報を登録しようとした場合に設定します。
	E710002	認証情報の不一致を検知した場合	口座登録リダイレクト式の場合に、メッセージ認証コードの内容に誤りがある場合に設定します。
401	E100001	アクセストークンの認証に失敗した場合	アクセストークンの認証に失敗した場合に設定します。
401	E710097	口座登録リダイレクト式でセッションタイムアウトが発生した場合	ユーザのウェブブラウザにエラー画面を表示します。
500	E100099	決済事業者で問題が発生した場合	Bank Pay内部で何らかの理由でエラーが発生した場合に設定します。決済事業者へお問い合わせください。
	E110099	決済事業者で問題が発生した場合	Bank Pay内部で何らかの理由でエラーが発生した場合に設定します。決済事業者へお問い合わせください。
	E500011	アクセス集中により一時的にサービスが利用できない場合	アクセスが集中しており、一時的にサービスが利用できない際に設定します。
	E500099	決済事業者で問題が発生した場合	Bank Pay内部で何らかの理由でエラーが発生した場合に設定します。何度か試行してエラーが続く場合、決済事業者へお問い合わせください。
	E520099	決済事業者で問題が発生した場合	Bank Pay内部で何らかの理由でエラーが発生した場合に設定します。何度か試行してエラーが続く場合、決済事業者へお問い合わせください。
	E710096	決済事業者で問題が発生した場合	口座登録リダイレクト式でBank Pay内部で何らかの理由でエラーが発生した場合に設定します。決済事業者へお問い合わせください。
	E710099	決済事業者で問題が発生した場合	口座登録リダイレクト式でBank Pay内部で何らかの理由でエラーが発生した場合に設定します。決済事業者へお問い合わせください。Bank Payで戻り先URLに遷移できないエラーの場合、ユーザのウェブブラウザにエラー画面を表示します。
502	E520002	金融機関で問題が発生した場合	口座登録時、金融機関側で何らかの異常が発生した場合に設定します。
503	E100005	メンテナンス中の為、サービスの利用不可の場合	Bank Payにてメンテナンス作業を行っており、一時的にサービスが利用できない際に設定します。レスポンス項目の処理日時と処理番号を設定します。
	E100006	アクセス集中により一時的にサービスが利用できない場合	アクセスが集中しており、一時的にサービスが利用できない際に設定します。
	E100007	メンテナンス中の為、サービスの利用不可の場合	Bank Payにて全システム停止を伴うメンテナンス作業を行っており、一時的にサービスが利用できない際に設定します。レスポンス項目の処理日時と処理番号は設定しません。口座登録リダイレクト式の場合、ユーザのウェブブラウザにエラー画面を表示します。
	E520003	メンテナンス中の為、サービスの利用不可の場合	Bank Payにてメンテナンス作業を行っており、一時的にサービスが利用できない際に設定します。レスポンス項目の処理日時と処理番号を設定します。
504	E100098	処理中にタイムアウトした場合	処理中にタイムアウトが発生した場合に設定します。決済事業者へお問い合わせください。
	E110001	処理中にタイムアウトした場合	処理中にタイムアウトが発生した場合に設定します。決済事業者へお問い合わせください。
	E110007	処理中にタイムアウトした場合	処理中にタイムアウトが発生した場合に設定します。決済事業者へお問い合わせください。
	E500098	処理中にタイムアウトした場合	処理中にタイムアウトが発生した場合に設定します。何度か試行してエラーが続く場合、決済事業者へお問い合わせください。
	E710098	処理中にタイムアウトした場合	処理中にタイムアウトが発生した場合に設定します。決済事業者へお問い合わせください。
-	上記以外コード	想定外のエラーコードを設定した場合	決済事業者へお問い合わせください。

2. Bank Pay 口座登録リダイレクト

※Bank Pay開発用SDKをご利用の場合は、本APIの呼び出し処理を直接実装頂く必要はございません。本章ではAPI仕様を確認頂き、実際の開発は別紙で配布しています、SDK用の開発ドキュメントに沿って進めて頂く必要があります。

決済事業者Bank Payが提供する口座登録リダイレクトAPIです。

リクエスト接続条件

商用環境

項目	説明
URL	https://web.ps.cafis-jdebit.com/v1/accounts/register
HTTP Version	1.1
HTTP Methods	POST
Encode	UTF-8

リクエストヘッダ例

RFCに準じて設定してください。
Content-Length:xxxはメッセージ本文の長さに応じて可変です。

content-type:application/x-www-form-urlencoded
accept:text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9
accept-encoding:gzip, deflate, br
accept-language:ja,en-US;q=0.9,en;q=0.8
content-length:xxx

レスポンス接続条件

加盟店様で準備する戻り先URLは、以下の仕様を満たす必要があります。

項目	説明
HTTP Version	1.1
HTTP Methods	POST
Encode	UTF-8

レスポンスヘッダ例

RFCに準じて以下のようにヘッダを付与します。 Content-Length:xxxはメッセージ本文の長さに応じて可変です。

content-type:application/x-www-form-urlencoded
accept:text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9
accept-encoding:gzip, deflate, br
accept-language:ja,en-US;q=0.9,en;q=0.8
content-length:xxx

リクエスト内容

設定要否の記号説明

〇：必須
△：getBankAccountInputInfo（口座入力情報取得）でレスポンスの値にtrueが設定されている場合は必須
レスポンスに存在しないパラメータは任意

パラメータ名	内容	タイプ	桁数	設定要否	備考
isValid	有効区分	string[半角英字]	最大5	△	口座の有効区分。"true"または"false"のみ設定可能当該パラメータの設定が無かった場合は"true"を設定します。 "false"を設定した場合は無効状態の口座が登録されるため、基本的には"true"を設定してください。
bankCode	金融機関コード	string[半角数字]	4	〇	登録口座の金融機関コード
branchCode	支店コード	string[半角数字]	3	△	登録口座の支店コード
depositType	預金種目	string[半角数字]	1	△	登録口座の預金種目コード 1:普通預金 2:当座預金
accountNum	口座番号	string[半角数字]	7	△	登録口座の口座番号
accountName	口座名義人名	string[全角英数カナ記号]	最大30	△	登録口座の口座名義人名金融機関ごとに使用可能文字が異なります。詳細はBank Pay 使用可能文字を参照ください。
accountLabel	口座ラベル	string[指定なし]	最大50	△	登録対象の口座に別名を登録したい場合に設定します。
backURL	戻り先URL	string[半角英数字+Bank Pay半角記号③] Bank Pay半角記号③の詳細はBank Pay 使用可能文字を参照ください。	最大256	〇	加盟店様の戻り先のURL リクエスト時にURLエンコードは不要
optionalNotificationItem	戻り先URL通知用任意項目	string[半角英数字]	最大128	△	加盟店様で任意に設定します。戻り先のURLへのレスポンス用の任意設定項目
cAccessToken	会員用アクセストークン	string[半角英数字+半角記号①]	32	〇	Omniの口座認証情報取得APIで取得した値を設定します。
processorAuthenticationKeyIndex	Pay事業者認証鍵世代番号	string[半角数字]	2	〇	MAC生成に指定する鍵の世代番号 Bank Payから加盟店様ごとにあらかじめ払い出します。
MAC	メッセージ認証コード	string[半角英数字+(/ + =)]	44	〇	生成方法については Bank Pay MAC生成方法を参照ください。

リクエストサンプル

<form method="post" target="popup" action="https://xxxx.xxx/v1/accounts/register">
    <input type="hidden" name="isValid" value="true">
    <input type="hidden" name="bankCode" value="9999">
    <input type="hidden" name="branchCode" value="001">
    <input type="hidden" name="depositType" value="1">
    <input type="hidden" name="accountNum" value="7777777">
    <input type="hidden" name="accountName" value="テスト">
    <input type="hidden" name="accountLabel" value="test">
    <input type="hidden" name="backURL" value="https://hogehoge.test.com/api/notice">
    <input type="hidden" name="optionalNotificationItem" value="test">
    <input type="hidden" name="cAccessToken" value="66b541ccb4e467d1d56efdc9f962df7f">
    <input type="hidden" name="processorAuthenticationKeyIndex" value="01">
    <input type="hidden" name="MAC" value="ny43u9tgeb3y7kh5cnc9b7mxiwpgjfrjciir87hr7seh">
</form>

レスポンス内容

設定有無の記号説明

〇：必ず設定
△：特定の場合にのみ設定
空白：設定されない

パラメータ名	内容	タイプ	桁数	設定有無		備考
パラメータ名	内容	タイプ	桁数	正常	異常	備考
payEnterpriserId	Pay事業者ID	string[半角英数字]	10	〇		会員アクセストークンに紐づいているPay事業者ID
merchantUserId	Bank Pay顧客ID	string[半角英数字+半角記号①]	最大60	〇		Bank Pay決済事業者側で顧客を識別するID 会員アクセストークンに紐づいている顧客IDと同じ値になります（SDKご利用時も同様になります）
bankProcessingDate	金融機関取扱年月日	string[半角数字]	8	〇		金融機関で処理が行われた年月日書式はYYYYMMDD
bankProcessingTime	金融機関取扱時刻	string[半角数字]	6	〇		金融機関で処理を実行した時刻書式はHHMMSS
bankProcessingNumber	金融機関取扱番号	string[半角数字]	15	△		金融機関で採番した処理通番金融機関が設定しない場合は設定しません。
accountMethod	決済手段登録番号	string[半角数字]	2	〇		口座登録時にBank Payが払い出します。加盟店様で保存する必要があります。支払、照会時のリクエストに設定します。
isValid	有効区分	string[半角英字]	最大5	〇		リクエストパラメータの値と同じ(設定が無かった場合はtrue)
bankCode	金融機関コード	string[半角数字]	4	〇		登録された金融機関コード
branchCode	支店コード	string[半角数字]	3	〇		登録された支店コード
depositType	預金種目	string[半角数字]	1	〇		登録された預金種目 1:普通預金 2:当座預金
accountNum	口座番号	string[半角数字]	7	〇		登録された口座番号
accountName	口座名義人名	string[指定なし]	最大30	〇		登録された口座名義人名
accountLabel	口座ラベル	string[指定なし]	最大50	△		リクエストパラメータの値と同じ
optionalNotificationItem	戻り先URL通知用任意項目	string[半角英数字]	最大128	△		リクエストパラメータの値と同じ
processorAuthenticationKeyIndex	Pay事業者認証鍵世代番号	string[半角数字]	2	〇		Bank Payと契約時にBank Payが加盟店様ごとに払い出すPay事業者認証鍵世代番号 MAC生成に使用します。
MAC	メッセージ認証番号	string[半角英数字+(/ + =)]	44	〇		口座情報から生成するMAC 生成方法については Bank Pay MAC生成方法を参照ください。
processingDate	処理日時	string[半角数字記号]	19	〇	△	Bank Payが処理を実行した日時書式はYYYY-MM-DD△HH:mm:ss(△は半角スペース) Bank Payにて全システム停止を伴うメンテナンス中の場合は設定しません。
transactionId	処理番号	string[半角英数字 + 半角記号①]	36	〇	△	Bank Payが払い出します。 Bank Payにて全システム停止を伴うメンテナンス中の場合は設定しません。
errorCode	エラーコード	string[半角英数字]	7		〇	異常時に設定します。詳細はBank Pay エラーコード一覧を参照ください。
errorMessage	エラーメッセージ	string[指定なし]	最大300		〇	異常時に設定します。

レスポンスサンプル

正常時

<body onload="document.querySelector('form').submit();">
    <form method="POST" action="https://hogehoge.test.com/api/notice">
        <input type="hidden" name="payEnterpriserId" value="BPxxxxxxxx">
        <input type="hidden" name="merchantUserId" value="testuser">
        <input type="hidden" name="bankProcessingDate" value="20200101">
        <input type="hidden" name="bankProcessingTime" value="123456">
        <input type="hidden" name="bankProcessingNumber" value="012345678901234">
        <input type="hidden" name="accountMethod" value="01">
        <input type="hidden" name="isValid" value="true">
        <input type="hidden" name="bankCode" value="9999">
        <input type="hidden" name="branchCode" value="001">
        <input type="hidden" name="depositType" value="1">
        <input type="hidden" name="accountNum" value="1000000">
        <input type="hidden" name="accountName" value="ﾃｽﾄ">
        <input type="hidden" name="accountLabel" value="test">
        <input type="hidden" name="optionalNotificationItem" value="test">
        <input type="hidden" name="processorAuthenticationKeyIndex" value="01">
        <input type="hidden" name="MAC" value="ny43u9tgeb3y7kh5cnc9b7mxiwpgjfrjciir87hr7seh">
        <input type="hidden" name="processingDate" value="2020-01-01 12:34:56">
        <input type="hidden" name="transactionId" value="01abcfef-a91d-4d6b-8a61-554ec7a09695">
    </form>
</body>

異常時

<body onload="document.querySelector('form').submit();">
    <form method="POST" action="https://hogehoge.test.com/api/notice">
        <input type="hidden" name="errorCode" value="E100001">
        <input type="hidden" name="errorMessage" value="OAuthの認証でエラーが発生しました">
        <input type="hidden" name="processingDate" value="2020-01-01 12:34:56">
        <input type="hidden" name="transactionId" value="01abcfef-a91d-4d6b-8a61-554ec7a09695">
    </form>
</body>

異常時（戻り先URLにリダイレクトできない場合）

会員のウェブブラウザにエラー画面を表示して終了します。
エラーコードの詳細については、Bank Pay口座登録リダイレクトエラーを参照ください。

通知できないケース

・ユーザがウェブブラウザを閉じた場合
・セッションタイムアウトが発生した場合
・金融機関サイトで処理継続できないエラーが発生した場合

エラー画面サンプル

<!DOCTYPE html>
<html>

<head>
    <title>Bank Pay</title>
</head>

<body>
    <h3>Bank Pay</h3>
    <p>
        処理中にエラーが発生しました<br>
        再度口座登録を実施してください<br>
        (エラーコード：E710099)<br>
        <br>
        ブラウザを閉じてください
    </p>
</body>

</html>

口座登録リダイレクトのセッションタイムアウト値

Bank Payが加盟店様からリクエストを受信してからレスポンスを戻り先URLへの送信までのセッションタイムアウト値は600秒です。
加盟店様側のタイムアウト値は750秒以上を推奨します。
タイムアウト値を750秒よりも短い値に設定した場合、処理が完了する前にセッションタイムアウトとなる可能性があるため、内部処理との結果不整合が生じる可能性があります。

ブラウザ推奨環境

次の表に会員が利用するウェブブラウザの推奨環境を示します。

項目	推奨環境
ブラウザ	以下の最新版・Apple Safari ・Google Chrome ・Mozilla Firefox
Cookie	許可（必須）
TLS	TLS 1.2（SSL2.0、SSL3.0、TLS1.0は不可）（必須）

3. Bank Pay MAC生成方法

目的

MAC（Message Authentication Code）は従来、相手から送られてきたメッセージが通信途中で改ざんされていないかどうかをチェックするために使用します。

口座登録リダイレクト式においては、ユーザブラウザを介して加盟店様とBank Pay間で送信する電文について、双方でチェック可能となるようにMACを付与します。

MAC生成してセットするまでの流れ

MACの生成に必要なもの

・リクエストまたはレスポンスのパラメータの設定値
・Pay事業者認証鍵（Bank Payサービス申請時にBank Payが払い出します）
・上記二種の文字列を結合した文字列

例：電文が以下で、MACの生成に指定されているパラメータが「userId, status」の場合

{
"userId": "AAA",
"type": "BBB",
"status":"CC",
}

Pay事業者認証鍵が"aiueo"だとすると、MACの生成元となるのは以下のバイト列（ASCIIで表記）です。

AAACCaiueo

MACの生成の流れ

1. 対象電文項目の値を結合
2. 結合した文字列にPay事業者認証鍵を結合
3. 結合した文字列に対してSHA-256でハッシュを生成
4. 生成したハッシュにBase64形式でエンコード
5. エンコード結果をリクエスト項目の「メッセージ認証コード」(MAC)にセット

MAC生成の指定パラメータ

口座登録リダイレクト（リクエスト）

パラメータ名	内容	タイプ	桁数
bankCode	金融機関コード	string[半角数字]	4
cAccessToken	会員用アクセストークン	string[半角英数字 + 半角記号①]	32

口座登録リダイレクト（レスポンス）

パラメータ名	内容	タイプ	桁数
payEnterpriserId	Pay事業者ID	string[半角英数字]	10
merchantUserId	Bank Pay顧客ID	string[半角英数字 + 半角記号①]	最大60
accountMethod	決済手段登録番号	string[半角数字]	2
bankCode	金融機関コード	string[半角数字]	4

4. Bank Pay 使用可能文字

Bank Payにおける使用可能文字の詳細です。

各API項目の制限欄に記載があるものの定義は以下の通りです。

型	使用可能文字
Bank Pay半角記号①	! " # $ % & ' ( ) * + , ‐ . @ [ ] ^ _ ` {
Bank Pay半角記号②	\ , . ( ) ‐ / * ｢｣ $ + 半角スペース
Bank Pay半角記号③	‐ . _ ~ % : / ? # [ ] @ ! $ & ' ( ) * + , ; =

リクエストパラメータ「口座名義人名」の使用可能文字

使用可能文字

全角英数カナ記号で使用できる文字は以下の通りです。

型	使用可能文字
全角数字	０１２３４５６７８９
全角英字	ＡＢＣＤＥＦＧＨＩＪＫＬＭＮＯＰＱＲＳＴＵＶＷＸＹＺａｂｃｄｅｆｇｈｉｊｋｌｍｎｏｐｑｒｓｔｕｖｗｘｙｚ
全角カナ	アイウエオカキクケコサシスセソタチツテトナニヌネノハヒフヘホマミムメモヤユヨラリルレロワヲンヴガギグゲゴザジズゼゾダヂヅデドバビブベボパピプペポァィゥェォヵヶッャュョヮ
全角記号	￥，．（）ー－／＊「」＄＋＆全角スペース “ー”は全角長音、”－”は全角マイナス(※1)

(※1) 全角長音、全角マイナスとして使用できる文字は以下の通りです。ただし、金融機関に中継する場合は、No.2,3,5,6,7はNo.4に変換して中継します。

No	記号	Unicode名	文字コード(SJIS)	文字コード(Unicode)
1	ー	Katakana-Hiragana Prolnged Sound Mark	815B	30FC
2	―	Horizontal Bar	815C	2015
3	‐	Hyphen	815D	2010
4	－	Minus Sign	817C	2212
5	─	Box Drawings Light Horizontal	849F	2500
6	━	Box Drawings Heavy Horizontal	84AA	2501
7	－	Fullwidth Hyphen-Minus	変換不可	FF0D

金融機関ごとの使用可能文字

口座登録を行う際に指定するリクエストパラメータ「口座名義人名」においては、金融機関ごとに記号などの一部につき使用不可能文字を設けます。
使用可・使用不可文字のパターン、ならびに金融機関ごとの利用パターンは以下の通りです。
○：使用可　－：使用不可

パターン	￥	，	．	（	）	ー	－	／	＊	「	」	＄	＋	＆
A	○	－	○	○	○	○	○	○	－	－	－	－	－	－
B	－	○	○	○	○	○	○	－	○	－	－	－	○	○
C	○	○	○	○	○	○	○	○	－	－	－	－	－	－
D	○	○	○	○	○	○	○	○	－	○	○	－	－	－
E	－	－	○	○	○	○	－	○	－	－	－	－	－	－
F	－	－	－	○	○	○	○	－	－	－	－	－	－	－
G	○	○	○	○	○	○	○	○	○	○	○	○	○	－
H	○	○	○	○	○	○	－	○	○	○	○	○	○	○

金融機関ごとの利用パターン

金融機関	対象パターン
みずほ銀行	A
三菱UFJ銀行(※1)	B
三井住友銀行	C
セブン銀行	E
住信SBIネット銀行(※2)	F
ゆうちょ銀行	D
地方銀行	D
信用金庫	G
農業協同組合	H

(※1) 三菱UFJ銀行は、先頭文字として設定できない使用不可文字が存在します。先頭文字の使用不可能文字の詳細は以下の通りです。

型	先頭文字の使用不可文字
全角数字	すべて
全角カナ	ヲァィゥェォャュョッヵヶヮ
全角記号スペース	，．）－＊＋＆全角スペース

(※2) 住信SBIネット銀行は、数字・英字・一部カナ文字についても使用不可文字が存在します。使用不可能文字の詳細は以下の通りです。

型	使用不可文字
全角数字	すべて
全角英字	すべて
全角カナ	ヵヶヮ

リンク決済詳細

1. リンク決済利用時の注意事項

推奨ブラウザについて

利用者がリンク決済を行う際の推奨ブラウザは以下の通りです。
※以下に記載されたブラウザについて、最新バージョンに対応します。
※以下以外のブラウザ、アプリ内ブラウザ、Webview形式ではうまく動作しない可能性があります。

端末	OS	ブラウザ	言語環境
PC	Windows	Google Chrome Microsoft Edge	日本語のみ
PC	macOS	Google Chrome Safari
スマートフォン・タブレット	Android	Google Chrome
スマートフォン・タブレット	iOS	Google Chrome Safari

2. リンク決済送信メール本文

メール送信設定時、以下のテンプレートに従ってメールが送信されます。
{}で囲われた項目はリンク発行時のリクエスト項目、【】で囲われた項目は本サービスが払い出す項目(契約時の登録情報やリンク発行時のレスポンスなど)が設定されます。

リンク発行通知メール

mailType = LINK_CREATED

{customerInfo.lastName} {customerInfo.firstName} 様
 
{mailContent.freeText}
 
以下のURLをクリックし、ご注文内容・お支払金額等の確認後、画面表示に従い、決済を完了してください。
【発行された決済用リンクのURL】 
※決済サービスOmni Payment Gatewayの画面に遷移します。
 
■お支払内容(お問合せの際などに下記の情報が必要となりますので、必ずお控えください。)
------------------------------
・リンクID: 【urlId】
・注文ID: {orderId}
・お支払内容: {description}
・お支払金額: {amount}円
・お支払期限: {expiresAt}
------------------------------
 
ご不明な点がございましたら、下記までお問い合わせください。
・お問合せ先
　【決済グループ名】 TEL: 【電話番号】
 
※ 本メールは送信専用となっております。
※ また本メールに心当たりのない場合はお手数ですが、「お問合せ先」までご連絡ください。
Omni Payment Gatewayは株式会社NTTデータの決済サービスとなります。
配信元: 株式会社NTTデータ

リンク有効期限リマインドメール

mailType = REMIND

{customerInfo.lastName} {customerInfo.firstName} 様
 
{mailContent.freeText}
 
次の内容のお支払手続きのお支払期限が1日後となっております。
 
■お支払内容(お問合せの際などに下記の情報が必要となりますので、必ずお控えください。)
------------------------------
・リンクID: 【urlId】
・注文ID: {orderId}
・お支払内容: {description}
・お支払金額: {amount}円
・お支払期限: {expiresAt}
------------------------------
 
以下のURLをクリックし、ご注文内容・お支払金額等の確認後、画面表示に従い、決済を完了してください。
【発行された決済用リンク】 
※決済サービスOmni Payment Gatewayの画面に遷移します。
 
ご不明な点がございましたら、下記までお問い合わせください。
・お問合せ先
　【決済グループ名】 TEL: 【電話番号】
 
※ 本メールは送信専用となっております。
※ また本メールに心当たりのない場合はお手数ですが、「お問合せ先」までご連絡ください。
Omni Payment Gatewayは株式会社NTTデータの決済サービスとなります。
配信元: 株式会社NTTデータ

決済完了通知メール

mailType = PAY_COMPLETED

{customerInfo.lastName} {customerInfo.firstName} 様
 
{mailContent.freeText}

次の内容のお支払手続きが完了しました。
 
■お支払内容(お問合せの際などに下記の情報が必要となりますので、必ずお控えください。)
------------------------------
・リンクID: 【urlId】
・注文ID: {orderId}
・お支払内容: {description}
・お支払金額: {amount}円
・お支払期限: {expiresAt}
------------------------------
 
ご不明な点がございましたら、下記までお問い合わせください。
・お問合せ先
　【決済グループ名】 TEL: 【電話番号】
 
※ 本メールは送信専用となっております。
※ また本メールに心当たりのない場合はお手数ですが、「お問合せ先」までご連絡ください。
配信元: 株式会社NTTデータ

支払受付通知メール

mailType = PAY_ACCEPTED

支払受付通知メールは、利用者が選択した決済手段によってメッセージ内容が異なります。

コンビニ決済(番号払い)を利用した場合

{customerInfo.lastName} {customerInfo.firstName} 様
 
{mailContent.freeText}

ご注文内容・お支払金額の確認後、お支払方法の内容に従ってお支払いを完了させてください。
 
■お支払内容(お問合せの際などに下記の情報が必要となりますので、必ずお控えください。)
------------------------------
・リンクID: 【urlId】
・注文ID: {orderId}
・お支払内容: {description}
・お支払金額: {amount}円
・ご注文日時: 【支払受付の日時】
------------------------------
 
■お支払方法
下記の情報をお控えの上、お支払先で期限内にお支払いください。
------------------------------
・お支払期限: {payLimitAt}
・お支払先: 【利用者が選択した支払先コンビニ店名】
・第一番号: 【支払受付時に発行される番号】
・第二番号: 【支払受付時に発行される番号(事業者によっては存在しないため非表示となります)】
・払込票: 【支払受付時に発行される払込票のURL(事業者によっては存在しないため非表示となります)】
------------------------------
※本メールの受信後に他のお支払方法へ変更された場合、上記の受付情報は利用しないでください。
 
ご不明な点がございましたら、下記までお問い合わせください。
・お問合せ先
　【決済グループ名】 TEL: 【電話番号】
 
※ 本メールは送信専用となっております。
※ また本メールに心当たりのない場合はお手数ですが、「お問合せ先」までご連絡ください。
配信元: 株式会社NTTデータ

銀行ネット決済を利用した場合

{customerInfo.lastName} {customerInfo.firstName} 様
 
{mailContent.freeText}

ご注文内容・お支払金額の確認後、お支払方法の内容に従ってお支払いを完了させてください。
 
■お支払内容(お問合せの際などに下記の情報が必要となりますので、必ずお控えください。)
------------------------------
・リンクID: 【urlId】
・注文ID: {orderId}
・お支払内容: {description}
・お支払金額: {amount}円
・ご注文日時: 【支払受付の日時】
------------------------------
 
■お支払方法
下記の情報をお控えの上、お支払先で期限内にお支払いください。
------------------------------
・お支払期限: {payLimitAt}
・お客様番号: 【支払受付時に発行される番号】
・確認番号: 【支払受付時に発行される番号】
・収納機関番号: 【支払受付時に発行される番号】
------------------------------
ネットバンキングをご利用の場合は、以下のページから金融機関を選択しお支払いいただくこともできます。
【金融機関選択画面のURL】 

※本メールの受信後に他のお支払方法へ変更された場合、上記の受付情報は利用しないでください。
 
利用可能な金融機関やお支払方法の詳細についてはこちらをご参照ください。
https://cafishosh.service-now.com/policy?id=copy_of_kb_article_view_4&sysparm_article=KB0080318

ご不明な点がございましたら、下記までお問い合わせください。
・お問合せ先
　【決済グループ名】 TEL: 【電話番号】
 
※ 本メールは送信専用となっております。
※ また本メールに心当たりのない場合はお手数ですが、「お問合せ先」までご連絡ください。
Omni Payment Gatewayは株式会社NTTデータの決済サービスとなります。
配信元: 株式会社NTTデータ

3. リンク決済送信SMS本文

SMS送信設定時に本文を指定しなかった場合、以下のテンプレートに従ってSMSが送信されます。
{}で囲われた項目はリンク発行時のリクエスト項目、【】で囲われた項目は本サービスが払い出す項目(契約時の登録情報やリンク発行時のレスポンスなど)が設定されます。
リンク発行時に注文IDが未設定の場合は、代わりにリンクIDが表示されます。

SMS送信利用時の注意点については、SMS送信時の注意事項をご参照ください。

リンク発行通知SMS

smsType = LINK_CREATED

【決済グループ名】より

注文ID: {orderId}
金額: {amount}円
以下のURLからお支払いください。
【発行された決済リンクの短縮URL】

リンク有効期限リマインドSMS

smsType = REMIND

【決済グループ名】より

注文ID: {orderId}
金額: {amount}円
お支払期限が近づいております。以下のURLからお支払いください。
【発行された決済用リンクの短縮URL】

決済完了通知SMS

smsType = PAY_COMPLETED

【決済グループ名】より
お支払手続きが完了しました。

注文ID: {orderId}
金額: {amount}円

支払受付通知SMS

smsType = PAY_ACCEPTED

コンビニ決済(番号払い)

【決済グループ名】より

注文ID: {orderId}
金額: {amount}円

以下の情報でお支払いを完了させてください。
お支払期限: {payLimitAt}
お支払先: 【支払先コンビニ店名】
第一番号: 【支払時に発行される番号】
第二番号: 【支払時に発行される番号(事業者によっては存在しないため非表示となります)】
払込票: 【決済時に発行される払込票の短縮URL(事業者によっては存在しないため非表示となります)】

銀行ネット決済

【決済グループ名】より

注文ID: {orderId}
金額: {amount}円

下記の情報をお控えの上、銀行ネット決済がご利用可能な金融機関のATM、
またはネットバンキングでお支払いを完了させてください。

お支払期限: {payLimitAt}
お客様番号: 【支払時に発行される番号】
確認番号: 【支払時に発行される番号】
収納機関番号: 【支払時に発行される番号】

以下のページから金融機関を選択しお支払いいただくこともできます。  
【金融機関選択画面のURL】

4. リンク決済メッセージ生成パラメータ

メッセージを作成する際に利用できるパラメータです。
現在はSMSのみに対応しています。

利用可能パラメータ一覧

パラメータ	名称	表示例	文字数	発行通知	リマインド	支払受付	決済完了	備考
`{{URL}}`	決済用URL	`https://example.com`	-	◯(必須)	◯	◯	×	SMSでは22文字に短縮
`{{USER_NAME}}`	利用者氏名	オムニ太郎	0~20	◯	◯	◯	◯	`customerInfo`の`lastName`と`firstName`
`{{URL_ID}}`	リンクID	999999aa-9999-9999-9999-9a9a9a9a9a9a	36	◯	◯	◯	◯
`{{ORDER_ID}}`	注文ID	order_1231-01	0~64	◯	◯	◯	◯
`{{AMOUNT}}`	決済金額	1,980	-	◯	◯	◯	◯
`{{SHOP_NAME}}`	加盟店名	EXAMPLE店舗	-	◯	◯	◯	◯	契約時に設定した名称が表示
`{{SHOP_TEL}}`	加盟店電話番号	012-3456-7890	2~20	◯	◯	◯	◯	契約時に設定した値が表示
`{{DESCRIPTION}}`	お支払内容	お洋服代	0~255	◯	◯	◯	◯	リンク発行時に指定したdescriptionが表示
`{{EXPIRES_AT}}`	リンク有効期限	2001/01/15 23:59:59	19	◯	◯	×	×
`{{COMPLETED_AT}}`	決済完了日時	2001/01/15 23:59:59	19	×	×	×	◯
`{{PAYMENT_INFO}}`	支払に必要な情報	(下記参照)	-	×	×	◯	×

支払受付通知について

支払受付通知のみ利用できる{{PAYMENT_INFO}}は、利用者の選択した決済手段によって以下のパラメータがメッセージに設定されます。

名称	表示例	文字数	表示される決済手段	備考
支払期限	2001/01/15 23:59:59	19	コンビニ決済(番号払い) 銀行ネット決済	`payLimitAt`で設定した日時が表示
支払先コンビニ店名	EXAMPLEストア	-	コンビニ決済(番号払い)
コンビニ払込第一番号	12345678	1~50	コンビニ決済(番号払い)
コンビニ払込第二番号	87654321	1~50	コンビニ決済(番号払い)	支払先コンビニによっては表示されない
コンビニ払込票URL	`https://example.com`	-	コンビニ決済(番号払い)	支払先コンビニによっては表示されない
お客様番号	12345678901234567890	20	銀行ネット決済
確認番号	1234	4	銀行ネット決済
収納機関番号	12345	5	銀行ネット決済

`{{PAYMENT_INFO}}`埋込後の表示例

コンビニ決済(番号払い)

お支払期限: 2001/01/15 23:59:59
お支払先: EXAMPLEストア
第一番号: 12345678
第二番号: 87654321
払込票: https://example.com

銀行ネット決済

お支払期限: 2001/01/15 23:59:59
お客様番号: 12345678901234567890
確認番号: 1234
収納機関番号: 12345

以下のページから金融機関を選択しお支払いいただくこともできます。
https://example.com

5. リンク決済 SMS送信時の注意事項

SMS送信機能の利用には別途契約や利用料金が必要です。
- SMSは送信通数ごとに料金が発生します。
- メッセージの文字数が70文字を超えると、文字数に応じて複数通数のSMSを送信したものとして課金されます。
- 料金などの詳細については担当者にお問い合わせください。
SMS送信本文中のURLには制限があります。
- 一つのメッセージに含めることができるURLは最大2つまでです。
- URLの前後には半角スペースまたは改行を挿入してください。
- メッセージ中のURLは、SMS送信事業者により22文字の短縮URLに変換されます。
  - 短縮URLの形式はhttps://rh5.jp/xxxxxxxです。
4バイト文字は使用できません。
本文中の改行では\nを入れてください。
- 改行は2文字としてカウントされます。

SMS送信時エラーコード一覧

ResultCode	エラー内容	加盟店様の対応
ERR000000	SMS送信事業者がメンテナンス中で利用不可（試験環境では土日および平日0時〜9時にSMS送信を実行すると発生します）	メンテナンス時間外に再送してください。
DTL000006	通信キャリア側の都合で配信に失敗	時間をおいて再送してください。問題が解決しない場合はシステム管理者にお問い合わせください。
DTL000007	利用者の端末が圏外か電源offの可能性があるため配信に失敗	利用者の端末状況を確認いただくか、時間をおいて再送してください。
DTL000011	SMSが受信できない番号の可能性があるため配信に失敗	利用者の電話番号が正しく設定されているか確認してください。

非推奨項目一覧

こちらの章では一部加盟店様向けのAPIを記載しています。
以下に記載されたAPIの項目の使用は非推奨となっており、本サービスでは通常のAPIを推奨しています。
また非推奨とされたAPIは将来的にメンテナンス及びアップデートされないこと、ご容赦ください。
下記の表は非推奨となったAPIの項目です。詳細は下部の各種APIを参照ください。

非推奨への変更日	API名	項目名
2025/12	payTransaction	レスポンス registerAccountProperty.accountMethod.maskedAccountNumber registerAccountProperty.accountMethod.accountName registerAccountProperty.accountMethod.expiryDate
	adviceTransaction	レスポンス registerAccountProperty.accountMethod.maskedAccountNumber registerAccountProperty.accountMethod.accountName registerAccountProperty.accountMethod.expiryDate
	adviceAccountMethod	レスポンス accountMethod.maskedAccountNumber accountMethod.accountName accountMethod.expiryDate
	verifyCustomer	レスポンス accountMethod.maskedAccountNumber accountMethod.accountName accountMethod.expiryDate
	listAccountMethods	レスポンス accountMethod.maskedAccountNumber accountMethod.accountName accountMethod.expiryDate
2025/09	updateAccountMethod	レスポンス accountMethod.maskedAccountNumber accountMethod.accountName accountMethod.expiryDate
2024/11	createPaymentUrl	リクエスト linkRequestProperty.convenience.expiresAt
2024/06	createSetupUrl	リクエスト returnUrl
2022/08	PayTransaction	リクエスト creditTerminalIdentifier terminalProcessingSerialNumber
	cancelTransaction	リクエスト creditTerminalIdentifier terminalProcessingSerialNumber
	refundTransaction	リクエスト creditTerminalIdentifier terminalProcessingSerialNumber
	verifyCustomer	リクエスト creditTerminalIdentifier terminalProcessingSerialNumber
	registerAccountMethod	リクエスト creditTerminalIdentifier terminalProcessingSerialNumber token レスポンス transactionId threeDSHTML maskedAccountNumber accountName expiryDate
	adviceAccountMethod	リクエスト transactionId

PayTransaction

リクエストに関して、requestPropertyのcreditTerminalIdentifier（端末識別番号）とterminalProcessingSerialNumber（端末処理通番）を本サービスで埋めるように改修を行なったため非推奨です。
レスポンスに関して、resultRegisterAccountPropertyのaccountMethod内のmaskedAccountNumber（カード番号の下4桁以外をマスクする項目）、accountName（カード名義）、expiryDate（有効期限）をaccountMethod内のpropertyに移動したため非推奨です。

Request Body schema: application/json

One of

requestId required	string <= 70 characters 加盟店様が払い出す、リクエストを識別するID べき等性を担保し、決済取引が多重に行われることを防ぐために設定します。詳細はべき等性の担保をご参照ください。 `使用可能文字：半角英数字＋記号（_）`
paymentMethodId	string 取引に利用する決済手段ID 決済手段ごとに以下を設定してください。クレジットカード決済 - ”Credit” PayPay - ”PayPay” au PAY - ”AuPay” d払い - ”DPayment” 楽天ペイ - "RakutenPay" Bank Pay - ”BankPay” Amazon Pay - ”AmazonPay” コンビニ決済(番号払い) - ”Convenience” NP後払い - ”NPAtobarai” 銀行ネット決済 - ”NetBankingAtm” こちらのIDはlistPaymentMethodsからも取得できます。 ※初回取引の場合、必須項目。再支払（再オーソリ）の場合、任意項目
required	object
orderId	string <= 64 characters 支払（オーソリ）で設定され、情報取得のために加盟店様が払い出す、注文を識別するID このIDによって、関連するすべての取引(支払/売上/返金など)を紐づけて参照できます。 `使用可能文字：半角英数字＋記号（-_）` ※NP後払いでは、`orderId`を以下の様に利用します。 40桁以内で設定頂いた場合、利用者への発送の請求書にご注文番号として本項目を掲載します。未設定もしくは41桁以上での設定時は、payTransaction(初回支払)の`transactionId`を掲載します。
required	object requestPropertyオブジェクトこちらの項目は各種決済手段固有の情報です。 ※支払区分によって設定有無、方法が異なります。詳細支払区分設定方法をご参照ください。
captureNow	boolean Default: false 支払（オーソリ）と売上確定のタイミングを同時にするか否かを区別する項目支払に対応していない決済手段の場合、こちらの項目をtrueに設定する必要があります。 (支払への対応状況は提供機能マッピングをご確認ください) true - 同時にする false - 同時にしない
relatedTransactionId	string 関連する取引のID こちらのIDはpayTransactionのレスポンスと同じtransactionIdである必要があります。 ※再支払（再オーソリ）を実行したい場合、必須項目 ※クレジットカード決済の場合、再支払（再オーソリ）は非推奨です。支払金額を変更する場合は、correctAmountTransaction（金額補正）をご利用ください。
labels	Array of strings <= 50 items [ items [ 1 .. 255 ] characters ] ラベル加盟店様の運用に合わせて最大50個まで自由に設定いただけます。 `使用可能文字：全角半角文字（<>&は対象外）`
	object registerAccountPropertyオブジェクト requestPropertyのcardInfoに設定したカード情報を保持し、必要に応じて3Dセキュアを利用した決済に利用します。支払（3Dセキュア認証なし）で支払が失敗した場合は、カード情報は登録されません。支払（3Dセキュア認証あり）で決済追加処理（adviceTransaction）が失敗した場合は、カード情報は登録されません。 ※クレジットカード決済を行う際に使用したカード情報を登録したい場合、必須項目

Responses

Request samples

Payload

Content type

application/json

{"requestId": "sampleId_01",
"paymentMethodId": "samplepaymentMethodId",
"amount": {"currencyCode": "JPY",
"value": 1200
},
"orderId": "order_01",
"requestProperty": {"creditTerminalIdentifier": "1234567890123",
"terminalProcessingSerialNumber": "00001",
"merchantCategoryCode": "5999",
"receiveCompanyCode": "12345670001",
"productCode": "990",
"settleUnitID": "00001",
"businessName": "テスト店舗|ﾃｽﾄﾃﾝﾎﾟ|testShopName",
"cardInfo": {"primaryAccountNumber": "3540697499992567",
"accountName": "test name",
"expirationDate": "2107",
"securityCode": "123",
"securityCodeToken": "043a4f87-3b1b-497f-a9eb-d598010f4fc1",
"token": "043a4f87-3b1b-497f-a9eb-d598010f4fc1",
"customerId": "sampleCustomerId_01",
"accountMethodId": "01"
},
"threeDSInfo": {"notificationUrl": "http://domain/authResult",
"authenticationData": {"authenticationIndicator": "01",
"authenticationInfo": {"authenticationData": "sample Requestor Authentication Data",
"authenticationMethod": "01",
"authenticationTimestamp": "201908161402"
},
"challengeIndicator": "01",
"accountType": "02",
"accountId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"accountInfo": {"cardholderAccountAgeIndicator": "03",
"cardholderAccountChange": "20190816",
"cardholderAccountChangeIndicator": "01",
"cardholderAccountDate": "",
"passwordChange": "20190816",
"passwordChangeIndicator": "02",
"purchaseCount": "10",
"numberOfProvisioningAttemptsPerDay": "2",
"numberOfTransactionsPerDay": "5",
"numberOfTransactionsPerYear": "100",
"paymentAccountAge": "20181201",
"paymentAccountAgeIndicator": "05",
"shippingAddressUsage": "20181201",
"shippingAddressUsageIndicator": "04",
"shippingNameIndicator": "02",
"suspiciousAccountActivity": "02"
},
"cardholderInfo": {"addressMatchIndicator": "Y",
"billingAddress": {"city": "xxxxyyyyyoooonnnnnn",
"country": "392",
"addressLine1": "円山町１９−１",
"addressLine2": "渋谷プライムプラザ",
"addressLine3": "xxxxyyyyyoooonnnnnn",
"postalCode": "1680082",
"state": "01"
},
"cardholderName": "DATA ENUTEITEI",
"email": "sample_mail_address@nttdata.com",
"homePhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
},
"mobilePhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
},
"shippingAddress": {"city": "xxxxyyyyyoooonnnnnn",
"country": "392",
"addressLine1": "円山町１９−１",
"addressLine2": "渋谷プライムプラザ",
"addressLine3": "xxxxyyyyyoooonnnnnn",
"postalCode": "1680082",
"state": "01"
},
"workPhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
}
},
"instalmentPaymentDate": "10",
"merchantRiskIndicator": {"deliveryEmailAddress": "enuteitei@sample.co.jp",
"deliveryTimeframe": "04",
"giftCardAmount": "100000",
"giftCardCount": "02",
"giftCardCurrency": "392",
"preOrderDate": "20190711",
"preOrderPurchaseIndicator": "01",
"reorderItemsIndicator": "01",
"shippingIndicator": "03"
},
"messageCategory": "01",
"purchaseDate": "20190816160405",
"recurringExpiry": "20200831",
"recurringFrequency": "30",
"transactionType": "01"
}
},
"paymentMethod": {"paymentType": "34",
"numberOfInstallmentPayments": 36
}
},
"captureNow": false,
"relatedTransactionId": "01FDSD9KG9Z6SB678SE64ABC94",
"labels": ["ラベル"
],
"registerAccountProperty": {"customerId": "string"
}
}

Response samples

200

Content type

application/json

{"requestId": "sampleId_01",
"resultCode": 100,
"resultDescription": "正常に処理が終了しました",
"resultProperty": {"errorCode": "G12",
"approvalCode": "1234567",
"receiveCompanyCode": "12345670001",
"terminalProcessingSerialNumber": "11001",
"threeDSHTML": "<!DOCTYPE html><html><head><meta charset=\"UTF-8\"><title>ThreeDSMethodInit</title></head><body onload=\"window.location.href='https://simulator.test.3ds.com/api/v2/auth/brw/threeDsMethod?threeDSServerTransID=0dabae77-d947-4a98-96dd-23e922be5aaf'\"></body></html>",
"threeDSRedirectUrl": "https://dummy/dummy/threedsRedirectXXXXXXXXXXXXXXXXXXXXXXXXX",
"threeDSMerchantTransId": "550e8400-e29b-41d4-a716-446655440000",
"maskedPrimaryAccountNumber": "123456******1234",
"maskedNetworkTokenNumber": "123456******1234"
},
"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"status": "REQUIRES_ACTION",
"receivedTime": "2021-10-12T11:11:57+09:00",
"orderId": "order_01",
"resultRegisterAccountProperty": {"customerId": "sampleCustomerId_01",
"accountMethod": {"accountMethodId": "01",
"maskedAccountNumber": "************0000",
"accountName": "test name",
"expiryDate": "0000",
"isValid": true,
"paymentMethodId": "samplePaymentMethodId",
"property": {"maskedAccountNumber": "************0000",
"accountName": "test name",
"expiryDate": "0000"
}
},
"status": "SUCCESS",
"errorDetail": {"code": "404",
"message": "顧客が存在していません。"
}
}
}

cancelTransaction

requestPropertyのcreditTerminalIdentifier（端末識別番号）とterminalProcessingSerialNumber（端末処理通番）を本サービスで埋めるように改修を行なったため非推奨です。
レスポンスについてはcancelTransactionから変更ありません。

path Parameters

transactionId

required

string

元取引のID
こちらのIDはpayTransactionのレスポンスと同じtransactionIdである必要があります。
※再支払（再オーソリ）時も元取引のpayTransactionのレスポンスと同じtransactionIdである必要があります。

Request Body schema: application/json

One of

requestId required	string <= 70 characters 加盟店様が払い出す、リクエストを識別するID べき等性を担保し、決済取引が多重に行われることを防ぐために設定します。詳細はべき等性の担保をご参照ください。 `使用可能文字：半角英数字＋記号（_）`
required	object
labels	Array of strings <= 50 items [ items [ 1 .. 255 ] characters ] ラベル加盟店様の運用に合わせて最大50個まで自由に設定いただけます。 `使用可能文字：全角半角文字（<>&は対象外）`
required	object requestPropertyオブジェクトこちらの項目は各種決済手段固有の情報です。

Responses

Request samples

Payload

Content type

application/json

{"requestId": "sampleId_03",
"amount": {"currencyCode": "JPY",
"value": 1200
},
"labels": ["ラベル"
],
"requestProperty": {"creditTerminalIdentifier": "1234567890123",
"terminalProcessingSerialNumber": "00001",
"settleUnitID": "00001"
}
}

refundTransaction

requestPropertyのcreditTerminalIdentifier（端末識別番号）とterminalProcessingSerialNumber（端末処理通番）を本サービスで埋めるように改修を行なったため非推奨です。
レスポンスについてはrefundTransactionから変更ありません。

path Parameters

transactionId

required

string

元取引のID
こちらのIDはpayTransactionのレスポンスと同じtransactionIdである必要があります。

Request Body schema: application/json

One of

requestId required	string <= 70 characters 加盟店様が払い出す、リクエストを識別するID べき等性を担保し、決済取引が多重に行われることを防ぐために設定します。詳細はべき等性の担保をご参照ください。 `使用可能文字：半角英数字＋記号（_）`
required	object
labels	Array of strings <= 50 items [ items [ 1 .. 255 ] characters ] ラベル加盟店様の運用に合わせて最大50個まで自由に設定いただけます。 `使用可能文字：全角半角文字（<>&は対象外）`
required	object requestPropertyオブジェクトこちらの項目は各種決済手段固有の情報です。 ※支払区分によって設定有無、方法が異なります。詳細支払区分設定方法をご参照ください。

Responses

Request samples

Payload

Content type

application/json

{"requestId": "sampleId_04",
"amount": {"currencyCode": "JPY",
"value": 1200
},
"labels": ["ラベル"
],
"requestProperty": {"creditTerminalIdentifier": "1234567890123",
"terminalProcessingSerialNumber": "00001",
"settleUnitID": "00001"
}
}

adviceTransaction

リクエストついてはadviceTransactionから変更ありません。
レスポンスに関して、resultRegisterAccountPropertyのaccountMethod内のmaskedAccountNumber（カード番号の下4桁以外をマスクする項目）、accountName（カード名義）、expiryDate（有効期限）をaccountMethod内のpropertyに移動したため非推奨です。

path Parameters

transactionId

required

string

元取引のID
こちらのIDはpayTransactionもしくは、会員番号を直接設定する場合のverifyCustomerのレスポンスと同じtransactionIdである必要があります。

Request Body schema: application/json

One of

requestId required	string <= 70 characters 加盟店様が払い出す、リクエストを識別するID べき等性を担保し、決済取引が多重に行われることを防ぐために設定します。詳細はべき等性の担保をご参照ください。 `使用可能文字：半角英数字＋記号（_）`
required	object requestPropertyオブジェクトこちらの項目は各種決済手段固有の情報です。 3DセキュアのnotificationUrlに通知される情報に通知された情報（以下、通知情報）を設定してください。

Responses

Request samples

Payload

Content type

application/json

{"requestId": "sampleId_01",
"requestProperty": {"threeDSResult": {"messageVersionNumber": "ABC0001!!",
"transactionStatus": "s",
"accountholderAuthenticationValue": "ABCDEFGHIJKLMNO0123456789!%&",
"electronicCommerceIndicator": "10",
"dsTransactionId": "ABCDEFGHIJKLMNOPQRSTUVW0123456789!%&",
"threeDSServerTransactionId": "ABCDEFGHIJKLMNOPQRSTUVW0123456789!%&"
}
}
}

Response samples

Content type

application/json

{"requestId": "sampleId_01",
"resultCode": 100,
"resultDescription": "正常に処理が終了しました",
"resultProperty": {"errorCode": "G12",
"approvalCode": "1234567",
"receiveCompanyCode": "12345670001",
"terminalProcessingSerialNumber": "11001",
"maskedPrimaryAccountNumber": "123456******1234",
"maskedNetworkTokenNumber": "123456******1234"
},
"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"status": "REQUIRES_ACTION",
"receivedTime": "2021-10-12T11:11:57+09:00",
"orderId": "order_01",
"resultRegisterAccountProperty": {"customerId": "sampleCustomerId_01",
"accountMethod": {"accountMethodId": "01",
"maskedAccountNumber": "************0000",
"accountName": "test name",
"expiryDate": "0000",
"isValid": true,
"paymentMethodId": "samplePaymentMethodId",
"property": {"maskedAccountNumber": "************0000",
"accountName": "test name",
"expiryDate": "0000"
}
},
"status": "SUCCESS",
"errorDetail": {"code": "404",
"message": "顧客が存在していません。"
}
}
}

verifyCustomer

リクエストに関して、verificationPropertyのcreditTerminalIdentifier（端末識別番号）とterminalProcessingSerialNumber（端末処理通番）を本サービスで埋めるように改修を行なったため非推奨です。
レスポンスに関して、accountMethod内のmaskedAccountNumber（カード番号の下4桁以外をマスクする項目）、accountName（カード名義）、expiryDate（有効期限）をaccountMethod内のpropertyに移動したため非推奨です。

Request Body schema: application/json

One of

required

object

有効性確認の設定値です。

Responses

Request samples

Payload

Content type

application/json

{"verificationProperty": {"creditTerminalIdentifier": "1234567890123",
"terminalProcessingSerialNumber": "00001",
"cardInfo": {"customerId": "sampleCustomerId_01",
"accountMethodId": "01",
"securityCode": "123",
"securityCodeToken": "043a4f87-3b1b-497f-a9eb-d598010f4fc1",
"primaryAccountNumber": "3540697499992567",
"accountName": "test name",
"expirationDate": "2107"
},
"threeDSInfo": {"notificationUrl": "http://domain/authResult",
"authenticationData": {"authenticationIndicator": "01",
"authenticationInfo": {"authenticationData": "sample Requestor Authentication Data",
"authenticationMethod": "01",
"authenticationTimestamp": "201908161402"
},
"challengeIndicator": "01",
"accountType": "02",
"accountId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"accountInfo": {"cardholderAccountAgeIndicator": "03",
"cardholderAccountChange": "20190816",
"cardholderAccountChangeIndicator": "01",
"cardholderAccountDate": "",
"passwordChange": "20190816",
"passwordChangeIndicator": "02",
"purchaseCount": "10",
"numberOfProvisioningAttemptsPerDay": "2",
"numberOfTransactionsPerDay": "5",
"numberOfTransactionsPerYear": "100",
"paymentAccountAge": "20181201",
"paymentAccountAgeIndicator": "05",
"shippingAddressUsage": "20181201",
"shippingAddressUsageIndicator": "04",
"shippingNameIndicator": "02",
"suspiciousAccountActivity": "02"
},
"cardholderInfo": {"addressMatchIndicator": "Y",
"billingAddress": {"city": "xxxxyyyyyoooonnnnnn",
"country": "392",
"addressLine1": "円山町１９−１",
"addressLine2": "渋谷プライムプラザ",
"addressLine3": "xxxxyyyyyoooonnnnnn",
"postalCode": "1680082",
"state": "01"
},
"cardholderName": "DATA ENUTEITEI",
"email": "sample_mail_address@nttdata.com",
"homePhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
},
"mobilePhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
},
"shippingAddress": {"city": "xxxxyyyyyoooonnnnnn",
"country": "392",
"addressLine1": "円山町１９−１",
"addressLine2": "渋谷プライムプラザ",
"addressLine3": "xxxxyyyyyoooonnnnnn",
"postalCode": "1680082",
"state": "01"
},
"workPhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
}
},
"instalmentPaymentDate": "10",
"merchantRiskIndicator": {"deliveryEmailAddress": "enuteitei@sample.co.jp",
"deliveryTimeframe": "04",
"giftCardAmount": "100000",
"giftCardCount": "02",
"giftCardCurrency": "392",
"preOrderDate": "20190711",
"preOrderPurchaseIndicator": "01",
"reorderItemsIndicator": "01",
"shippingIndicator": "03"
},
"messageCategory": "01",
"purchaseDate": "20190816160405",
"recurringExpiry": "20200831",
"recurringFrequency": "30",
"transactionType": "01"
}
}
}
}

Response samples

200

Content type

application/json

{"resultProperty": {"errorCode": "G12",
"accountMethod": {"accountMethodId": "01",
"maskedAccountNumber": "************0000",
"accountName": "test name",
"expiryDate": "0000",
"isValid": true,
"paymentMethodId": "samplePaymentMethodId",
"property": {"maskedAccountNumber": "************0000",
"accountName": "test name",
"expiryDate": "0000"
}
},
"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"threeDSHTML": "<!DOCTYPE html><html><head><meta charset=\"UTF-8\"><title>ThreeDSMethodInit</title></head><body onload=\"window.location.href='https://simulator.test.3ds.com/api/v2/auth/brw/threeDsMethod?threeDSServerTransID=0dabae77-d947-4a98-96dd-23e922be5aaf'\"></body></html>",
"threeDSRedirectUrl": "https://dummy/dummy/threedsRedirectXXXXXXXXXXXXXXXXXXXXXXXXX",
"threeDSMerchantTransID": "550e8400-e29b-41d4-a716-446655440000",
"cardInfo": {"maskedAccountNumber": "************0000",
"expirationDate": "2107"
}
},
"status": "SUCCESS"
}

registerAccountMethod

リクエストに関しては、verificationPropertyのcreditTerminalIdentifier（端末識別番号）とterminalProcessingSerialNumber（端末処理通番）を本サービスで埋めるように改修を行ない、
token（決済用ワンタイムトークン）をregisterPropertyの中に移動しました。
レスポンスに関しては、transactionId（有効性確認の取引のID）とthreeDSHTMLをresultProperty内に移動、
accountMethod内のmaskedAccountNumber（カード番号の下4桁以外をマスクする項目）、accountName（カード名義）、expiryDate（有効期限）をaccountMethod内のpropertyに移動したため非推奨です。

path Parameters

customerId

required

string

顧客ID
決済情報預かりを利用する際に、利用者を識別するために加盟店様側で採番したIDです。
createCustomerで登録済みの顧客IDを指定してください。
使用可能文字：半角英数字＋記号（-_）

Request Body schema: application/json

One of

token	string [ 1 .. 36 ] characters Deprecated 決済用ワンタイムトークン createTransactionTokenのレスポンスのtokenを設定します。 ※registerPropertyの中に移動したため非推奨
	object 有効性確認の設定値です。 ※有効性確認を利用する場合は設定 3Dセキュア認証が不要で有効性確認のみする場合`{}`を入れてください。
	object 登録の設定値です。こちらの項目は各種決済手段固有の情報です。
paymentMethodId	string 登録する会員番号の決済手段ID 決済手段ごとに以下を設定してください。クレジットカード決済 - ”Credit” こちらのIDはlistPaymentMethodsからも取得できます。 ※何も指定しなかった場合"Credit"として扱われます。

Responses

Request samples

Payload

Content type

application/json

{"token": "043a4f87-3b1b-497f-a9eb-d598010f4fc1",
"verificationProperty": {"creditTerminalIdentifier": "1234567890123",
"terminalProcessingSerialNumber": "00001",
"threeDSInfo": {"notificationUrl": "http://domain/authResult",
"authenticationData": {"authenticationIndicator": "01",
"authenticationInfo": {"authenticationData": "sample Requestor Authentication Data",
"authenticationMethod": "01",
"authenticationTimestamp": "201908161402"
},
"challengeIndicator": "01",
"accountType": "02",
"accountId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"accountInfo": {"cardholderAccountAgeIndicator": "03",
"cardholderAccountChange": "20190816",
"cardholderAccountChangeIndicator": "01",
"cardholderAccountDate": "",
"passwordChange": "20190816",
"passwordChangeIndicator": "02",
"purchaseCount": "10",
"numberOfProvisioningAttemptsPerDay": "2",
"numberOfTransactionsPerDay": "5",
"numberOfTransactionsPerYear": "100",
"paymentAccountAge": "20181201",
"paymentAccountAgeIndicator": "05",
"shippingAddressUsage": "20181201",
"shippingAddressUsageIndicator": "04",
"shippingNameIndicator": "02",
"suspiciousAccountActivity": "02"
},
"cardholderInfo": {"addressMatchIndicator": "Y",
"billingAddress": {"city": "xxxxyyyyyoooonnnnnn",
"country": "392",
"addressLine1": "円山町１９−１",
"addressLine2": "渋谷プライムプラザ",
"addressLine3": "xxxxyyyyyoooonnnnnn",
"postalCode": "1680082",
"state": "01"
},
"cardholderName": "DATA ENUTEITEI",
"email": "sample_mail_address@nttdata.com",
"homePhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
},
"mobilePhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
},
"shippingAddress": {"city": "xxxxyyyyyoooonnnnnn",
"country": "392",
"addressLine1": "円山町１９−１",
"addressLine2": "渋谷プライムプラザ",
"addressLine3": "xxxxyyyyyoooonnnnnn",
"postalCode": "1680082",
"state": "01"
},
"workPhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
}
},
"instalmentPaymentDate": "10",
"merchantRiskIndicator": {"deliveryEmailAddress": "enuteitei@sample.co.jp",
"deliveryTimeframe": "04",
"giftCardAmount": "100000",
"giftCardCount": "02",
"giftCardCurrency": "392",
"preOrderDate": "20190711",
"preOrderPurchaseIndicator": "01",
"reorderItemsIndicator": "01",
"shippingIndicator": "03"
},
"messageCategory": "01",
"purchaseDate": "20190816160405",
"recurringExpiry": "20200831",
"recurringFrequency": "30",
"transactionType": "01"
}
}
},
"registerProperty": {"token": "043a4f87-3b1b-497f-a9eb-d598010f4fc1"
},
"paymentMethodId": "Credit"
}

Response samples

201

Content type

application/json

{"accountMethod": {"accountMethodId": "01",
"maskedAccountNumber": "************0000",
"accountName": "test name",
"expiryDate": "0000",
"isValid": true,
"paymentMethodId": "samplePaymentMethodId",
"property": {"maskedAccountNumber": "************0000",
"accountName": "test name",
"expiryDate": "0000"
}
},
"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"threeDSHTML": "<!DOCTYPE html><html><head><meta charset=\"UTF-8\"><title>ThreeDSMethodInit</title></head><body onload=\"window.location.href='https://simulator.test.3ds.com/api/v2/auth/brw/threeDsMethod?threeDSServerTransID=0dabae77-d947-4a98-96dd-23e922be5aaf'\"></body></html>",
"resultProperty": {"errorCode": "G12",
"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"threeDSHTML": "<!DOCTYPE html><html><head><meta charset=\"UTF-8\"><title>ThreeDSMethodInit</title></head><body onload=\"window.location.href='https://simulator.test.3ds.com/api/v2/auth/brw/threeDsMethod?threeDSServerTransID=0dabae77-d947-4a98-96dd-23e922be5aaf'\"></body></html>",
"threeDSRedirectUrl": "https://dummy/dummy/threedsRedirectXXXXXXXXXXXXXXXXXXXXXXXXX'",
"threeDSMerchantTransID": "550e8400-e29b-41d4-a716-446655440000"
},
"status": "SUCCESS"
}

listAccountMethods

レスポンスに関して、accountMethod内のmaskedAccountNumber（カード番号の下4桁以外をマスクする項目）、accountName（カード名義）、expiryDate（有効期限）をaccountMethod内のpropertyに移動したため非推奨です。

path Parameters

customerId

required

string

顧客ID
決済情報預かりを利用する際に、利用者を識別するために加盟店様側で採番したIDです。
createCustomerで登録済みの顧客IDを指定してください。
使用可能文字：半角英数字＋記号（-_）

query Parameters

pageSize	integer <int32> [ 1 .. 100 ] 一度に返却するアイテム数 APIはこちらで指定した値より少ないアイテム数を返却する場合があります。指定しない場合と0を指定した場合、最大10個のアイテムが返却されます。 100を超える値は100に変換されます。負の値を指定すると、422が返却されます。
pageToken	string 前回こちらのAPIを呼び出した際にResponse Headersとして受信した値(`X-Next-Token`) こちらの項目を指定することで、前回取得したアイテムの次のアイテムから取得できます。

Responses

Response samples

Content type

application/json

[{"accountMethodId": "01",
"maskedAccountNumber": "************0000",
"accountName": "test name",
"expiryDate": "0000",
"isValid": true,
"paymentMethodId": "samplePaymentMethodId",
"property": {"maskedAccountNumber": "************0000",
"accountName": "test name",
"expiryDate": "0000"
}
}
]

adviceAccountMethod

リクエストに関して、transactionId（取引ID）がrequestPropertyの中に移動したため非推奨です。
レスポンスに関して、accountMethod内のmaskedAccountNumber（カード番号の下4桁以外をマスクする項目）、accountName（カード名義）、expiryDate（有効期限）をaccountMethod内のpropertyに移動したため非推奨です。

path Parameters

customerId required	string 顧客ID 決済情報預かりを利用する際に、利用者を識別するために加盟店様側で採番したIDです。 createCustomerで登録済みの顧客IDを指定してください。 `使用可能文字：半角英数字＋記号（-_）`
accountMethodId required	string 決済手段登録番号登録している決済手段を利用者ごとに識別するためのIDです。券種によらずcustomerIdごとに一意で、00~99のランダムな2桁の数字が本サービスによって採番されます。

Request Body schema: application/json

One of

transactionId	string Deprecated 取引ID registerAccountMethodのレスポンスで受け取った値を設定してください。 ※requestPropertyの中に移動したため非推奨
required	object requestPropertyオブジェクトこちらの項目は各種決済手段固有の情報です。 3DセキュアのnotificationUrlに通知される情報に通知された情報（以下、通知情報）を設定してください。

Responses

Request samples

Payload

Content type

application/json

{"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"requestProperty": {"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"threeDSResult": {"messageVersionNumber": "ABC0001!!",
"transactionStatus": "s",
"accountholderAuthenticationValue": "ABCDEFGHIJKLMNO0123456789!%&",
"electronicCommerceIndicator": "10",
"dsTransactionId": "ABCDEFGHIJKLMNOPQRSTUVW0123456789!%&",
"threeDSServerTransactionId": "ABCDEFGHIJKLMNOPQRSTUVW0123456789!%&"
}
}
}

Response samples

200

Content type

application/json

{"accountMethod": {"accountMethodId": "01",
"maskedAccountNumber": "************0000",
"accountName": "test name",
"expiryDate": "0000",
"isValid": true,
"paymentMethodId": "samplePaymentMethodId",
"property": {"maskedAccountNumber": "************0000",
"accountName": "test name",
"expiryDate": "0000"
}
},
"resultProperty": {"errorCode": "G12"
},
"status": "SUCCESS"
}

updateAccountMethod

レスポンスに関して、accountMethod内のmaskedAccountNumber（カード番号の下4桁以外をマスクする項目）、accountName（カード名義）、expiryDate（有効期限）をaccountMethod内のpropertyに移動したため非推奨です。

path Parameters

customerId required	string 顧客ID 決済情報預かりを利用する際に、利用者を識別するために加盟店様側で採番したIDです。 createCustomerで登録済みの顧客IDを指定してください。 `使用可能文字：半角英数字＋記号（-_）`
accountMethodId required	string 決済手段登録番号登録している決済手段を利用者ごとに識別するためのIDです。券種によらずcustomerIdごとに一意で、00~99のランダムな2桁の数字が本サービスによって採番されます。

Request Body schema: application/json

One of

	object 更新の設定値です。
	object 有効性確認の設定値です。こちらの項目は各種決済手段固有の情報です。 ※有効性確認を利用する場合は設定 3Dセキュア認証が不要で有効性確認のみ実施する場合`{}`を入れてください。

Responses

Request samples

Payload

Content type

application/json

{"updateProperty": {"accountName": "test name",
"expiryDate": "0000"
},
"verificationProperty": {"threeDSInfo": {"notificationUrl": "http://domain/authResult",
"authenticationData": {"authenticationIndicator": "01",
"authenticationInfo": {"authenticationData": "sample Requestor Authentication Data",
"authenticationMethod": "01",
"authenticationTimestamp": "201908161402"
},
"challengeIndicator": "01",
"accountType": "02",
"accountId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"accountInfo": {"cardholderAccountAgeIndicator": "03",
"cardholderAccountChange": "20190816",
"cardholderAccountChangeIndicator": "01",
"cardholderAccountDate": "",
"passwordChange": "20190816",
"passwordChangeIndicator": "02",
"purchaseCount": "10",
"numberOfProvisioningAttemptsPerDay": "2",
"numberOfTransactionsPerDay": "5",
"numberOfTransactionsPerYear": "100",
"paymentAccountAge": "20181201",
"paymentAccountAgeIndicator": "05",
"shippingAddressUsage": "20181201",
"shippingAddressUsageIndicator": "04",
"shippingNameIndicator": "02",
"suspiciousAccountActivity": "02"
},
"cardholderInfo": {"addressMatchIndicator": "Y",
"billingAddress": {"city": "xxxxyyyyyoooonnnnnn",
"country": "392",
"addressLine1": "円山町１９−１",
"addressLine2": "渋谷プライムプラザ",
"addressLine3": "xxxxyyyyyoooonnnnnn",
"postalCode": "1680082",
"state": "01"
},
"cardholderName": "DATA ENUTEITEI",
"email": "sample_mail_address@nttdata.com",
"homePhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
},
"mobilePhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
},
"shippingAddress": {"city": "xxxxyyyyyoooonnnnnn",
"country": "392",
"addressLine1": "円山町１９−１",
"addressLine2": "渋谷プライムプラザ",
"addressLine3": "xxxxyyyyyoooonnnnnn",
"postalCode": "1680082",
"state": "01"
},
"workPhoneNumber": {"countryCode": "81",
"subscriber": "9012345678"
}
},
"instalmentPaymentDate": "10",
"merchantRiskIndicator": {"deliveryEmailAddress": "enuteitei@sample.co.jp",
"deliveryTimeframe": "04",
"giftCardAmount": "100000",
"giftCardCount": "02",
"giftCardCurrency": "392",
"preOrderDate": "20190711",
"preOrderPurchaseIndicator": "01",
"reorderItemsIndicator": "01",
"shippingIndicator": "03"
},
"messageCategory": "01",
"purchaseDate": "20190816160405",
"recurringExpiry": "20200831",
"recurringFrequency": "30",
"transactionType": "01"
}
}
}
}

Response samples

Content type

application/json

{"accountMethod": {"accountMethodId": "01",
"maskedAccountNumber": "************0000",
"accountName": "test name",
"expiryDate": "0000",
"isValid": true,
"paymentMethodId": "samplePaymentMethodId",
"property": {"maskedAccountNumber": "************0000",
"accountName": "test name",
"expiryDate": "0000"
}
},
"resultProperty": {"errorCode": "G12",
"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"threeDSHTML": "<!DOCTYPE html><html><head><meta charset=\"UTF-8\"><title>ThreeDSMethodInit</title></head><body onload=\"window.location.href='https://simulator.test.3ds.com/api/v2/auth/brw/threeDsMethod?threeDSServerTransID=0dabae77-d947-4a98-96dd-23e922be5aaf'\"></body></html>",
"threeDSRedirectUrl": "https://dummy/dummy/threedsRedirectXXXXXXXXXXXXXXXXXXXXXXXXX'",
"threeDSMerchantTransID": "550e8400-e29b-41d4-a716-446655440000"
},
"status": "SUCCESS"
}

createPaymentUrl

linkRequestProperty.Convenience.expiresAtはpayLimitAtに変更されたため非推奨です。
他の項目についてはcreatePaymentUrlから変更ありません。

Request Body schema: application/json

requestId required	string <= 50 characters 加盟店様が払い出す、リクエストを識別するID べき等性を担保し、要求が多重に行われることを防ぐために設定します。詳細はべき等性の担保をご参照ください。 ※なお本項目とリンクから行われる取引に設定されるrequestIdは異なります。詳細は本APIのCallbacksのrequestIdの説明をご参照ください。 `使用可能文字：半角英数字＋記号（_）`
required	object
paymentMethodIds	Array of strings 取引に利用する決済手段ID 設定しない場合は利用可能な決済手段の全てが有効です。複数指定可能です。クレジットカード決済 - ”Credit” コンビニ決済(番号払い) - ”Convenience” PayPay - ”PayPay” 楽天ペイ - "RakutenPay" d払い - ”DPayment” au PAY - ”AuPay” 銀行ネット決済 - ”NetBankingAtm” こちらのIDはlistPaymentMethodsからも取得できます。 ※決済情報預かりに対応しているのはクレジットカード決済のみです。決済情報預かりについての詳細は業務概要の会員管理の機能説明の欄をご参照ください。
	object こちらの項目は各種決済手段固有の情報の集合です。
orderId	string <= 64 characters 照会のために加盟店様が払い出す、注文を識別するID このIDによって、発行済みリンクからそれに関連するすべての取引(支払/売上/返金など)を紐付けて参照できるため、値を設定することが推奨されます。また、このIDを使って、生成された取引をlistTransactionsで情報取得することが出来ます。 `使用可能文字：半角英数字＋記号（_-）`
successUrl	string <uri> <= 2000 characters 取引を正常に完了した利用者はこちらのURLにリダイレクトされます。 successUrlを指定しない場合は、本サービスの完了画面を表示します。 ※利用者が以下の決済手段を選択した場合は、支払に必要な情報が記載された本サービスの支払受付画面が表示されるため、本パラメータのURLには遷移しません。コンビニ決済(番号払い) 銀行ネット決済
cancelUrl	string <uri> <= 2000 characters 利用者が戻るボタンを選択か押下するとこちらのURLにリダイレクトされます。 cancelUrl を指定しない場合は、戻るボタンは表示されません。
callbackUrl	string <uri> <= 2000 characters 取引が更新された際に本サービスから更新内容を通知するURLを指定してください。本パラメータが設定された場合のみ通知が行われます。 https://から始まる任意のURLをご指定いただけます。詳細は以下のCallbacksをご参照ください。 ※POSTメソッドの受け取りの際にエラーが発生した場合、3秒間スリープしたのちに2回までリトライを行います。(各通知が最大3回POSTされます)
expiresAt	string <date-time> 決済リンクの有効期限発行した決済リンクが期限切れになる日時です。期限切れになったリンクは利用できなくなります。デフォルトでは、こちらの値は作成から24時間後です。フォーマットはISO 8601です。コンビニ決済(番号払い)・銀行ネット決済の支払期限は`payLimitAt`で指定してください。
payLimitAt	string <date-time> 利用者の支払期限利用者の払込が必要な決済手段における利用者の支払期限です。各決済事業者から利用者に払い出される払込番号やバーコードの有効期間であり、利用者はこの期限内にコンビニや金融機関などでの支払を完了させる必要があります。本項目の設定対象となる決済手段は以下の通りです。コンビニ決済(番号払い) - 最大90日銀行ネット決済 - 最大60日デフォルトでは、こちらの値はリンク作成日から5日後です。フォーマットはISO 8601です。なお、利用者の支払期間確保のため、利用者が上記決済手段を選択できるのは支払期限前日までです。例えばこちらの項目を20xx年n月m日に設定した場合、利用者が決済画面から上記決済手段を選択できるのは20xx年n月m-1日までです。 ※決済手段によって上限が異なります。複数の決済手段を選択してリンクを作成する場合、最も上限が低い決済手段に合わせた支払期限を設定する必要があります。 ※現在は時刻単位の期限設定に対応していないため、時刻の設定値によらず指定された日付の`23:59:59`までの期限が設定されます。 ※リンク作成日の翌日以降の値を設定してください。
captureNow	boolean Default: false 支払（オーソリ）と売上確定のタイミングを同時にするか否かを区別する項目 `true` - 同時にする `false` - 同時にしない本パラメータをサポートしていない決済手段の場合は、決済手段規定の動作をします。各決済手段の対応は以下です。クレジットカード決済 - 設定可能コンビニ決済(番号払い) - 設定値によらず`true`で決済が実行されます PayPay - 設定可能楽天ペイ - 設定可能 d払い - 設定可能 au PAY - 設定可能銀行ネット決済 - 設定値によらず`true`で決済が実行されます
description	string <= 255 characters 任意の文字列利用者向け支払画面に表示されます。候補としては取引の内容が考えられます。 d払いを選択した場合は、先頭40文字がd払い決済時の内容確認画面およびご利用明細（詳細内容確認画面など）に表示されますが、それらの画面ではd払い未対応の記号（".'/）が半角スペースに置換されます。楽天ペイを選択した場合は、不正注文対策のため購入商品情報を特定できる名称（一部でも可）を設定してください。型番商品の場合ブランド名の併記を推奨します。購入商品が複数の場合、区切り文字（推奨＝セミコロン；）をご利用ください。個人情報（氏名、住所など）は設定しないでください。設定した値は利用者向け決済画面に表示されますのでご注意ください。 `使用可能文字：全角半角文字`
labels	Array of strings <= 50 items [ items [ 1 .. 255 ] characters ] ラベル加盟店様の運用に合わせて最大50個まで自由に設定いただけます。 `使用可能文字：全角半角文字（<>&は対象外）`
customerId	string [ 1 .. 33 ] characters 顧客ID 顧客を識別するために、加盟店様側で採番・管理頂くIDです。加盟店様が払い出すIDで、加盟店様内で一意である必要があります。既に登録済みのIDを指定した場合は、顧客が過去に登録したカード情報を利用して決済を行うことができます。未登録のIDを指定した場合は、顧客が取引に使用したカード情報を新規で登録できます。 ※決済情報預かりに対応していない決済手段のみを選択した場合は、入力しないようにしてください(決済情報預かりへの対応状況は提供機能マッピングをご確認ください) 。 `使用可能文字：半角英数字+記号（-_）`
	object 利用者情報メールまたはSMSの送信を行う際に使用する利用者情報です。それぞれの場合で必要な情報を設定してください。また、利用者情報が必要な決済手段を選択した際にも本項目の値が利用されます。必須項目に値を設定しなかった場合、支払画面で利用者へ入力を要求します。 ※利用者情報を加盟店様が事前に保持している場合は、本項目を設定することで、利用者が支払画面で入力する項目を減らすことが出来ます。利用者情報が必要な決済手段一覧コンビニ決済(番号払い) 銀行ネット決済
notifyOnExpiration	boolean Default: false 期限切れお知らせを加盟店ポータルに表示するかを指定する項目 `true` - 表示する `false` - 表示しない
	Array of objects <= 3 items メール送信に必要な情報利用者に対してメールによる通知を行う際に指定してください。利用者の情報はcustomerInfoに設定してください。
	Array of objects <= 3 items SMS送信に必要な情報利用者に対してSMSによる通知を行う際に指定してください。利用者の情報はcustomerInfoに設定してください。 ※SMS送信機能の利用には別途契約や利用料金が必要です。リンク決済 SMS送信時の注意事項をご参照の上、詳しくは担当者にお問い合わせください。
employeeEmailAddresses	Array of strings <email> <= 5 items [ items <email > [ 6 .. 50 ] characters ] 加盟店担当者様のメールアドレス本項目を設定した場合は、利用者にメールもしくはSMSを送信する際の証跡として、同内容のメールを加盟店担当者様に送信できます。メール送信の場合は、利用者に送信されるメールのBCCに本項目のメールアドレスを設定し送信します。 SMS送信の場合は、利用者に送信されるSMSのメッセージが記載されたメールを本項目のメールアドレス宛に送信します。メールアドレスで扱う記号は`@_-.`のみにしてください。ドメイン部(@より後)は2文字以上にしてください。ドメイン部に`.`(ピリオド)が1つ以上含まれるようにしてください。ローカル部(@より前)の先頭と末尾は`.`(ピリオド)以外にしてください。ローカル部に`.`(ピリオド)は2連続で含まないようにしてください。 `使用可能文字：半角英数字＋記号`

Responses

Callbacks

Request samples

Payload

Content type

application/json

{"requestId": "sampleId_123",
"amount": {"currencyCode": "JPY",
"value": 1200
},
"paymentMethodIds": ["Credit",
"PayPay",
"DPayment"
],
"linkRequestProperty": {"credit": {"is3DS": true,
"requireSecurityCodeForNewCard": false,
"requireSecurityCodeForAccountMethod": false
},
"dPayment": {"merchantParameter": "sampleCode",
"contactInfo": "店舗名：○○○ストア<br>連絡先：03-9999-9999<br>Mail：hoge@example.com<br>ホームページ：http:<sl><sl>example.com"
},
"convenience": {"expiresAt": "2020-02-28T23:59:59+09:00"
},
"netBankingAtm": {"paymentDetail": "決済内容",
"paymentDetailKana": "ｹﾂｻｲﾅｲﾖｳ"
}
},
"orderId": "order_1231-01",
"successUrl": "https://example.com/success?requestId=sampleId_01",
"cancelUrl": "https://example.com/cancel?requestId=sampleId_01",
"callbackUrl": "https://example.com/webhook",
"expiresAt": "2020-01-31T23:59:59+09:00",
"payLimitAt": "2020-02-28T23:59:59+09:00",
"captureNow": true,
"description": "string",
"labels": ["ラベル"
],
"customerId": "sampleCustomerId_01-01",
"customerInfo": {"firstName": "太郎",
"lastName": "山田",
"firstNameKana": "タロウ",
"lastNameKana": "ヤマダ",
"emailAddress": "example@example.com",
"telephones": [{"telType": "MOBILE",
"use": ["SMS",
"CONVENIENCE"
],
"countryCode": "81",
"number": "12312341234"
}
]
},
"notifyOnExpiration": true,
"mailContents": [{"mailType": "LINK_CREATED",
"subject": "EXAMPLE店舗での購入商品についてお支払いのご依頼",
"freeText": "EXAMPLE店舗です。\nこの度は商品のご購入誠にありがとうございました。"
},
{"mailType": "REMIND",
"subject": "EXAMPLE店舗での購入商品について再度お支払いのご依頼"
},
{"mailType": "PAY_ACCEPTED",
"freeText": "EXAMPLE店舗です。\nこの度は商品のご購入誠にありがとうございました。"
},
{"mailType": "PAY_COMPLETED"
}
],
"smsContents": [{"smsType": "LINK_CREATED",
"body": "EXAMPLE店舗です。\n以下のリンクから支払を完了させてください。\n {{URL}} "
},
{"smsType": "REMIND"
},
{"smsType": "PAY_ACCEPTED"
},
{"smsType": "PAY_COMPLETED"
}
],
"employeeEmailAddresses": ["example1@example.com",
"example2@example.com"
]
}

Callback payload samples

Callback

POST: 利用者による操作が終了した場合、指定されたcallbackUrlに対して以下の内容がPOSTされます。

Content type

application/json

{"requestId": "sampleId_123_01",
"resultCode": 100,
"resultDescription": "正常に処理が終了しました",
"resultProperty": { },
"status": "REQUIRES_ACTION",
"transactionId": "01DQ4H6BA0ZPX4V3DOR7TJ0J76",
"paymentMethodId": "Credit",
"receivedTime": "2021-10-12T11:11:57+09:00"
}

createSetupUrl

returnUrlがcancelUrlに項目名変更したため非推奨です。
レスポンスとcallbacksについてはcreateSetupUrlから変更ありません。

Request Body schema: application/json

customerId required	string [ 1 .. 33 ] characters 顧客ID 顧客を識別するために、加盟店様側で採番・管理頂くIDです。加盟店様が払い出すIDで、加盟店様内で一意である必要があります。既に登録済みのIDを指定した場合は、顧客が過去に登録したカード情報が表示され、カード情報の新規登録や削除が行えます。未登録のIDを指定した場合は、顧客がカード情報を新規に登録できます。 `使用可能文字：半角英数字＋記号（-_）`
paymentMethodIds	Array of strings 決済手段ID 登録する顧客情報を限定する場合に設定します。設定しない場合は利用可能な決済手段の全てが有効です。複数指定可能です。クレジットカード決済 - ”Credit”
	object こちらの項目は各種決済手段固有の情報の集合です。
returnUrl	string <uri> <= 2000 characters Deprecated 顧客が戻るボタンを選択か押下するとこちらのURLにリダイレクトされます。 cancelUrl を指定しない場合は、戻るボタンは表示されません。 ※非推奨本項目名は`cancelUrl`へ変更されています。
callbackUrl	string <uri> <= 2000 characters 顧客情報が更新された際に本サービスから更新内容を通知するURLを指定してください。本パラメータが設定された場合のみ通知が行われます。 https://から始まる任意のURLをご指定いただけます。詳細は以下のCallbacksをご参照ください。 ※POSTメソッドの受け取りの際にエラーが発生した場合、3秒間スリープしたのちに2回までリトライを行います。(各通知が最大3回POSTされます)
expiresAt	string <date-time> URLが期限切れになる日時デフォルトでは、こちらの値は作成から24時間後です。フォーマットはISO 8601です。
description	string <= 255 characters 任意の文字列顧客向けの画面に表示されます。 `使用可能文字：全角半角文字`
labels	Array of strings <= 50 items [ items [ 1 .. 255 ] characters ] ラベル加盟店様の運用に合わせて最大50個まで自由に設定いただけます。 `使用可能文字：全角半角文字（<>&は対象外）`

Responses

Callbacks

Request samples

Payload

Content type

application/json

{"customerId": "sampleCustomerId_01-01",
"paymentMethodIds": ["Credit"
],
"linkRequestProperty": {"credit": {"is3DS": true,
"isVerify": true
}
},
"returnUrl": "https://example.com/cancel",
"callbackUrl": "https://example.com/webhook",
"expiresAt": "2020-01-31T23:59:59+09:00",
"description": "カード情報の登録をお願いいたします。",
"labels": ["ラベル"
]
}

Callback payload samples

Callback

POST: 利用者による操作が終了した場合、指定されたcallbackUrlに対して以下の内容がPOSTされます。

Content type

application/json

{"customerId": "sampleCustomerId_01-01",
"paymentMethodId": "Credit",
"action": "REGISTER",
"status": "SUCCESS",
"accountMethodId": "01",
"urlId": "4ef479c3-ed99-4cde-ba6d-d4125f8db68f",
"resultProperty": {"errorCode": "G12"
}
}

更新履歴

本サービスの更新履歴です。

2026/4/21 version: 1.16.0

Payment API利用にあたって【記載拡充】【券種共通】
・新規に互換性と拡張方針を追記

payTransaction（支払）【仕様変更】【クレジットカード決済】
・requestPropertyにb2bSupplierDataを追加
・payTransactionのリクエスト項目から、「PriorTransactionID」・「PaymentTokenIndicator」の項目を削除
・resultProperty.maskedNetworkTokenNumberを追加
・requestProperty.cardInfo.securityCodeとrequestProperty.cardInfo.securityCodeTokenが3Dセキュア利用時にも設定できるように仕様を変更

payTransaction（支払）【誤記修正】【クレジットカード決済】
・resultProperty.maskedPrimaryAccountNumberの桁数を「[ 16 .. 14 ] characters」から「[ 14 .. 16 ] characters」に修正

payTransaction（支払）【文言追加】【PayPay】
・PayPayのResponsesのresultDetail の「項目が返却される取引のステータス："FAILED"」の説明に「"FAILED"かつ追加情報がある場合にのみ返却されます」の文言を追加

payTransaction（支払）【記載拡充】【BankPay】
・requestProperty.accountMethodIdに説明を追加

captureTransaction【文言追加】【PayPay】
・PayPayのResponsesのresultDetail の「項目が返却される取引のステータス："FAILED"」の説明に「"FAILED"かつ追加情報がある場合にのみ返却されます」の文言を追加

cancelTransaction【文言追加】【PayPay】
・PayPayのResponsesのresultDetail の「項目が返却される取引のステータス："FAILED"」の説明に「"FAILED"かつ追加情報がある場合にのみ返却されます」の文言を追加

refundTransaction【文言追加】【PayPay】
・PayPayのResponsesのresultDetail の「項目が返却される取引のステータス："FAILED"」の説明に「"FAILED"かつ追加情報がある場合にのみ返却されます」の文言を追加

adviceTransaction (決済追加処理) 【仕様変更・誤記修正】【クレジットカード決済】
・resultProperty.maskedNetworkTokenNumberを追加
・resultProperty.maskedPrimaryAccountNumberの桁数を「[ 16 .. 14 ] characters」から「[ 14 .. 16 ] characters」に修正

cancelUnresponsedTransaction（障害取消）【誤記修正】【PayPay】
・説明を「 PayPayの場合は、支払および同時売上のみに障害取消を行い、売上確定、支払キャンセル、返金に対しては再送を行います。詳しくはPayPay処理シーケンスの障害取消をご参照ください。」から「PayPayの場合は、支払のみに障害取消を行い、同時売上、売上確定、支払キャンセル、返金に対しては再送を行ってください。既に成功した同時売上の取消については、別途返金処理を行ってください。詳しくはPayPay処理シーケンスの障害取消をご参照ください。」へ変更

createTransactionToken （トークン発行）【仕様変更】【クレジットカード決済】
・securityCodeが3Dセキュア利用時にも設定できるように仕様を変更

verifyCustomer（有効性確認）【仕様変更】【クレジットカード決済】
・APIによる有効性確認が失敗しても登録している決済手段の有効区分は無効にならないように仕様を変更
・verificationProperty.cardInfo.securityCodeとverificationProperty.cardInfo.securityCodeTokenが3Dセキュア利用時にも設定できるように仕様を変更

registerAccountMethod（決済手段登録）【誤記修正】【クレジットカード決済】
・有効性確認失敗時に有効区分は返却されないため記載を削除

listAccountMethods（決済手段一覧取得）【仕様変更】【クレジットカード決済】
・有効性確認結果によって登録している決済手段の有効区分が更新されなくなるため、有効区分の記載を変更

adviceAccountMethod（決済手段追加処理）【仕様変更】【クレジットカード決済】
・APIによる有効性確認が失敗しても登録している決済手段の有効区分は無効にならないように仕様を変更

updateAccountMethod（決済手段更新）【仕様変更】【クレジットカード決済】
・APIによる有効性確認が失敗しても登録している決済手段の有効区分は無効にならないように仕様を変更
・クレジットカード更新時の有効性確認で3Dセキュア認証を利用できるように仕様を変更

createPaymentUrl【仕様変更】【クレジットカード決済】
・新規クレジットカードを利用して決済を行う場合、CVC利用有無を設定できるよう仕様を変更
・決済リンクの有効期限が最大１年になるよう仕様を変更
・リンクの保持期間が最大26ヶ月になるよう仕様を変更

createPaymentUrl【記載拡充・誤記修正】【クレジットカード決済】
・分割回数が固定である旨を追加・requestIDの冪等性に関する記載を削除

createSetupUrl【仕様変更】【クレジットカード決済】
・リンクの有効期限が最大１年になるよう仕様を変更
・リンクの保持期間が最大26ヶ月になるよう仕様を変更
・クレジットカード情報の更新機能が追加

createSetupUrl【誤記修正】【クレジットカード決済】
・requestIDの冪等性に関する記載を削除

処理シーケンス【誤記修正】【券種共通】
・決済手段の表示順序を修正

PayPay処理シーケンス【誤記修正】【PayPay】
・「売上確定、同時売上、返金の再送」の説明を、「売上確定、同時売上、返金実行後にサービスの障害などのエラーにより取引が失敗・もしくは応答を受信できない場合は、同取引の再送を行います。」から「売上確定、同時売上、返金実行後にサービスの障害などのエラーにより取引が失敗・もしくは応答を受信できない場合は、同取引の再送を行ってください。」に変更
・障害取消項目に返金処理が必要な場合の小項目を追加

決済手段更新【仕様変更】【クレジットカード決済】
・処理シーケンスに有効性確認あり3Dセキュア無しの場合と有効性確認あり3Dセキュア有りの場合を記載

支払区分設定方法【仕様変更】【クレジットカード決済】
・支払区分にボーナス払い(21)を追加

resultCode【仕様変更】【クレジットカード決済】
・1102の削除
・2102の削除

resultCode【仕様変更】【PayPay】
・5224の追加
・詳細にresultCode5216・5217・5218・5219・5220・5221・5222・5223・5290の記載を追記

resultCode【誤記修正】【決済手段共通】
・現時点では返却されないため、結果コードから1004と1006を削除

クレジットカード決済エラーコード一覧【仕様変更】【クレジットカード決済】
・IA001~IA009、I310を新規追加
・I111を新規追加
・I309を新規追加
・TH101を削除

Bank Pay エラーコード一覧【誤記修正】【BankPay】
・その他内部エラーの結果詳細コードを修正

3Dセキュア項目チェックエラー【仕様変更】【クレジットカード決済】
・3Dセキュア項目チェックエラーから、「T174」・「T175」を削除

authenticationResultResponseの詳細項目【仕様変更】【クレジットカード決済】
・「authenticationResultResponseの詳細項目」に「resolvedCardScheme」・「challengeCancel」項目を追加

2026/1/27 version: 1.15.3

createTransactionToken（トークン発行）【仕様変更】【クレジットカード決済】
・クレジットカード詳細情報取得で決済用ワンタイムトークンを使用した場合、使用された決済用ワンタイムトークンは無効にならないように仕様を変更

inquireCreditCard（クレジットカード詳細情報取得）【仕様変更】【クレジットカード決済】
・決済用ワンタイムトークンを利用した場合、決済用ワンタイムトークンは無効にならず再利用できるように仕様を変更

2025/12/16 version: 1.15.2

listTransactions【記載拡充】
・レスポンスにterminalIdを追加
getTransaction【記載拡充】
・レスポンスにterminalIdを追加
payTransaction（非推奨項目一覧）【記載拡充】【クレジットカード決済】
・ResponsesのresultRegisterAccountProperty.accountMethod内の非推奨項目を追加
adviceTransaction（非推奨項目一覧）【記載拡充】【クレジットカード決済】
・非推奨項目一覧に追加
adviceAccountMethod（非推奨項目一覧）【記載拡充】【クレジットカード決済】
・ResponsesのaccountMethod内の非推奨項目を追加
verifyCustomer（非推奨項目一覧）【記載拡充】【クレジットカード決済】
・ResponsesのaccountMethod内の非推奨項目を追加
listAccountMethods（非推奨項目一覧）【記載拡充】【クレジットカード決済】
・非推奨項目一覧に追加
registerAccountMethod（決済情報登録）【記載拡充】【クレジットカード決済】
・ResponsesのaccountMethod内のaccountMethodIDの説明を追記

2025/10/27 version: 1.15.1

クレジットカード決済処理シーケンス【仕様変更】【クレジットカード決済】
・「支払（3Dセキュア認証なし）+決済情報預かり手段登録」の説明に、決済手段を登録しない場合を追記

決済情報預かり処理シーケンス/クレジットカード決済【仕様変更】【クレジットカード決済】
・「決済手段登録（クレジットカード有効性確認有り3Dセキュア有り）」の説明に、本サービスにて決済手段を削除する場合を追記

HTTPステータスコード【仕様変更】【クレジットカード決済】
・412 Precondition failedの説明を追加

payTransaction（支払）【仕様変更】【クレジットカード決済】
・registerAccountPropertyに決済手段を登録しない場合を追記

verifyCustomer（顧客の決済手段に対して有効性確認）【仕様変更】【クレジットカード決済】
・APIを実施できない場合の説明を追加
・resultProperty.accountMethod.isValidの有効区分が無効になる場合の記載を変更

registerAccountMethod（決済情報登録）【仕様変更】【クレジットカード決済】
・決済手段を登録しない場合の説明を追加
・本サービスにて決済手段を削除する場合の説明を追加
・ResponsesのaccountMethodの説明に、返却されない場合を追加
・accountMethod.isValidの有効区分が無効になる場合の記載を変更

listAccountMethods（顧客の決済手段の一覧取得）【仕様変更】【クレジットカード決済】
・isValidの有効区分が無効になる場合の記載を変更

adviceAccountMethod（登録している決済手段に対して追加処理）【仕様変更】【クレジットカード決済】
・本サービスにて決済手段を削除する場合の説明を追加
・ResponsesのaccountMethodの説明を変更
・accountMethod.isValidの有効区分が無効になる場合の記載を変更

updateAccountmethod（顧客の決済手段に対して更新）【仕様変更】【クレジットカード決済】
・APIを実施できない場合の説明を追加
・accountMethod.isValidの有効区分が無効になる場合の記載を変更

createPaymentUrl【仕様変更】【コンビニ決済】
・payLimitAtの説明文を変更、コンビニ決済の支払期限について不要な記載を削除

クレジットカード決済エラーコード一覧【仕様変更】【クレジットカード決済】
・I110を新規追加
inquireCreditCard【仕様変更】【クレジットカード決済】
・レスポンスへの提携カード情報（allianceInfoオブジェクト）追加

各決済手段の取引期限【仕様変更】【クレジットカード決済】
・クレジットカード決済の障害取消の取引期限を「30分以内」から「7日以内」に変更
・上記取引期限の注釈にて、取引期限内であっても売上データ連携後は障害取消不可である旨を追記

2025/09/30 version: 1.15.0

更新履歴【記載拡充】【券種共通】
・新規にappendixに更新履歴を追加

d払いエラーコード一覧【誤記修正】【d払い】
・D601を追加
・D604のチェック内容を「売上確定した決済に対して支払キャンセル、再支払（再オーソリ）を実施した」から「売上確定した決済に対して支払キャンセルを実施した」に変更
・D611をチェック内容を「現在の売上確定額よりも多い金額で、返金／売上確定後金額補正を実施した」から「現在の売上確定額よりも多い金額で、返金を実施した」に変更

べき等性の担保【記載拡充】【券種共通】
・「べき等性の担保の仕組み」と「加盟店様によるrequestIdの付与」の説明の記載

listTransactions【誤記修正】【券種共通】
・ResponseHeaderのX-Next-Tokenの説明欄内の「取得済みのアイテム件数」を「取得したアイテムの最後の取引の取引ID」に記載を修正

createCustomer【仕様変更】【クレジットカード決済、Bank Pay】
・emailの桁数を255文字から254文字に変更しました。
・emailの使用可能文字を「半角英数字＋半角記号(IETF RFC 5322のアドレスの仕様を満たす必要があります。)」から「半角英数字+記号(0x21〜0x7E)」に変更

createTransactionToken【記載拡充】【クレジットカード決済】
・クレジットカード詳細情報取得にも使用することを追記

updateAccountMethod（非推奨項目一覧）【記載拡充】【クレジットカード決済】
・非推奨項目一覧に追加

payTransaction（支払）【仕様変更】【コンビニ決済（番号払い）】
・requestProperty.payLimitDateTimeを新規追加
・requestProperty.payLimitDayの桁数を「integer [ 1 .. 89 ]」から「integer [ 0 .. 89 ]」に変更
・requestProperty.payLimitDayの説明欄に
「0〜89日まで設定できます。0と設定した場合、当日が支払い期限です。
こちらを設定した場合は支払期限の時刻は23:59:59です。
payLimitDateTimeを設定した場合はpayLimitDateTimeを優先します。」を追加
・requestProperty.customerInfo.emailAddressの使用可能文字を「半角英数字＋記号（@_-.のみ）」から「半角英数字＋記号(ASCIIコード:0x21～0x7E)」に変更
・requestProperty.customerInfo.emailAddressの桁数を「[ 6 .. 50 ] characters」から「<= 50 characters」に変更
・requestProperty.customerInfo.emailAddressの説明欄にメールアドレスのフォーマットの内容を追加

payTransaction（支払）【誤記修正】【コンビニ決済（番号払い）】
・requestProperty.orderInfo.itemNameの桁数を「string [ 1 .. 22 ] characters」から「string [ 0 .. 22 ] characters」に変更

コンビニ決済（番号払い）エラーコード一覧【仕様変更】【コンビニ決済（番号払い）】
・CVC123を新規追加

payTransaction（支払）【誤記修正】【クレジットカード決済】
・payTransaction.requestProperty.threeDSInfo.authenticationData.purchaseDateの使用可能文字に「半角数字」を追加

payTransaction（支払）【仕様変更】【クレジットカード決済】
・payTransaction.requestProperty.threeDSInfo.authenticationData.cardholderInfo.emailの使用可能文字を「半角英数字＋半角記号(IETF RFC 5322のアドレスの仕様を満たす必要があります。)」から「半角英数字＋記号(ASCIIコード:0x21～0x7E)」に変更
・payTransaction.requestProperty.threeDSInfo.authenticationData.cardholderInfo.emailの桁数を「[1..254]characters」から「<= 254 characters」に変更
・payTransaction.requestProperty.threeDSInfo.authenticationData.merchantRiskIndicator.deliveryEmailAddressの使用可能文字を「半角英数字＋半角記号(IETF RFC 5322のアドレスの仕様を満たす必要があります。)」から「半角英数字＋記号(ASCIIコード:0x21～0x7E)」に変更
・payTransaction.requestProperty.threeDSInfo.authenticationData.merchantRiskIndicator.deliveryEmailAddressの桁数を「[1..254]characters」から「<= 254 characters」に変更
・payTransaction.requestProperty.threeDSInfo.authenticationData.cardholderInfo.billingAddress.stateの桁数を「[2..3]characters」から「[1..3]characters」に変更
・payTransaction.requestProperty.threeDSInfo.authenticationData.cardholderInfo.shippingAddress.stateの桁数を「[2..3]characters」から「[1..3]characters」に変更
・Response.200 Expected response to a valid request.resultProperty.errorCodeの桁数を「[3..4]characters」から「[3..5]characters」に変更

verifyCustomer（顧客の決済手段に対して有効性確認）【仕様変更】【クレジットカード決済】
・Response.200 Expected response to a valid request.resultProperty.errorCodeの桁数を「[3..4]characters」から「[3..5]characters」に変更

registerAccountMethod（決済情報登録）【仕様変更】【クレジットカード決済】
・Response.201 Expected response to a valid request.resultProperty.errorCodeの桁数を「[3..4]characters」から「[3..5]characters」に変更

銀行ネット決済処理シーケンス【記載拡充】【銀行ネット決済】
・支払（オーソリ取引）+売上確定情報リンク方式の処理シーケンスを追加

payTransaction（支払）【仕様変更】【NP後払い】
・resultProperty.selectBankUrlを追加

createSetupUrl【記載拡充・仕様変更】【クレジットカード決済】
・ cutomerInfo.telephones.telTypeの説明に「※3Dセキュア認証に利用する場合は、種別の登録が必須です。」を追記
・ customerInfo.emailAddressの説明欄にメールアドレスのフォーマットの内容を追加
・ successUtlをrequestに追加

リンク決済詳細【仕様変更】【券種共通】
・SMS文面にomni payment Gatewayの決済サービスである旨を追記
・銀行ネット決済時の文面に金融機関URLを追記

createPaymentUrl【仕様変更・記載拡充】【コンビニ決済・銀行ネット決済】
・payLimitAtの説明文を変更、コンビニ決済の期限を「翌日〜89日後」から「当日〜89日後」に変更、期限設定の分について説明追記

クレジットカード決済エラーコード一覧【記載拡充・仕様変更】【クレジットカード決済】
・G02/G03/G04/G22/G43/G70/G71/G72/G91/G92について追記
・TH101を新規追加

2025年9月以前の変更履歴につきましてはサービス仕様書・Webマニュアルのリリースノートをご参照ください。

				b8	0	0	0	0	0	0	0	0
				b7	0	0	0	0	1	1	1	1
				b6	0	0	1	1	0	0	1	1
				b5	0	1	0	1	0	1	0	1
b4	b3	b2	b1		00	01	02	03	04	05	06	07
0	0	0	0	00			SP	0	@	P	`	p
0	0	0	1	01			!	1	A	Q	a	q
0	0	1	0	02			"	2	B	R	b	r
0	0	1	1	03			#	3	C	S	c	s
0	1	0	0	04			$	4	D	T	d	t
0	1	0	1	05			%	5	E	U	e	u
0	1	1	0	06			&	6	F	V	f	v
0	1	1	1	07			'	7	G	W	g	w
1	0	0	0	08			(	8	H	X	h	x
1	0	0	1	09			)	9	I	Y	i	y
1	0	1	0	10			*	:	J	Z	j	z
1	0	1	1	11			+	;	K	[	k	{
1	1	0	0	12			,	<	L	\	l	\|
1	1	0	1	13			-	=	M	]	m	}
1	1	1	0	14			.	>	N	^	n	~
1	1	1	1	15			/	?	O	_	o

パターン	￥	，	．	（	）	ー	－	／	＊	「	」	＄	＋	＆
A	○	－	○	○	○	○	○	○	－	－	－	－	－	－
B	－	○	○	○	○	○	○	－	○	－	－	－	○	○
C	○	○	○	○	○	○	○	○	－	－	－	－	－	－
D	○	○	○	○	○	○	○	○	－	○	○	－	－	－
E	－	－	○	○	○	○	－	○	－	－	－	－	－	－
F	－	－	－	○	○	○	○	－	－	－	－	－	－	－
G	○	○	○	○	○	○	○	○	○	○	○	○	○	－
H	○	○	○	○	○	○	－	○	○	○	○	○	○	○

				b8	0	0	0	0	0	0	0	0
				b7	0	0	0	0	1	1	1	1
				b6	0	0	1	1	0	0	1	1
				b5	0	1	0	1	0	1	0	1
b4	b3	b2	b1		00	01	02	03	04	05	06	07
0	0	0	0	00			SP	0	@	P	`	p
0	0	0	1	01			!	1	A	Q	a	q
0	0	1	0	02			"	2	B	R	b	r
0	0	1	1	03			#	3	C	S	c	s
0	1	0	0	04			$	4	D	T	d	t
0	1	0	1	05			%	5	E	U	e	u
0	1	1	0	06			&	6	F	V	f	v
0	1	1	1	07			'	7	G	W	g	w
1	0	0	0	08			(	8	H	X	h	x
1	0	0	1	09			)	9	I	Y	i	y
1	0	1	0	10			*	:	J	Z	j	z
1	0	1	1	11			+	;	K	[	k	{
1	1	0	0	12			,	<	L	\	l	\|
1	1	0	1	13			-	=	M	]	m	}
1	1	1	0	14			.	>	N	^	n	~
1	1	1	1	15			/	?	O	_	o

パターン	￥	，	．	（	）	ー	－	／	＊	「	」	＄	＋	＆
A	○	－	○	○	○	○	○	○	－	－	－	－	－	－
B	－	○	○	○	○	○	○	－	○	－	－	－	○	○
C	○	○	○	○	○	○	○	○	－	－	－	－	－	－
D	○	○	○	○	○	○	○	○	－	○	○	－	－	－
E	－	－	○	○	○	○	－	○	－	－	－	－	－	－
F	－	－	－	○	○	○	○	－	－	－	－	－	－	－
G	○	○	○	○	○	○	○	○	○	○	○	○	○	－
H	○	○	○	○	○	○	－	○	○	○	○	○	○	○

PaymentAPI - Omni Payment Gateway Documents (1.16.0)

Omni Payment Gateway Documents

業務概要

提供機能マッピング

決済中継

リンク決済

会員管理

クレジットカード固有機能

Bank Pay固有機能

Amazon Pay固有機能

NP後払い固有機能

各決済手段の取引期限

処理シーケンス

共通処理シーケンス

認証

決済グループ情報取得

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

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

取引情報取得

サブスクライブ

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

決済事業者取引参照

クレジットカード決済処理シーケンス

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

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

支払(トークン決済)

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

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

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

金額補正（支払）

金額補正（売上確定）

支払キャンセル

返金

強制取消

障害取消

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

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

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

コンビニ決済(番号払い)処理シーケンス

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

支払キャンセル

支払期限切れ

メール再送

PayPay処理シーケンス

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

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

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

支払キャンセル

返金

障害取消

障害取消で返金が必要な場合

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

楽天ペイ処理シーケンス

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

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

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

支払キャンセル

返金

障害取消

d払い処理シーケンス

支払(オーソリ)

返金

支払キャンセル

売上確定

au PAY処理シーケンス

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

再支払（再オーソリ）

支払キャンセル

返金

Bank Pay処理シーケンス

口座情報一覧照会

口座情報ステータス変更

金融機関上限金額照会

利用金額照会

支払

返金

障害取消

Amazon Pay処理シーケンス

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

再支払（再オーソリ）

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

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

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

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

				b8	0	0	0	0	0	0	0	0
				b7	0	0	0	0	1	1	1	1
				b6	0	0	1	1	0	0	1	1
				b5	0	1	0	1	0	1	0	1
b4	b3	b2	b1		00	01	02	03	04	05	06	07
0	0	0	0	00			SP	0	@	P	`	p
0	0	0	1	01			!	1	A	Q	a	q
0	0	1	0	02			"	2	B	R	b	r
0	0	1	1	03			#	3	C	S	c	s
0	1	0	0	04			$	4	D	T	d	t
0	1	0	1	05			%	5	E	U	e	u
0	1	1	0	06			&	6	F	V	f	v
0	1	1	1	07			'	7	G	W	g	w
1	0	0	0	08			(	8	H	X	h	x
1	0	0	1	09			)	9	I	Y	i	y
1	0	1	0	10			*	:	J	Z	j	z
1	0	1	1	11			+	;	K	[	k	{
1	1	0	0	12			,	<	L	\	l	\|
1	1	0	1	13			-	=	M	]	m	}
1	1	1	0	14			.	>	N	^	n	~
1	1	1	1	15			/	?	O	_	o

パターン	￥	，	．	（	）	ー	－	／	＊	「	」	＄	＋	＆
A	○	－	○	○	○	○	○	○	－	－	－	－	－	－
B	－	○	○	○	○	○	○	－	○	－	－	－	○	○
C	○	○	○	○	○	○	○	○	－	－	－	－	－	－
D	○	○	○	○	○	○	○	○	－	○	○	－	－	－
E	－	－	○	○	○	○	－	○	－	－	－	－	－	－
F	－	－	－	○	○	○	○	－	－	－	－	－	－	－
G	○	○	○	○	○	○	○	○	○	○	○	○	○	－
H	○	○	○	○	○	○	－	○	○	○	○	○	○	○