- インテグレーションガイドライン
- サポートされている機能
- 料金上乗せ
料金上乗せ
料金上乗せは、カードでの支払いに対応するコストを回収するために加盟店が課金する追加金額です。QNB ALAHLI の料金上乗せ機能を使用すると、以下のパラメータに基づいて取引に料金上乗せを適用できます。
- ゲートウェイのエントリポイント(<<checkout>>、<<webServicesIntegration>> など)
- 支払方法(Mastercard、Visa、American Express など)
- 資金調達方法(クレジット、デビットなど)
- 通貨
ゲートウェイで取引の料金上乗せを計算するには、Merchant Administration で料金上乗せルールを設定する必要があります。または、<<webServicesIntegration>>/<<batchIntegration>> を使用してインテグレーションしている場合、事前に計算された料金上乗せを注文に適用できます。
前提条件
- お客様が QNB ALAHLI との加盟店プロファイルで料金上乗せに対して有効になっている必要があります。
- ゲートウェイで料金上乗せを計算するには、Merchant Administration で料金上乗せルールを設定しておく必要があります。
料金上乗せを使用するためのインテグレーション
ゲートウェイは、次のインテグレーション方法を使用する取引に対する料金上乗せをサポートしています。
以下のいずれかのオプションを使用して、注文に料金上乗せを適用できます。
- 料金上乗せをゲートウェイで計算する
ゲートウェイで料金上乗せを計算するには、
Authorize
/Pay
またはUpdate Session
リクエストに以下のフィールドを指定します。order.netAmount
:これは、料金上乗せを適用する前の注文に対する支払金額です。
リクエストにorder.amount
フィールドを指定しないでください。以下の「よくある質問」を参照してください。Retrieve Transaction
/Retrieve Order
リクエストを送信して、以下の料金上乗せの詳細を取得できます。order.surchargeAmount
:料金上乗せルールに基づいてゲートウェイで計算された料金上乗せ。order.amount
:料金上乗せ額を含む、注文の総額。
Payment Options Inquiry
操作を使用し、order.netAmount
、order.currency
、gatewayEntryPoint
、およびsourceOfFunds.provided.card.prefix
フィールドを指定することによって、計算された料金上乗せをリクエストすることもできます。 - お客様が料金上乗せを指定する
Authorize
/Pay
/Standalone Capture
またはUpdate Session
リクエストに以下のフィールドを指定します。order.amount
:料金上乗せ額を含む、注文の総額。order.surchargeAmount
:該当する場合、この注文に適用される料金上乗せ。この金額は、order.amount
フィールドで指定する注文の総額に含める必要があります。
Retrieve Transaction
/Retrieve Order
リクエストを送信すると、取引リクエストで指定した料金上乗せの詳細情報に加え、order.netAmount
(注文金額から料金上乗せ額を引いた正味金額)が返されます。
Payment Options Inquiry
操作を使用すると、カードスキーム/資金調達の詳細情報をリクエストでき、カードの適切な料金上乗せの評価と適用に役立ちます。詳細については、以下の「よくある質問」を参照してください。Authorize API リファレンス [REST][NVP]
料金上乗せを <<checkout>> の支払いに適用するには、<<checkout>> リクエスト(チェックアウトフローに応じて Checkout.configure()
関数または Create Checkout Session
操作)で以下のフィールドを指定します。
order.netAmount
:料金上乗せを適用する前の注文に対する支払金額。
order.amount
フィールドを指定しないでください。以下の「よくある質問」を参照してください。Retrieve Transaction
/Retrieve Order
リクエストを送信して、料金上乗せの詳細を取得できます。
order.surchargeAmount
:料金上乗せルールに基づいてゲートウェイで計算された料金上乗せ。order.amount
:これは、正味金額に料金上乗せを加えたものです。
支払者は、入力したカードに適用される料金上乗せを確認でき、新しい総額で続行するか、別のカードを使用するか、注文をキャンセルするかを選択できます。支払者に提示された支払レシートには、適用された料金上乗せ額が表示されます。
よくある質問
order.netAmount
フィールドと order.amount
フィールドの両方を指定した場合、ゲートウェイは料金上乗せを計算しますか。order.netAmount
フィールドと order.amount
フィールドの両方を指定し、order.surchargeAmount
を指定しない場合、ゲートウェイが料金上乗せを計算するのに十分な情報がないため、エラーが返されます。ゲートウェイでは、order.netAmount
フィールドまたは order.amount
フィールドのどちらか一方を指定する必要があります。
3 つのフィールドをすべて指定した場合、ゲートウェイは料金上乗せを計算せず、お客様が指定した料金上乗せ額を使用します。
はい。料金上乗せを適用しないことを選択するには、取引リクエストに order.amount
フィールドを指定して注文の総額を指定します — order.netAmount
フィールドや order.surchargeAmount
フィールドは指定しないでください。
はい。料金上乗せは order.amount
フィールドに含まれ、これが支払者に返金される金額になるので、料金上乗せ額も返金されます。部分返金の場合、料金上乗せ額は案分ベースで返金されます。
はい。ゲートウェイは、適用される料金上乗せを注文金額に含めます。この金額が、支払者の課金通貨で paymentTypes.card.currencyConversion.payerAmount
として、またお客様が希望する通貨で order.amount
フィールドとして(Payment Options Inquiry
操作のレスポンスの中に)返されます。
Payment Options Inquiry
リクエストに sourceOfFunds.provided.card.prefix
フィールドを指定して、支払いに使用されたカードについて以下のスキーム/資金調達の詳細情報を取得し、料金上乗せの決定に役立てることができます。
paymentTypes.card.scheme
:カードブランドを所有していて、その使用に関する運用規則を定義する組織。paymentTypes.card.brand
:そのカードを表し、世界的に認識され受け入れられているブランド名。主要なカードタイプの多くは、この名前とスキーム名が一致します。一部の市場では、カードが、その国または地域で認識され受け入れられているローカルブランド(「ローカルブランド」を参照)と共同でブランディングされている可能性があります。paymentTypes.card.localBrand
:カードを表し、その国または地域で認識され受け入れられているブランド名。カードは、世界的に認識され受け入れられているブランド名と共同でブランディングされている可能性がありますpaymentTypes.card.fundingMethod
:支払いに資金を提供するために支払者によって使用される方法。
これらの詳細情報を使用して、支払者が提示したカードに基づく料金上乗せを計算できます。