GtwyProvPaymentMethodType

Represents a type that allows integrators and payment providers to choose an active payment to receive an order’s payment data rather than allowing the Salesforce Order Management platform to select a default payment method.

Version 

Introduced in API version 50.0.

Supported SOAP API Calls 

create(), delete(), describeSObjects(), query(), retrieve(), search(), update(), upsert()

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules 

• To access Commerce Payments entities, your org must have a Salesforce Order Management license with the Payment Platform org permission activated. Commerce Payments entities are available only in Lightning Experience.

Fields 

Comments 

• Type: textarea

• Required: No

• Properties: Filter, Nillable, Sort

• Description: Additional details about the gateway provider payment method type record. Max length is 1000 characters.

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. This field is automatically generated, but you can supply your own value if you create the record using the API.

  When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, Salesforce generates one for each record, which slows performance.

  Note

  Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.

  Note

Fullname 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 50.0

• Description: The full name of the associated gatewayProviderPaymentMethodType in Metadata API. The full name can include a namespaceprefix.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

GtwyProviderPaymentMethodType 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Links the Salesforce payment method to the payment method used in the Salesforce Order Management storefront. Your payment gateway integration uses this field when finding a payment method to link to a payment.

The value of GtwyProviderPaymentMethodType must match the payment method value sent to the order’s Payment Instrument in Salesforce Order Management.

Here are examples of payment method values that Salesforce could receive from Salesforce Order Management.

• CREDIT_CARD
• BASIC_CREDIT
• CreditCard
• GooglePay
• ApplePay

Language 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Description: The language of the payment gateway integration.

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

ManageableState 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: Indicates the manageable state of the specified component that is contained in a package:

• beta

• deleted

• deprecated

• deprecatedEditable

• installed

• installedEditable

• released

• unmanaged

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

MasterLabel 

• Type: string

• Required: No

• Properties: Filter, Group, idLookup, Sort

• Description: Required. Label for the GtwyProvPaymentMethodType. In the UI, this field is Gateway Provider Payment Method Type.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 50.0

• Description: Metadata associated with the gateway provider payment method type.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of the following values.

• In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer.
• In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.

PaymentGatewayProviderId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Specifies the payment gateway provider that Salesforce Order Management should use when processing payments. One payment gateway provider can be related to multiple payment method types.

This is a relationship field.

• Relationship name: PaymentGatewayProvider
• Relationship type: relationship
• Refers to: PaymentGatewayProvider

PaymentMethodType 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: Specifies the type of payment method used on an order in Salesforce Order Management.

Usage 

The Salesforce Order Management payment record must have a ProcessorId field with the same value as the payment gateway’s ExternalReferenceId field. The gateway provider payment method type record must have a PaymentMethodType field that looks up to the payment method that you want to relate to your payment. Finally, the payment gateway and gateway provider payment method type must have matching PaymentGatewayProviderId fields. After you establish these relationships, the payment record infers your payment method from the gateway provider payment method type record.