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

支払

買い物客が支払を行うときの 1 つのイベントを表します。クレジットカードの場合、このイベントは支払収集または支払売上になりますが、買い物客のクレジットカード明細には表示されません。このオブジェクトは、API バージョン 48.0 以降で使用できます。

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

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

Status 項目で指定するドラフト状態の支払のみを削除できます。

メモ

特別なアクセスルール

API で Salesforce Payment オブジェクトにアクセスするには、組織に Salesforce Order Management ライセンス、B2B Commerce ライセンス、または B2C (B2B2C Commerce 用) ライセンスが必要です。これらのライセンスのいずれかによって、必要な支払プラットフォーム組織権限が有効になります。Salesforce Payment オブジェクトは、Lightning Experience のみで使用できます。

項目

項目 詳細
AccountId
型
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
支払を行った顧客の取引先。
この項目はリレーション項目です。
リレーション名
Account
リレーション種別
Lookup
参照先
Account
Amount
型
currency
プロパティ
Create、Filter、Sort、Update
説明
引き落としまたは収集される金額。
Balance
型
currency
プロパティ
Filter、Nillable、Sort
説明
合計金額 – 適用される正味金額。
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
説明
ユーザは、支払レコードに関するその他の詳細を提供できます。最大 1,000 文字サポートされています。
CurrencyIsoCode
型
picklist
プロパティ
Create、Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
支払グループレコードに関連付けられている 3 文字の ISO 4217 通貨コード。
Date
型
dateTime
プロパティ
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
説明
ゲートウェイ通信が成功すると、ゲートウェイがこの日付を参照のために提供します。
GatewayRefDetails
型
textarea
プロパティ
Create、Filter、Nillable、Sort、Update
説明
支払レコードの他の項目に保存できない追加データ。支払レコードが作成される最初のトランザクションの後に、トランザクションのこの項目を使用できます。金融エンティティで正規化されていない任意のデータを使用できます。この項目の最大文字数は 1000 文字で、データは JSON または XML として保存できます。
GatewayRefNumber
型
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
支払ゲートウェイにより作成された一意のトランザクション ID。
GatewayResultCode
型
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
ゲートウェイ固有の結果コード。Salesforce 固有の結果コードに対応付ける必要があります。1 つの Salesforce 結果コードを複数のゲートウェイ結果コードに対応付けることができます。
GatewayResultCodeDescription
型
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
ゲートウェイの結果コードの説明。
ImpactAmount
型
currency
プロパティ
Filter、Nillable、Sort
説明
この支払が顧客の売掛金勘定に及ぼす財務上の影響を示します。支払が有効であれば、この値は支払金額の負の値になります。支払が無効であれば、この値は 0 です。
IpAddress
型
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
支払を開始したユーザの IP アドレス。
LastReferencedDate
型
dateTime
プロパティ
Filter、Nillable、Sort
説明
現在のユーザがこのレコードに関連するレコードを最後に表示したときのタイムスタンプ。
LastViewedDate
型
dateTime
プロパティ
Filter、Nillable、Sort
説明
現在のユーザがこのレコードを最後に表示したときのタイムスタンプ。この値が null の場合、このレコードは表示ではなく参照 (LastReferencedDate) された可能性があります。
MacAddress
型
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
支払を開始したユーザの MAC アドレス。
NetApplied
型
currency
プロパティ
Filter、Nillable、Sort
説明
これまでに適用された支払総額 (調整後)。
NetRefundApplied
型
currency
プロパティ
Filter、Nillable、Sort
説明
これまでに支払に適用された返金総額 (調整後)。
OrderPaymentSummaryId
型
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
注文支払概要には、注文に対して行われた各承認、収集、返金の残高が表示されます。
PaymentAuthorizationId
型
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
この支払の承認レコード。遅延収集がある場合 (承認後に収集が行われる場合) には、すべての収集は以前に成功した承認トランザクションに対して行われる必要があります。
この項目はリレーション項目です。
リレーション名
PaymentAuthorization
リレーション種別
Lookup
参照先
PaymentAuthorization
PaymentGatewayId
型
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
支払を処理した支払ゲートウェイの ID。遅延支払がある場合、この項目は承認レコードから入力されます。
この項目はリレーション項目です。
リレーション名
PaymentGateway
リレーション種別
Lookup
参照先
PaymentGateway
PaymentGroupId
型
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
支払グループは、取引先や契約などのレコードに対して行われたすべての支払トランザクションを整理します。遅延支払がある場合、この項目は承認レコードから入力されます。
この項目はリレーション項目です。
リレーション名
PaymentGroup
リレーション種別
Lookup
参照先
PaymentGroup
PaymentMethodId
型
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
この支払情報を提供するために顧客が使用した支払方法。
この項目はリレーション項目です。
リレーション名
PaymentMethod
リレーション種別
Lookup
参照先
PaymentMethod
PaymentNumber
型
string
プロパティ
Autonumber、Defaulted on create、Filter、idLookup、Sort
説明
システムで作成されたこの支払レコードの一意の ID。
Phone
型
phone
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
支払を開始した顧客の電話番号。
ProcessingMode
型
picklist
プロパティ
Create、Filter、Group、Restricted picklist、Sort
説明
支払が支払プラットフォームの外部で行われたかどうかを定義します。
可能な値は次のとおりです。
  • External: トランザクションは、Salesforce 支払プラットフォームの外部で行われました。
  • Salesforce: Salesforce が支払ゲートウェイへの外部コールを行い、記録しました。
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
説明
この支払で請求書に対して適用された合計残高。
TotalRefundApplied
型
currency
プロパティ
Filter、Nillable、Sort
説明
この支払に対して適用された返金総額。
TotalRefundUnapplied
型
currency
プロパティ
Filter、Nillable、Sort
説明
以前に適用され、この支払から適用解除された返金総額。
TotalUnapplied
型
currency
プロパティ
Filter、Nillable、Sort
説明
この支払で以前に適用され、その後適用解除された総額。
Type
型
picklist
プロパティ
Create、Filter、Group、Restricted picklist、Sort、Update
説明
顧客がこの支払をどのように使用したかを定義します。
可能な値は次のとおりです。
  • Capture
  • Sale