この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

支払承認取消サービス API

承認取消とは、顧客の支払方法で資金の保留を解除することにより承認を無効にするトランザクションです。承認取消サービスを使用すると、ユーザーは未決の支払承認を取り消すことができます。

顧客は支払承認を実行しますが、後で承認のすべてまたは一部をキャンセルする必要がある場合があります。たとえば、顧客が 3 つの品目を購入し、その後、最初の品目がすでに在庫にあることに気付いたとします。商取引の支払 API では、未決の支払承認のすべてまたは一部を取り消すことができます。

顧客支払ゲートウェイで支払が承認された後、商取引の支払によって承認に関する情報を保存するための支払承認レコードが作成されます。ユーザーまたはプロセスが承認に対して取消を行うと、承認取消サービスによっ��情報を保存するための支払承認調整が作成されます。調整は承認に関連しています。

支払承認が注文支払概要に関連付けられている場合、取消金額は注文支払概要の AuthorizationReversalAmount に追加され、その AvailableToCaptureAmount から差し引かれます。ただし、取消の計算で金額が負になっても、AvailableToCaptureAmount が 0 を下回ることはありません。

承認取消の場合、支払ゲートウェイログの OrderPaymentSummaryId は、デフォルトで常に null に設定されます。関連する注文支払概要がある場合は、コードで値を設定できます。

メモ

承認取消サービスをコールするには、次のエンドポイントに POST 要求を実行します。

エンドポイント

1/commerce/payments/authorizations/${*authorizationId*}/reversals

このサービスは 1 つのコールに 1 つの承認取消要求を受け入れます。許可されている支払承認調整 API パラメーターは次のとおりです。

表 1. 取消サービス入力パラメーター
パラメーター	必須	説明
amount	必須	承認から取り消される金額。0 以下は指定できません。 Salesforce では、`PaymentAuthorizationAdjustment.Amount` と `PaymentAuthorization.Amount` を比較する検証は行っていません。支払ゲートウェイが承認額を上回る取消額を許可している場合、承認の結果残高が負の値になる可能性があります。ゲートウェイが 0 を下回る承認残高をサポートしている場合にゲートウェイコールを回避するには、アダプターが承認の金額、残高、および合計取消額を照会するように設定して、残高が 0 を下回っていてもエンドポイントをコールしないようにします。
accountId	省略可能	この承認取消がリンクされている取引先 ID。
effectiveDate	省略可能	取消が承認に適用される日付。
email	省略可能	不正パラメーター
ipAddress	省略可能	不正パラメーター
macAddress	省略可能	不正パラメーター
phone	省略可能	不正パラメーター
comments	省略可能	承認取消に関するユーザーによるコメント。1,000 文字未満である必要があります。

要求と応答のサンプル

この要求は、承認に対して 150 ドルの取消をコールします。

1{
2  "accountId":"",
3  "amount": "150",*  "comments": "authorization reversal request",
4  "effectiveDate":"2020-10-18T11:32:27.000Z",
5  "ipAddress": "202.95.77.70",
6  "macAddress": "00-14-22-01-23-45",
7  "phone": "100-456-67",
8  "email": "test@example.org",
9  "additionalData":{
10       //add additional parameters if needed
11      "key1":"value1",
12      "key2":"value2",
13      "key3":"value3",
14      "key4":"value4",
15      "key5":"value5"
16    }
17}

サンプル応答 - 成功

承認取消応答が成功すると、ゲートウェイの応答と支払承認調整エンティティを作成するための値に関する情報が提供されます。

1HPP Status Code: 201
2{
3  "gatewayResponse" : {
4    "gatewayDate" : "2020-10-23T15:21:58.833Z",
5    "gatewayReferenceNumber" : "439XXXXXXX",
6    "gatewayResultCode" : "00",
7    "gatewayResultCodeDescription" : "Transaction Normal",
8    "salesforceResultCode" : "Success"
9  },
10  "paymentAuthAdjustment" : {
11    "amount" : "150.0",
12    "currencyIsoCode" : "USD",
13    "effectiveDate" : "2020-10-18T11:32:27.000Z",
14    "id" : "9tvR00000004Cf1MAE",
15    "paymentAuthAdjustmentNumber" : "PAA-00XXXXXXX",
16    "requestDate" : "2020-10-23T15:21:58.000Z",
17    "status" : "Processed"
18  },
19  "paymentGatewayLogs" : [ {
20    "createdDate" : "2020-10-23T15:21:58.000Z",
21    "gatewayResultCode" : "00",
22    "id" : "0XtXXXXXXXXXXXXXXX",
23    "interactionStatus" : "Success"
24  } ]
25}

Salesforce での支払承認調整の結果はこのようになります。

エラーが返された場合、応答にはゲートウェイのエラーコードとエラーメッセージが表示されます。

サンプル応答 - エラー

1{
2    "errorCode":"",
3    "errorMessage":""
4}

Apex 開発者ガイド

支払承認取消サービス API

要求と応答のサンプル