POST/applications

Download OpenAPI (this endpoint)JSON|Download OpenAPI (generated)JSON

Create Application (Docs Alias)

Documentation-friendly alias for creating an application.

Backend path: /services/data/v54.0/composite/sobjects (Salesforce Composite SObject API). Use this alias in docs UIs to see a cleaner endpoint name; for direct Salesforce calls, use the backend path.

Request Body

Content type: application/json

Required2 fields

Oppobject

Fields controlling application submission and routing.

Merobject

Core merchant identity fields.

Others3 fields

lstBensarray<object>

List of Beneficial Owners (Contacts)

lstbussCheckAccarray<object>

List of Business Checking Accounts

Lstqliarray<object>

List of Quote Line Items (Solutions, Fees, Equipment)

Enums (9)

Opp.attributes.type

Opportunity

Opp.Account_Type__c

New Merchant, Conversion Merchant, Renewal Merchant, Cloned Merchant Deal

Opp.Refund_Policy__c

Refund in 30 days or Less, No Refunds or Exchanges, Exchanges Only, Not Applicable, Credit V/MC/Dis Account, Full Refund, Refund Credit, Refund Merchandise

Opp.Days_to_Ship_Deliver__c

Immediate, 1 to 7, 8 to 14, 15 to 30, Over 30

Mer.attributes.type

Account

Mer.Ownership

Sole Proprietorship, Publicly Traded Limited Liability Company, Privately Held Limited Liability Company, Publicly Traded Corporation, Privately Held Corporation, Government, Tax Exempt, Publicly Traded Partnership, Privately Held Partnership, Financial Institution

Mer.Industry

Retail, Restaurant, Lodging, Supermarket, Ecommerce, Direct Marketing Services, Cash Advance, Other

Mer.Location_Type__c

Ecommerce, Business Office, Private Residence, Retail Storefront, Bank, Other

Mer.Chain_Non_Chain__c

Single Outlet, Chain/Multi-Location, Additional Location

Validations (67)

Opp.Name

maxLength=255

Opp.BET_Table_ID_API_Field__c

maxLength=255

Opp.Yearly_Net_Revenue__c

format=double

Opp.Yearly_Card_Volume__c

format=double

Opp.High_Monthly_Volume__c

format=double

Opp.Avg_Ticket__c

format=double

Opp.High_Ticket__c

format=double

Opp.Visa_MC_Discover_Volume__c

format=double

Opp.American_Express_Volume__c

format=double

Opp.Customer_Type_B2B_Sales__c

format=double · minimum=0 · maximum=100

Opp.Customer_Type_B2C_Sales__c

format=double · minimum=0 · maximum=100

Opp.Advanced_Payments__c

format=double · minimum=0 · maximum=100

Opp.Amex_Settlement_Existing_SE__c

maxLength=255

Opp.FCS__c

maxLength=10

Opp.Name_of_Provider__c

maxLength=60

Opp.Merchant__c

maxLength=40

Opp.Check_pct__c

format=double · minimum=0 · maximum=100

Opp.Card_Network_Volume_Internet_CNP__c

format=double · minimum=0 · maximum=100

Opp.Card_Network_Volume_Manually_K_M__c

format=double · minimum=0 · maximum=100

Opp.Card_Network_Volume_MO_TO_CNP__c

format=double · minimum=0 · maximum=100

Opp.Card_Network_Volume_Swiped_CP__c

format=double · minimum=0 · maximum=100

Opp.ACH_Debit_Avg_Dollar_Per_Tx__c

format=double

Opp.ACH_Credit_Avg_Dollar_Per_Tx__c

format=double

Opp.ACH_Debit_Max_Dollar_Per_Tx__c

format=double

Opp.ACH_Credit_Max_Dollar_Per_Tx__c

format=double

Opp.ACH_Debit_Max_Dollar_Per_Day__c

format=double

Opp.ACH_Credit_Max_Dollar_Per_Day__c

format=double

Opp.ACH_Debit_Max_Tx_Per_Day__c

format=double

Opp.ACH_Credit_Max_Tx_Per_Day__c

format=double

Opp.ACH_Debit_Max_Dollar_Per_Month__c

format=double

Opp.ACH_Credit_Max_Dollar_Per_Month__c

format=double

Opp.ACH_Debit_Max_Tx_Per_Month__c

format=double

Opp.ACH_Credit_Max_Tx_Per_Month__c

format=double

Opp.Merchant_Application_Notes__c

maxLength=255

Mer.Name

maxLength=255

Mer.Legal_Name__c

maxLength=100

Mer.Tax_ID__c

pattern=^\d{9}$ · maxLength=16

Mer.State_of_Entity_Formation_Incorporation__c

maxLength=2

Mer.Association_ID_API_Field__c

maxLength=100

Mer.MCC_API_Field__c

maxLength=100

Mer.BillingStreet

maxLength=255

Mer.BillingCity

maxLength=40

Mer.BillingStateCode

maxLength=80

Mer.BillingPostalCode

pattern=^\d{5}$ · maxLength=20

Mer.BillingCountryCode

maxLength=80

Mer.ShippingStreet

maxLength=255

Mer.ShippingCity

maxLength=40

Mer.ShippingStateCode

maxLength=80

Mer.ShippingPostalCode

pattern=^\d{5}$ · maxLength=20

Mer.ShippingCountryCode

maxLength=80

Mer.Physical_Address_Street__c

maxLength=255

Mer.Physical_Address_City__c

maxLength=80

Mer.Physical_Address_State__c

maxLength=80

Mer.Physical_Address_PostalCode__c

pattern=^\d{5}$ · maxLength=80

Mer.Phone

pattern=^(\d{10}|$\d{3}$\s\d{3}-\d{4})$

Mer.Fax

pattern=^(\d{10}|$\d{3}$\s\d{3}-\d{4})$

Mer.App_Email__c

format=email · maxLength=100

Mer.Website

format=uri · maxLength=255

Mer.Customer_Service_Phone__c

pattern=^(\d{10}|$\d{3}$\s\d{3}-\d{4})$

Mer.Industry_Other__c

maxLength=100

Mer.Location_Other__c

maxLength=100

Mer.Date_Established__c

format=date

Mer.Description

maxLength=32000

Mer.Name_of_Previous_Processor__c

maxLength=100

Mer.Name_of_Processor_for_canceled_merchant__c

maxLength=100

Mer.Reason_for_cancellation__c

maxLength=255

Mer.Date_of_cancellation__c

format=date

Responses

200

Application created successfully

Example response

- Success: true
  SourceId: null
  SFId: 0011800000YkI5NAAV
  ObjectType: Account
  Message: Merchant Information Created Successfully.
- Success: true
  SourceId: "111"
  SFId: 0031800000SwFDOAA3
  ObjectType: Contact
  Message: Beneficial Owner Created Successfully.
- Success: true
  SourceId: "222"
  SFId: 0031800000SwFDPAA3
  ObjectType: Contact
  Message: Beneficial Owner Created Successfully.
- Success: true
  SourceId: "111"
  SFId: a3h18000000blAWAAY
  ObjectType: Business Checking Account
  Message: Business Checking Account Created Successfully.
- Success: true
  SourceId: "222"
  SFId: a3h18000000blAXAAY
  ObjectType: Business Checking Account
  Message: Business Checking Account Created Successfully.
- Success: true
  SourceId: null
  SFId: 00618000006PCkHAAW
  ObjectType: Opportunity
  Message: Transaction/Payment Options Created Successfully.
- Success: true
  SourceId: null
  SFId: 0Q01800000020nxCAA
  ObjectType: Quote
  Message: Record Created Successfully.
- Success: true
  SourceId: null
  SFId: 0QL1800000028mnGAA
  ObjectType: QuoteLineItem
  Message: Solution & Fees Created Successfully.
- Success: true
  SourceId: "111"
  SFId: 0QL1800000028moGAA
  ObjectType: QuoteLineItem
  Message: Equipment Created Successfully.
- Success: true
  SourceId: "222"
  SFId: 0QL1800000028mpGAA
  ObjectType: QuoteLineItem
  Message: Equipment Created Successfully.

400

Validation error

Common1 field

errorsarray<object>

Example response

{}

Business Rules

At least one Primary Contact/Beneficial Owner must be identified
Only one Control Owner is allowed per application
Only one Authorized Signer is allowed per application
Maximum 4 Beneficial Owners are allowed per application
Only 1 Beneficial Owner is allowed for Sole Proprietorship
Sum of % Ownership for all Beneficial Owners must not exceed 100%

Code samples

Copy-paste ready code in your preferred language.

API call

Copy/paste friendly

curl -X POST "https://test.salesforce.com/applications" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{
  "Opp": {
    "attributes": {
      "type": "Opportunity"
    },
    "BET_Table_ID_API_Field__c": "",
    "Yearly_Net_Revenue__c": 0
  },
  "Mer": {
    "attributes": {
      "type": "Account"
    },
    "Name": "",
    "Legal_Name__c": ""
  }
}'