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

返金

支払に対して行われた返金を表します。このオブジェクトは、API バージョン 48.0 以降で使用できます。

サポートされているコール

create()delete()describeLayout()describeSObjects()getDeleted()getUpdated()query()retrieve()undelete()update()upsert()

特別なアクセスルール

商取引の支払エンティティにアクセスするには、組織に支払プラットフォーム組織権限が有効になっている Salesforce Order Management ライセンスが必要です。

項目

項目 詳細
AccountId
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
この返金の対象となる支払を含むカスタマー取引先。
これはリレーション項目です。
リレーション名
Account
リレーション種別
参照関係
参照先
Account
Amount
currency
プロパティ
Create、Filter、Sort、Update
説明
この返金の総額。
Balance
currency
プロパティ
Filter、Nillable、Sort
説明
返金品目適用後の残高。Amount 項目 – NetApplied 項目と等しくなります。
CancellationDate
dateTime
プロパティ
Create、Filter、Nillable、Sort、Update
説明
返金がキャンセルされた日付。サービスを取り消す場合、これは必須パラメータです。
CancellationEffectiveDate
dateTime
プロパティ
Create、Filter、Nillable、Sort、Update
説明
この返金のキャンセルが有効になる日付。
CancellationGatewayDate
dateTime
プロパティ
Create、Filter、Nillable、Sort、Update
説明
支払ゲートウェイでキャンセルトランザクションが処理された日付。
CancellationGatewayRefNumber
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
キャンセルトランザクションの一意の ID。支払ゲートウェイによって生成されます。
CancellationGatewayResultCode
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
キャンセルトランザクションに対するゲートウェイ固有の結果コード。支払ゲートウェイによって生成されます。Salesforce 固有の結果コードに対応付けられている必要があります。
CancellationSfResultCode
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
1 つ以上のゲートウェイ結果コードに対応付けできる Salesforce-固有の結果コード。ゲートウェイ結果コードを適切な Salesforce 結果コードに対応付けるように支払ゲートウェイアダプタレイヤを設定することをお勧めします。
ClientContext
textarea
プロパティ
Nillable
説明
支払 API のコール元コンテキストを含みます。非同期の支払トランザクション中にコンテキストを再確立する場合に役立ちます。
Comments
textarea
プロパティ
Create、Filter、Nillable、Sort、Update
説明
ユーザがレコードの詳細に関するコメントを追記できます。最大 1000 文字です。
CurrencyIsoCode
picklist
プロパティ
Create、Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
支払グループレコードに関連付けられている 3 文字の ISO 4217 通貨コード。
Date
dateTime
プロパティ
Create、Defaulted on create、Filter、Nillable、Sort、Update
説明
この返金が作成された日時。
EffectiveDate
dateTime
プロパティ
Create、Filter、Nillable、Sort、Update
説明
返金適用が有効になる日時を定義します。
Email
email
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
不正パラメータ。
GatewayDate
dateTime
プロパティ
Create、Filter、Nillable、Sort、Update
説明
正常なゲートウェイ通信によってこの返金が作成された日付。
GatewayRefNumber
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
支払ゲートウェイにより作成された一意のトランザクション ID。
GatewayResultCode
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
ゲートウェイ固有の結果コード。Salesforce 固有の結果コードに対応付けられている必要があります。
GatewayResultCodeDescription
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
GatewayResultCode の説明。ゲートウェイが特定の結果コードを返した理由について補足説明する場合に役立ちます。
ImpactAmount
currency
プロパティ
Filter、Nillable、Sort
説明
この返金が顧客の売掛金勘定に及ぼす財務上の影響を示します。返金金額が有効な場合は、返金の Amount 項目と等しくなります。返金金額が無効な場合は、0 になります。返金がキャンセルされた場合は、null 値になります。
IpAddress
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
不正パラメータ。
LastReferencedDate
dateTime
プロパティ
Filter、Nillable、Sort
説明
現在のユーザがこのレコードに関連するレコードを最後に表示したときのタイムスタンプ。
LastViewedDate
dateTime
プロパティ
Filter、Nillable、Sort
説明
現在のユーザがこのレコードを最後に表示したときのタイムスタンプ。この値が null の場合、このレコードは参照 (LastReferencedDate) されただけで、表示はされていない可能性があります。
MacAddress
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
不正パラメータ。
NetApplied
currency
プロパティ
Filter、Nillable、Sort
説明
TotalApplied 項目 – TotalUnapplied 項目と等しくなります。
OrderPaymentSummaryId
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
注文に対して行われた各承認、収集、返金の残高が表示される注文支払概要レコード。
PaymentGatewayId
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
この返金の処理に使用される支払ゲートウェイ。
これはリレーション項目です。
リレーション名
PaymentGateway
リレーション種別
参照関係
参照先
PaymentGateway
PaymentGroupId
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
返金される支払の支払グループ。
これはリレーション項目です。
リレーション名
PaymentGroup
リレーション種別
参照関係
参照先
PaymentGroup
PaymentMethodId
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
返金される支払の作成に使用された支払方法。
これはリレーション項目です。
リレーション名
PaymentMethod
リレーション種別
参照関係
参照先
PaymentMethod
Phone
phone
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
不正パラメータ。
ProcessingMode
picklist
プロパティ
Create、Filter、Group、Restricted picklist、Sort
説明
支払が支払プラットフォームの外部で行われたかどうかを定義します。
使用可能な値は次のとおりです。
  • External: トランザクションは、Salesforce 支払プラットフォームの外部で行われました。
  • Salesforce: Salesforce が支払ゲートウェイへの外部コールを行い、記録しました。
RefundNumber
string
プロパティ
Autonumber、Defaulted on create、Filter、idLookup、Sort
説明
システムで作成されたこの返金の一意の ID。
SfResultCode
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
1 つ以上のゲートウェイ結果コードに対応付けできる Salesforce-固有の結果コード。ゲートウェイ結果コードを適切な Salesforce 結果コードに対応付けるように支払ゲートウェイアダプタレイヤを設定することをお勧めします。
使用可能な値は次のとおりです。
  • Decline: ゲートウェイコールは失敗しましたが、トランザクションがもう一度試行されれば成功する可能性があります。たとえば、顧客の資金が不足していた場合や、一時的に接続が失われた場合などです。
  • Indeterminate: ゲートウェイがコールに応答しませんでした。通常、この応答は Salesforce がゲートウェイからの応答を待っているときにタイムアウトした場合に発生します。
  • PermanentFail: ゲートウェイコールが失敗し、もう一度試行しても失敗します。ゲートウェイコールが永続的に失敗するのは、次のいずれかの理由です。
    • ハード拒否: 顧客の支払口座が閉鎖または契約解除されました。
    • 不正: ゲートウェイは、この支払または支払方法を既知の不正と認識しました。
  • RequiresReview: 顧客の銀行は、支払を完了する前に追加情報を要求しています。
  • Success: ゲートウェイコールは成功しました。
  • SystemError: Salesforce が、応答を受信する前に支払要求を終了しました。たとえば、Salesforce がサーバへのログイン情報やアクセス権を失った場合などです。Salesforce は、2 分以内にゲートウェイから応答を受信しなければ支払コールを終了します。
  • ValidationError: 顧客の支払データが正しくありません。クレジットカードの住所に誤字があったり、CVV が間違っている場合などです。
Status
picklist
プロパティ
Create、Filter、Group、Restricted picklist、Sort、Update
説明
この返金の状態を定義します。
使用可能な値は次のとおりです。
  • Canceled: この返金は、無効になったため、割り当てることができなくなりました。
  • Draft: この返金は、転記して対象に割り当てる前に編集できます。
  • Processed: この返金は、最終決定されたため、対象に割り当てることができます。
ユーザは Status 項目の値を手動で次のように変更できます。
  • Draft から Processed へ
  • Processed から Canceled へ
  • Draft から Canceled へ
TotalApplied
currency
プロパティ
Filter、Nillable、Sort
説明
この返金のすべての適用済み返金品目の Amount 項目の合計。
TotalUnapplied
currency
プロパティ
Filter、Nillable、Sort
説明
この返金のすべての適用解除済み返金品目の Amount 項目の合計。
Type
picklist
プロパティ
Create、Filter、Group、Restricted picklist、Sort、Update
説明
この返金の使用方法を定義します。
使用可能な値は次のとおりです。
  • NonReferenced: どの支払にもリンクされていない単独の返金。
  • Referenced: 支払に対して行われた返金。