PaymentGateway

外部支払ゲートウェイへの接続を表すプラットフォームオブジェクト。このオブジェクトは、API バージョン 48.0 以降で使用できます。

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

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

特別なアクセスルール

API で Salesforce Payment オブジェクトにアクセスするには、組織に 1 つ以上の Salesforce Payments ライセンス、Salesforce Order Management ライセンス、B2B Commerce ライセンス、または D2C Commerce ライセンスが必要です。Salesforce Payment オブジェクトは、Lightning Experience のみで使用できます。

項目

項目 詳細
Comments
textarea
プロパティ
Create、Filter、Nillable、Sort、Update
説明
システム管理者が指定したレコードの詳細。最大 1000 文字です。
ExternalReference
string
プロパティ
Create、Filter、Group、idLookup、Nillable、Sort、Update
説明
外部支払ゲートウェイの識別子。この項目は組織内で一意です。
GatewayMode
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
支払ゲートウェイの操作モード。この項目は、支払を受け付けるための支払ゲートウェイの機能を決定します。本番組織の場合、ゲートウェイはライブモードである必要があります。
可能な値は次のとおりです。
  • Connected – 支払ゲートウェイは有効ですが、支払を受け付けることができません。このオプションは本番組織でのみ有効です。
  • Live – 支払ゲートウェイは有効であり、支払を受け付けることができます。このオプションは本番組織でのみ有効です。
  • Test – 支払ゲートウェイは有効ですが、支払を受け付けることができません。このオプションは Sandbox 組織でのみ有効です。取引先はテスト取引のみを受け付けることができます。
LastReferencedDate
dateTime
プロパティ
Filter、Nillable、Sort
説明
現在のユーザーがこのレコードに関連するレコードを最後に表示したときのタイムスタンプ。
LastViewedDate
dateTime
プロパティ
Filter、Nillable、Sort
説明
現在のユーザーがこのレコードを最後に表示したときのタイムスタンプ。この値が null の場合、このレコードは表示ではなく参照 (LastReferencedDate) のみされた可能性があります。
MerchantAccountId
reference
プロパティ
Create、Filter、Group、Sort、Update
説明
支払ゲートウェイによって使用された業者アカウントの ID。この業者アカウントは、支払プロセッサーの業者アカウントにリンクされています。
この項目はリレーション項目です。
リレーション名
MerchantAccount
リレーション種別
Lookup
参照先
MerchantAccount
MerchantCredentialId
reference
プロパティ
Create、Filter、Group、Sort、Update
説明
業者情報を参照するための業者のログイン情報設定エンティティの ID。
この項目はリレーション項目です。
リレーション名
MerchantCredential
リレーション種別
Lookup
参照先
NamedCredential
PaymentGatewayName
string
プロパティ
Create、Filter、Group、idLookup、Sort、Update
説明
システム管理者が定義した支払ゲートウェイの名前。
PaymentProcessor
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
支払ゲートウェイプロバイダーの名前。
可能な値は次のとおりです。
  • Paypal
  • Stripe
PaymentStatus
picklist
プロパティ
Create、Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
支払ゲートウェイは有効であり、支払を受け付けることができます。
可能な値は次のとおりです。
  • Enabled
  • Disabled
デフォルト値は Disabled です。
PayoutStatus
picklist
プロパティ
Create、Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
金額は支払プロバイダーアカウントから、支払プロバイダーアカウントにリンクされた業者の銀行口座に移動できます。
可能な値は次のとおりです。
  • Enabled
  • Disabled
デフォルト値は Disabled です。
PaymentGatewayProviderId
reference
プロパティ
Create、Filter、Group、Sort、Update
説明
業者アカウントと支払プロセッサー間のトランザクションを処理する支払ゲートウェイの ID。
この項目はリレーション項目です。
リレーション名
PaymentGatewayProvider
リレーション種別
Lookup
参照先
PaymentGatewayProvider
ProviderAccount
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
リンクされた Salesforce Payments アカウントを識別する支払プロバイダーにより割り当てられたアカウント ID。
Status
picklist
プロパティ
Create、Filter、Group、Restricted picklist、Sort、Update
説明
Salesforce Payments が外部支払ゲートウェイへのコールにこの支払ゲートウェイを使用できるかどうかを定義します。無効な支払ゲートウェイは使用できません。
可能な値は次のとおりです。
  • Active - 業者アカウントは支払を受け付けることができます。
  • Complete - PaymentStatusDepositStatus が有効になっており、アカウントによりすべての必須情報が提供されました。
  • Enabled - PaymentStatusPayoutStatus が有効になっていますが、支払プロバイダーには後で他の情報が必要になる可能性があります。業者が情報を提供しない場合、アカウントは制限される可能性があります。情報を提供するための業者の時間制限は RestrictedSoon 状態よりも長くなります。
  • Pending – 業者アカウントは存在しますが、支払を受け付けることができません。このオプションでは、API バージョン 55.0 以前を使用して作成されたアカウントの後方互換性が維持されます。Pending は、API バージョン 57.0 以降では使用できなくなりました。
  • Rejected – 支払プロバイダーが業者アカウントを却下しました (説明付き)。
  • Restricted – 業者アカウントの機能が制限されています。この状態は、PaymentStatusPayoutStatus、またはその両方が無効になっている場合のみ適用されます。
  • RestrictedSoonPaymentStatusPayoutStatus が有効になっていますが、支払プロバイダーには他の情報が必要です。特定の期間、業者が情報を提供しない場合、業者アカウントは制限されます。