Newer Version Available

This content describes an older version of this product. View Latest

MerchantAccount

Represents a business account at a payment provider that accepts payments in multiple ways, including credit or debit cards, or digital wallets. This object is available in API version 56.0 and later.

A Salesforce Payments merchant account is a type of merchant account that links to merchant accounts at payment providers.

Supported Calls

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

Special Access Rules

To access Salesforce Payments entities, you must have a Salesforce Payments license with the Payments permission enabled for your org. Salesforce Payments entities are available only in Lightning Experience.

Fields

Field Details
Description
Type
textarea
Properties
Create, Nillable, Update
Description
Information about the merchant account.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record, a record related to this record, or a list view.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it.
Mode
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Indicates if the merchant account is in Live mode or Test mode. For production, the account must be in Live mode.
Possible values are:
  • Live
  • Test
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Name of the merchant account.
Owner Name
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Name of the user or group assigned to the merchant account.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
Status
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Indicates the status of the merchant account.
Possible values are:
  • Active - the merchant account can accept payments.
  • Pending - the merchant account exists but it can’t accept payments. For backward compatibility with API version 55.0.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

MerchantAccountFeed
Feed tracking is available for the object.
MerchantAccountHistory
History is available for tracked fields of the object.
MerchantAccountOwnerSharingRule
Sharing rules are available for the object.
MerchantAccountShare
Sharing is available for the object.