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

Get Application Opportunity

Retrieve opportunity details for a specific application by Opportunity ID.

Returns the Opportunity record including submission details, volumes, business model, programs, channels, and other application-level fields.

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

Path Parameters

Required1 field
opportunityIdstring
The SFId value associated with the ObjectType Opportunity
Other1 field
string

Responses

200
Opportunity details

Opportunity details

Common5 fields
attributesobject
BET_Table_ID_API_Field__cstring
BET Table ID (required)
maxLength=255
Yearly_Net_Revenue__cnumber
Forecasted yearly net revenue (required)
format=double
Visa_MC_Discover_Volume__cnumber
Visa/MC/Discover volume (required)
format=double
Merchant_Application_Notes__cstring
Merchant application notes (required)
maxLength=255
When Provided1 field
Seasonal_Months__cstring
Seasonal months of operation (multi-select picklist - separate values with semicolons)
Other Fields46 fields
idstring
Salesforce record Id (SFId) of the object being updated. Include in update requests.
StageNamestring
Opportunity stage
RecordTypeIdstring
Record Type ID for the opportunity
Valid Record Type IDs:
- Cross_Sell: 0122T000000kwYzQAI
- New_Direct_Merchant_Opportunity: 01234000000QEUSAA4
- New_Partner_Merchant: 01234000000M77hAAC
- New_Partner_Opportunity: 01234000000HqAGAA0
- Read_Only_New_Partner_Merchant: 0123x000001WMxcAAG
- Renewal: 0122T000000ca5QQAQ
Account_Type__cstringenum
Account type
Namestring
Opportunity name
maxLength=255
Auto_Submission_to_Underwriting__cboolean
Auto submit to underwriting
Need_Pricing_Exception_Approval__cboolean
Whether pricing exception approval is needed
Yearly_Card_Volume__cnumber
Yearly card volume
format=double
High_Monthly_Volume__cnumber
High monthly processing volume
format=double
Avg_Ticket__cnumber
Average ticket amount
format=double
High_Ticket__cnumber
High ticket amount
format=double
American_Express_Volume__cnumber
American Express volume
format=double
Customer_Type_B2B_Sales__cnumber
Customer Type % B2B Sales (must add up to 100% with B2C per validation rules)
format=double · minimum=0 · maximum=100
Customer_Type_B2C_Sales__cnumber
Customer Type % B2C Sales (must add up to 100% with B2B per validation rules)
format=double · minimum=0 · maximum=100
Refund_Policy__cstringenum
Refund policy
Days_to_Ship_Deliver__cstringenum
Days to ship/deliver
Advanced_Payments__cnumber
Percentage of advanced payments
format=double · minimum=0 · maximum=100
Visa_MasterCard__cboolean
Accepts Visa/MasterCard
Discover_MeS_Settlement__cboolean
Discover MeS settlement
Discover_Settlement_Existing_Merchant__cboolean
Discover settlement existing merchant
American_Express_MeS_Settlement__cboolean
American Express MeS settlement
Amex_Settlement_Existing_SE__cstring
AmEx settlement existing SE number
maxLength=255
Debit_with_Pin__cboolean
Debit with PIN
ACH__cstring
ACH configuration
EBT__cstring
EBT acceptance
FCS__cstring
FCS number
maxLength=10
Check_Authorization__cstring
Check authorization
Name_of_Provider__cstring
Name of provider
maxLength=60
Merchant__cstring
Merchant number
maxLength=40
Check_pct__cnumber
Check percentage
format=double · minimum=0 · maximum=100
Card_Network_Volume_Internet_CNP__cnumber
Card Network Volume % Internet (CNP) - must add up to 100% with other card network volume fields per validation rules
format=double · minimum=0 · maximum=100
Card_Network_Volume_Manually_K_M__cnumber
Card Network Volume % Manually K/M (CP) - must add up to 100% with other card network volume fields per validation rules
format=double · minimum=0 · maximum=100
Card_Network_Volume_MO_TO_CNP__cnumber
Card Network Volume % MO/TO (CNP) - must add up to 100% with other card network volume fields per validation rules
format=double · minimum=0 · maximum=100
Card_Network_Volume_Swiped_CP__cnumber
Card Network Volume % Swiped (CP) - must add up to 100% with other card network volume fields per validation rules
format=double · minimum=0 · maximum=100
ACH_Debit_Avg_Dollar_Per_Tx__cnumber
ACH Debit average dollar per transaction
format=double
ACH_Credit_Avg_Dollar_Per_Tx__cnumber
ACH Credit average dollar per transaction
format=double
ACH_Debit_Max_Dollar_Per_Tx__cnumber
ACH Debit maximum dollar per transaction
format=double
ACH_Credit_Max_Dollar_Per_Tx__cnumber
ACH Credit maximum dollar per transaction
format=double
ACH_Debit_Max_Dollar_Per_Day__cnumber
ACH Debit maximum dollar per day
format=double
ACH_Credit_Max_Dollar_Per_Day__cnumber
ACH Credit maximum dollar per day
format=double
ACH_Debit_Max_Tx_Per_Day__cnumber
ACH Debit maximum transactions per day
format=double
ACH_Credit_Max_Tx_Per_Day__cnumber
ACH Credit maximum transactions per day
format=double
ACH_Debit_Max_Dollar_Per_Month__cnumber
ACH Debit maximum dollar per month
format=double
ACH_Credit_Max_Dollar_Per_Month__cnumber
ACH Credit maximum dollar per month
format=double
ACH_Debit_Max_Tx_Per_Month__cnumber
ACH Debit maximum transactions per month
format=double
ACH_Credit_Max_Tx_Per_Month__cnumber
ACH Credit maximum transactions per month
format=double

Example response

{}
404
Opportunity not found

Opportunity not found

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"