MerchantE API Docs
GET/applications/{opportunityId}/account
Download OpenAPI (this endpoint)JSON|Download OpenAPI (generated)JSON

Get Account

Retrieve the merchant account (Account object) associated with a specific application.

Returns the Account record including merchant identity, legal/DBA addresses, contact information, business profile, and processing history.

Backend path: /services/data/v54.0/sobjects/Opportunity/{opportunityId}/Account.

Path Parameters

Required1 field
opportunityIdstring
The Salesforce ID (SFId) of the Opportunity record
Other1 field
string

Responses

200
Account details

Account details

Common23 fields
attributesobject
Namestring
Merchant DBA Name (required). If field exceeds maximum length, value will be truncated.
maxLength=255
Legal_Name__cstring
Legal name (required). If field exceeds maximum length, value will be truncated.
maxLength=100
Tax_ID__cstring
Federal Tax ID - must be 9 digits (required). Validation error "Federal Tax ID Enter valid Federal Tax ID" if not 9 digits.
pattern=^\d{9}$ · maxLength=16
State_of_Entity_Formation_Incorporation__cstring
State of formation/incorporation (required)
maxLength=2
MCC_API_Field__cstring
MCC (Merchant Category Code) - required. Validation error if invalid MCC entered.
maxLength=100
BillingStreetstring
Legal street address (required). If field exceeds maximum length, value will be truncated.
maxLength=255
BillingCitystring
Legal city (required). If field exceeds maximum length, value will be truncated.
maxLength=40
BillingStateCodestring
Legal state/province code (required). See PDF pages 36-38 for full list of valid state codes.
maxLength=80
BillingPostalCodestring
Legal zip code - must be 5 digits (required). Validation error "Legal Address Zipcode Enter Valid Legal Address Zipcode" if not 5 digits.
pattern=^\d{5}$ · maxLength=20
BillingCountryCodestring
Legal country code (required). See PDF pages 36-38 for full list of valid country codes.
maxLength=80
ShippingStreetstring
DBA street address (required). If field exceeds maximum length, value will be truncated.
maxLength=255
ShippingCitystring
DBA city. If field exceeds maximum length, value will be truncated.
maxLength=40
Phonestring
Phone number - must be 10 digits or (999) 999-9999 format (required). Validation error "Phone/Fax number must be a 10-digit number or in (999) 999-9999 format" if invalid.
pattern=^(\d{10}|\(\d{3}\)\s\d{3}-\d{4})$
App_Email__cstring
Email address (required). Validation error "Enter valid Email Address" if invalid format.
format=email · maxLength=100
Customer_Service_Phone__cstring
Customer service phone - must be 10 digits or (999) 999-9999 format (required)
pattern=^(\d{10}|\(\d{3}\)\s\d{3}-\d{4})$
Ownershipstringenum
Legal entity type (required). Validation error "Sponsorship is required" if missing.
See PDF pages 27-28 for required contact fields based on this ownership type.
Industrystringenum
Industry (required)
Location_Type__cstringenum
Business location type (required)
Years_at_Location__cstring
Years at location (required)
Date_Established__cstring
Date established (required)
format=date
Chain_Non_Chain__cstringenum
Chain/Non-chain status (required)
Descriptionstring
Business description (required)
maxLength=32000
When Provided2 fields
Industry_Other__cstring
Other industry description (required if Industry is "Other")
maxLength=100
Location_Other__cstring
Other location description (required if Location_Type__c is "Other")
maxLength=100
Other Fields17 fields
idstring
Salesforce record Id (SFId) of the object being updated. Include in update requests.
Association_ID_API_Field__cstring
Association ID. Validation error if invalid Association ID entered.
maxLength=100
ShippingStateCodestring
DBA state/province code. See PDF pages 36-38 for full list of valid state codes.
maxLength=80
ShippingPostalCodestring
DBA zip code - must be 5 digits if provided. Validation error "DBA Address Zipcode Enter valid DBA Address Zipcode" if not 5 digits.
pattern=^\d{5}$ · maxLength=20
ShippingCountryCodestring
DBA country code. See PDF pages 36-38 for full list of valid country codes.
maxLength=80
Physical_Address_Street__cstring
Physical address street. If field exceeds maximum length, value will be truncated.
maxLength=255
Physical_Address_City__cstring
Physical address city. If field exceeds maximum length, value will be truncated.
maxLength=80
Physical_Address_State__cstring
Physical address state. See PDF pages 36-38 for valid state codes.
maxLength=80
Physical_Address_PostalCode__cstring
Physical address postal code - must be 5 digits if provided. Validation error "Mailing Address Zipcode Enter valid Mailing Address Zipcode" if not 5 digits.
pattern=^\d{5}$ · maxLength=80
Faxstring
Fax number - must be 10 digits or (999) 999-9999 format if provided. Validation error "Phone/Fax number must be a 10-digit number or in (999) 999-9999 format" if invalid.
pattern=^(\d{10}|\(\d{3}\)\s\d{3}-\d{4})$
Websitestring
Website address
format=uri · maxLength=255
Ever_accepted_credit_cards_before__cboolean
Ever accepted credit cards before
Name_of_Previous_Processor__cstring
Name of previous processor
maxLength=100
Ever_had_a_merchant_account_canceled__cboolean
Ever had a merchant account canceled
Name_of_Processor_for_canceled_merchant__cstring
Name of processor for canceled merchant account
maxLength=100
Reason_for_cancellation__cstring
Reason for cancellation
maxLength=255
Date_of_cancellation__cstring
Date of cancellation
format=date

Example response

{}

Code samples

Copy-paste ready code in your preferred language.

API call

Copy/paste friendly
curl -X GET "https://test.salesforce.com/applications/YOUR_OPPORTUNITY_ID/account"