afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/MerchantAccount.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "associated_objects",
    "field_reference"
  ],
  "title": "MerchantAccount - Data API",
  "description": "A type of bank account that lets a merchant accept payments from a variety of payment methods, including credit or debit cards, or digital wallets. A Salesforce Payments merchant account is linked to an underlying payment gateway to process payments This object is available in API version 56.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "AccountDescription": {
      "type": "textarea",
      "properties": "Create, Nillable, Update",
      "description": "Information about the merchant account."
    },
    "CountryIsoCode": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "Country where the legal entity representing the account is."
    },
    "CurrencyIsoCode": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "Contains the ISO code for any currency allowed by the organization. Available only for organizations with multi-currency enabled."
    },
    "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 can have accessed this record or list view but not viewed it."
    },
    "Mode": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "The operational mode of the merchant account. This field determines the account’s ability to accept payments. For production, the account must be in Live mode. Possible values are: Connected– Merchant account is active but it can’t accept payments. This option is only valid in production orgs. Live– Merchant account is active and can accept payments. This option is only valid in production orgs. Test –Merchant account is active but not able to accept payments. This option is only valid in sandbox orgs, and the account can accept only test transactions."
    },
    "Name": {
      "type": "string",
      "properties": "Create, Filter, Group, idLookup, Sort, Update",
      "description": "Name of the merchant account."
    },
    "OwnerId": {
      "type": "reference",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Name of the individual or group assigned to the merchant account. This field is a polymorphic relationship field.",
      "relationship_name": "Owner",
      "relationship_type": "Lookup",
      "refers_to": "Group, User"
    },
    "PaymentStatus": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "Merchant account is active and can accept payments. Possible values are: Disabled Enabled The default value is Disabled."
    },
    "PayoutStatus": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "Money can be moved from the payment provider account to the designated merchant account. Possible values are: Disabled Enabled The default value is Disabled."
    },
    "Status": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "Indicates the state of the merchant account. Possible values are: Active - The merchant account can accept payments. Complete - PaymentStatus and DepositStatus are enabled and all the required information is provided. Enabled - PaymentStatus and PayoutStatus are enabled, but the payment provider requires more information later. If the merchant doesn't provide the information, then the account becomes restricted. The time limit that the merchant has to provide the information is longer than the RestrictedSoon state. Pending - The merchant account exists but it can’t accept payments. This option maintains backward compatibility for accounts that were created with API version 55.0 and earlier. Rejected - The account is rejected and an explanation is provided. Restricted - PaymentStatus, PayoutStatus, or both are disabled, so the merchant account’s operation is limited. Restricted Soon - PaymentStatus and PayoutStatus are enabled, but the payment provider requires more information. If the merchant doesn't provide the information in a specific time period, then the account becomes restricted."
    }
  },
  "special_access_rules": "To access Salesforce Payments objects, you must have a Salesforce Payments license and Payments must be enabled for your org. Salesforce Payments objects are available only in Lightning Experience.",
  "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.\n\n- **MerchantAccountChangeEvent (API version 62.0)**: Change events are available for the object.\n- **MerchantAccountFeed**: Feed tracking is available for the object.\n- **MerchantAccountHistory**: History is available for tracked fields of the object.\n- **MerchantAccountOwnerSharingRule**: Sharing rules are available for the object.\n- **MerchantAccountShare**: Sharing is available for the object.",
  "field_reference": {
    "AccountDescription": {
      "field_label": "Description",
      "type": "textarea",
      "length": "32000"
    },
    "CountryIsoCode": {
      "field_label": "Country",
      "type": "string",
      "length": "2"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "CurrencyIsoCode": {
      "field_label": "Currency ISO Code",
      "type": "picklist",
      "length": "3"
    },
    "DefaultTapToPayLocation": {
      "field_label": "Tap To Pay Location",
      "type": "string",
      "length": "40"
    },
    "Id": {
      "field_label": "Merchant Account ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LastReferencedDate": {
      "field_label": "Last Referenced Date",
      "type": "datetime"
    },
    "LastViewedDate": {
      "field_label": "Last Viewed Date",
      "type": "datetime"
    },
    "Mode": {
      "field_label": "Mode",
      "type": "picklist",
      "length": "255"
    },
    "Name": {
      "field_label": "Name",
      "type": "string",
      "length": "255"
    },
    "OwnerId": {
      "field_label": "Owner ID",
      "type": "reference",
      "length": "18"
    },
    "PaymentStatus": {
      "field_label": "Payment Status",
      "type": "picklist",
      "length": "255"
    },
    "PayoutStatus": {
      "field_label": "Payout Status",
      "type": "picklist",
      "length": "255"
    },
    "Status": {
      "field_label": "Account Status",
      "type": "picklist",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length"
  ]
}