MerchantE API Docs
GET/services/apexrest/merchant-application-status/{opportunityId}
Download OpenAPI (this endpoint)JSON|Download OpenAPI (generated)JSON

Get Application Status

Retrieve the current status of a sub-merchant application using the Opportunity ID from the create/update response.

Response Varies By Type:

  • Wholesale PayFac: Returns integration status and MID
  • PayFac as a Service: Returns detailed underwriting information including status, reason codes, timestamps, and AEX document IDs

Status Fields:

  • Integration_Status__c: Success/Failed status
  • Integration_Message__c: Error details if failed
  • Integration_Failure_Stage__c: Stage where integration failed
  • MID__c: Merchant ID when approved
  • Underwriting_Status__c: Current underwriting state (PaaS only)

Note: Use the access_token in the Authorization section of the request.

Query Parameters

Required1 field
opportunityIdstring
The Salesforce Opportunity ID (SFID) from the create/update response
pattern=^[a-zA-Z0-9]{15,18}$

Status Response Types

  • Wholesale PayFac: Returns integration status and MID
  • PayFac as a Service: Returns detailed underwriting information including status, reason codes, timestamps, and AEX document IDs
  • The response varies based on the Is_ME_Underwriting__c flag set during application creation

Key Status Fields

  • Integration_Status__c: Success/Failed status
  • Integration_Message__c: Error details if failed
  • MID__c: Merchant ID when approved
  • Underwriting_Status__c: Current underwriting state (PaaS only)

Code samples

Copy-paste ready code in your preferred language.

API call

Copy/paste friendly
curl -X GET "https://merchante-solutions--cert.my.salesforce.com/services/apexrest/merchant-application-status/YOUR_OPPORTUNITY_ID"