--- title: "Create online application" method: POST path: "/onlineapplication/v2/app" tags: ["Card Processing Online Application"] --- # Create online application `POST /onlineapplication/v2/app` Creates a prefilled form for the online application. The 'pricing' object is optional. However, if included in the request, include all required and any applicable conditionally required parameters. > ๐Ÿ“˜ Notes > > - You cannot use this endpoint in the Nexio sandbox environment. > - For authentication with this endpoint, use your CForce credentials. > โš ๏ธ Try It > > Due to technical limitations, it is not possible to use the **Try It** feature with this endpoint. Instead, use something like Postman or your own server to make the request with the [base URL for the Nexio production environment](https://docs.nexiopay.com/docs/base-urls-and-environments).
## Request parameters - partner - partner.applicationType - partner.repCode - partner.checkCredit - partner.hasPersonalGuarantor - partner.repName - partner.contact - partner.agentEmail - partner.partnerRef - partner.redirectUrl - partner.sendEmail - partner.sendEmailMessage - owners - owners.owner1 - owners.owner2 - owners.owner3 - owners.owner4 - owners.owner[n].email - owners.owner[n].firstName - owners.owner[n].middleInitial - owners.owner[n].lastName - owners.owner[n].title - owners.owner[n].phone - owners.owner[n].address - owners.owner[n].city - owners.owner[n].state - owners.owner[n].postal - owners.owner[n].country - owners.owner[n].birthday - owners.owner[n].socialSecurityNumber - owners.owner[n].ownershipPercentage - owners.owner[n].identificationType - owners.owner[n].identificationState - owners.owner[n].identificationNumber - business - business.taxPayerId - business.dbaName - business.legalName - business.legalSameAsDBA - business.businessStartDate - business.businessType - business.marketType - business.productDescription - business.website - business.businessPhone - business.corporatePhone - business.customerServicePhone - business.fax - business.contactFirstName - business.contactLastName - business.contactEmail - business.businessAddress - business.businessCity - business.businessState - business.businessPostal - business.businessCountry - business.legalAddress - business.legalCity - business.legalState - business.legalPostal - business.legalCountry - merchantProfile - merchantProfile.isDirectSalesMLM - merchantProfile.acceptCard - merchantProfile.acceptPrePayment - merchantProfile.warranty - merchantProfile.averageTicketAmount - merchantProfile.highTicket - merchantProfile.monthlySalesVolume - merchantProfile.amex - merchantProfile.amexSe - merchantProfile.cardPresentSwiped - merchantProfile.cardPresentKeyed - merchantProfile.cardNotPresentMOTO - merchantProfile.cardNotPresentECommerce - bank - bank.routingNumber - bank.accountNumber - compliance - compliance.adc - compliance.adcDate - compliance.pcidss - compliance.pcidssDate - compliance.fcn - compliance.otherServiceProvider - compliance.otherServiceProviderName - pricing - pricing.pricingNotes - pricing.accountSetupFee - pricing.annualMembershipFee - pricing.annualPciComplianceFee - pricing.accountServiceFee - pricing.chargebackFee - pricing.edcAVSFee - pricing.helpDeskFee - pricing.insufficientFundsFee - pricing.monthlyBreachInsuranceFee - pricing.monthlyDebitAccessFee - pricing.monthlyMinimumFee - pricing.monthlyRegulatoryFee - pricing.onlineReportingAccessFee - pricing.retrievalFee - pricing.commercialNonQualifiedRate - pricing.pinDebitPerItem - pricing.pinDebitRate - pricing.amexPricingType - pricing.amexERRQualified - pricing.amexERRNonQualified - pricing.amexInterchange - pricing.amexTieredQualified - pricing.amexTieredMidQualified - pricing.amexTieredNonQualified - pricing.visaAuth - pricing.visaBatch - pricing.visaPricingType - pricing.visaERRQualified - pricing.visaERRNonQualified - pricing.visaInterchange - pricing.visaTieredQualified - pricing.visaTieredMidQualified - pricing.visaTieredNonQualified - directSalesMLM - directSalesMLM.generalProductsServices - directSalesMLM.generalAdvertise - directSalesMLM.financialBankruptcy - directSalesMLM.financialCommissionsRecruiting - directSalesMLM.financialCommissionsSales - directSalesMLM.financialGrossRevenue - directSalesMLM.financialRecruitingGrossRevenuePercentage - directSalesMLM.financialStartup - directSalesMLM.operationalAdvanceCharges - directSalesMLM.operationalComplaints - directSalesMLM.operationalDistributorContract - directSalesMLM.operationalDistributorDoc - directSalesMLM.operationalDoesOfferTrial - directSalesMLM.operationalHasPeakSeason - directSalesMLM.operationalInventoryPurchase - directSalesMLM.operationalMailTelephoneOrders - directSalesMLM.operationalPeakSeason - directSalesMLM.operationalPhysicalLocations - directSalesMLM.operationalProductFulfillment - directSalesMLM.operationalRecurringBilling - directSalesMLM.operationalRecurringBillingInfo - directSalesMLM.operationalRefunds - directSalesMLM.operationalRestockingFees - directSalesMLM.operationalTraining - directSalesMLM.operationalTrialOffer - directSalesMLM.reputationalAttorney - directSalesMLM.reputationalContact - directSalesMLM.reputationalDSA - directSalesMLM.reputationalIndictment - directSalesMLM.reputationalSanctions - directSalesMLM.reputationalShipping - directSalesMLM.reputationalWorkingWithAttorney - merchantSiteSurveyReport - merchantSiteSurveyReport.merchantLocation - merchantSiteSurveyReport.merchantLocationOther - merchantProfileAnalysis - merchantProfileAnalysis.generalUsername - merchantProfileAnalysis.generalPassword - merchantProfileAnalysis.generalControlPerson - merchantProfileAnalysis.questionsContactNumber - merchantProfileAnalysis.generalAdvertise - merchantProfileAnalysis.generalBilledFrequency - merchantProfileAnalysis.generalCancellation - merchantProfileAnalysis.generalCardPayments - merchantProfileAnalysis.generalInAdvance - merchantProfileAnalysis.generalInventory - merchantProfileAnalysis.generalNutraceutical - merchantProfileAnalysis.generalProductsServices - merchantProfileAnalysis.generalRefund - merchantProfileAnalysis.generalTelemarketing - merchantProfileAnalysis.isCollectionServices - merchantProfileAnalysis.collectionDebtType - merchantProfileAnalysis.collectionIndustries - merchantProfileAnalysis.isConsulting - merchantProfileAnalysis.consultingDescribe - merchantProfileAnalysis.consultingFiling - merchantProfileAnalysis.isCreditRepairServices - merchantProfileAnalysis.creditRepairAttorneyStaff - merchantProfileAnalysis.creditRepairFees - merchantProfileAnalysis.creditRepairTelemarketing - merchantProfileAnalysis.isLendingServices - merchantProfileAnalysis.lendingDisclose - merchantProfileAnalysis.lendingOriginate - merchantProfileAnalysis.isTravel - merchantProfileAnalysis.travelARC - merchantProfileAnalysis.travelCompany - merchantProfileAnalysis.travelInsurance - merchantProfileAnalysis.travelLicensedStates - merchantProfileAnalysis.travelThirdParty ## Response parameters - merchantLink - token
## Request body - object - `partner` object, required โ€” Contains the set of partner parameters. - `repCode` RepCode, required โ€” unresolved $ref - `applicationType` 'direct-sales' | 'isv' | '1099' โ€” The type of application. - `checkCredit` boolean โ€” Specifies whether a credit check needs to be done for the application. - `hasPersonalGuarantor` boolean โ€” Specifies whether this business has a personal guarantor. - `sendEmail` string โ€” Specifies the email address where the system will send the `merchantLink`, `token`, and `sendemailMessage`. If you specify a value for this parameter, you must also include the `partner.sendEmailMessage` parameter. - `sendEmailMessage` string โ€” **Conditionally required.** Specifies a message to include with an email that includes the `merchantLink` and `token`. This parameter is required if you specify an email address for `partner.sendEmail`. - `pricing` object โ€” Contains the set of pricing parameters. This object is optional. However, if included in the request, include all required and any applicable conditionally required parameters. - `pricingNotes` string, required โ€” Nexio will provide the value for this field. Contact your Account Manager or Sales Rep for information about the pricing model. - `accountSetupFee` number, required โ€” Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. - `accountServiceFee` number, required โ€” Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. - `annualMembershipFee` number, required โ€” Nexio will provide the value for this field. This is the annual membership fee. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. - `annualPciComplianceFee` number, required โ€” Nexio will provide the value for this field. This is the annual PCI compliance fee. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. - `chargebackFee` number, required โ€” Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. - `edcAVSFee` number, required โ€” Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. - `helpDeskFee` number, required โ€” Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. - `insufficientFundsFee` number, required โ€” Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. - `monthlyBreachInsuranceFee` number, required โ€” Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. - `monthlyDebitAccessFee` number, required โ€” Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. - `monthlyMinimumFee` number, required โ€” Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. - `monthlyRegulatoryFee` number, required โ€” Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. - `onlineReportingAccessFee` number, required โ€” Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. - `retrievalFee` number, required โ€” Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. - `visaAuth` number, required โ€” Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. - `visaBatch` number, required โ€” Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. - `pinDebitPerItem` number, required โ€” Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. - `pinDebitRate` number, required โ€” Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. - `amexPricingType` 'err' | 'interchange' | 'tiered' | 'none', required โ€” Nexio will provide the value for this field. Other parameters may be required, depending on the value you choose. Contact your Account Manager or Sales Rep for information about the pricing model. - `visaPricingType` 'err' | 'interchange' | 'tiered', required โ€” Nexio will provide the value for this field. Other parameters may be required, depending on the value you choose. Contact your Account Manager or Sales Rep for information about the pricing model. - `amexERRQualified` number โ€” **Conditionally required.** Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. When the value for `amexPricingType` is `err`, include a value for this field. - `amexERRNonQualified` number โ€” **Conditionally required.** Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. When the value for `amexPricingType` is `err`, include a value for this field. - `amexInterchange` number โ€” **Conditionally required.** Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. When the value for `amexPricingType` is `interchange`, include a value for this field. - `amexTieredQualified` number โ€” **Conditionally required.** Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. When the value for `amexPricingType` is `tiered`, include a value for this field. - `amexTieredMidQualified` number โ€” **Conditionally required.** Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. When the value for `amexPricingType` is `tiered`, include a value for this field. - `amexTieredNonQualified` number โ€” **Conditionally required.** Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. When the value for `amexPricingType` is `tiered`, include a value for this field. - `visaERRQualified` number โ€” **Conditionally required.** Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. When the value for `visaPricingType` is `err`, include a value for this field. - `visaERRNonQualified` number โ€” **Conditionally required.** Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. When the value for `visaPricingType` is `err`, include a value for this field. - `visaInterchange` number โ€” **Conditionally required.** Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. When the value for `visaPricingType` is `interchange`, include a value for this field. - `visaTieredQualified` number โ€” **Conditionally required.** Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. When the value for `visaPricingType` is `tiered`, include a value for this field. - `visaTieredMidQualified` number โ€” **Conditionally required.** Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. When the value for `visaPricingType` is `tiered`, include a value for this field. - `visaTieredNonQualified` number โ€” **Conditionally required.** Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. When the value for `visaPricingType` is `tiered`, include a value for this field. - `commercialNonQualifiedRate` number โ€” **Conditionally required.** Nexio will provide the value for this field. The value must be positive and may have up to two decimal places. Contact your Account Manager or Sales Rep for information about the pricing model. When the value for `visaPricingType` is `tiered`, include a value for this field. - `owners` object โ€” Contains up to four sets of owner parameters: owner1, owner2, owner3, and owner4. All besides owner1 are optional. The goal is to include all owners with `ownershipPercentage` of 25 or greater. There are some scenarios where no owner has more than 25% ownership. In that case, please include the owner with the highest percentage or a representative that is able to sign on behalf of the company. In addition, the values in all filled `ownershipPercentage` fields must not total to more than 100, although they can total to less than 100. > #### Warning > If the controller is the same as an owner, that individual must be listed first. - `owner1` object, required - `email` string โ€” The owner's email address. - `firstName` string โ€” The owner's first name. - `lastName` string โ€” The owner's last name. - `middleInitial` string โ€” The owner's middle initial. - `title` 'ceo' | 'cfo' | 'chairman' | 'co-owner' | 'comptroller' | 'controller' | 'director' | 'general-manager' | 'office-manager' | 'owner' | 'partner' | 'president' | 'treasurer' | 'vice-president' โ€” The owner's title. - `phone` string โ€” The owner's phone number. Must be 10 characters long and include only digits. - `address` string โ€” The owner's street address. - `city` string โ€” The owner's city. - `state` string โ€” The owner's state. The value must be a [two-character state abbreviation](https://pe.usps.com/text/pub28/28apb.htm) or a three-letter abbreviation. - `postal` string โ€” The owner's postal code. - `country` string โ€” The [two-character (Alpha-2) ISO country code](https://www.iso.org/obp/ui/#search/code/) for the owner's address. - `birthday` string โ€” The owner's date of birth. Format MM-DD-YYYY. - `socialSecurityNumber` string โ€” The owner's social security number. Must be exactly 9 characters long and include only digits. - `ownershipPercentage` string โ€” The owner's percentage of ownership. You can specify a value between 0 and 100, with up to 2 decimal places. - `identificationType` 'drivers-license' | 'state-id' | 'passport' โ€” The owner's type of identification. When the value is either `drivers-license` or `state-id`, you should include a value for the `identificationState` parameter. - `identificationState` string โ€” The state for the owner's `identificationType`. The value must be a [two-character state abbreviation](https://pe.usps.com/text/pub28/28apb.htm) or a three-character abbreviation. This parameter is applicable when `identificationType` is either `drivers-license` or `state-id`. - `identificationNumber` string โ€” The number on the owner's identification. This ID number applies to the value of the `identificationType` parameter. - `owner2` object - `email` Email โ€” unresolved $ref - `firstName` FirstName โ€” unresolved $ref - `middleInitial` MiddleInitial โ€” unresolved $ref - `lastName` LastName โ€” unresolved $ref - `title` Title โ€” unresolved $ref - `phone` Phone โ€” unresolved $ref - `address` Address โ€” unresolved $ref - `city` City โ€” unresolved $ref - `state` State โ€” unresolved $ref - `postal` Postal โ€” unresolved $ref - `country` Country โ€” unresolved $ref - `birthday` Birthday โ€” unresolved $ref - `socialSecurityNumber` SocialSecurityNumber โ€” unresolved $ref - `ownershipPercentage` OwnershipPercentage โ€” unresolved $ref - `identificationType` IdentificationType โ€” unresolved $ref - `identificationState` IdentificationState โ€” unresolved $ref - `identificationNumber` IdentificationNumber โ€” unresolved $ref - `owner3` Owner2 โ€” unresolved $ref - `owner4` Owner2 โ€” unresolved $ref - `business` object โ€” Contains the set of business parameters. - `taxPayerId` string โ€” The business's federal tax ID. Must be exactly 9 characters long and include only digits. - `dbaName` string โ€” The DBA name. - `legalSameAsDBA` boolean โ€” Specifies whether the business's legal name and address information is the same as the DBA information. Displays as a checkbox. When the value for this field is `false`, also include values for the following: - `legalName` - `legalAddress` - `legalCity` - `legalState` - `legalPostal` - `legalCountry` - `legalName` string โ€” The business's legal name. When the value for `legalSameAsDBA` is `false`, include a value for this field. - `businessStartDate` string โ€” The date the business was started. Format YYYY-MM-DD. - `businessType` 'sole-proprietor' | 'partnership' | 'llc' | 'professional-assoc' | 'corporation' | 'tax-exempt-501c' โ€” The business type. - `marketType` string โ€” The market type or types. When including two or more types, separate each with a comma. Possible values: - retail - restaurant - lodging - moto - p-card - public-sector - auto-rental - other - emerging-mkt - e-commerce - `productDescription` string โ€” The description of the business's products and services. - `website` string โ€” The business's website. - `businessPhone` string โ€” The business's phone number. Must be 10 characters long and include only digits. - `corporatePhone` string โ€” The business's corporate phone number. Must be 10 characters long and include only digits. - `customerServicePhone` string โ€” The business's customer service phone number. Must be 10 characters long and include only digits. - `fax` string โ€” The business's fax number. Must be 10 characters long and include only digits. - `contactFirstName` string โ€” The business contact's first name. - `contactLastName` string โ€” The business contact's last name. - `contactEmail` string โ€” The business contact's email. - `businessAddress` string โ€” The business's physical address. No P.O. box. - `businessCity` string โ€” The business's city. - `businessState` string โ€” The business's state. The value must be a [two-character state abbreviation](https://pe.usps.com/text/pub28/28apb.htm) or three-character abbreviation. - `businessPostal` string โ€” The business's postal code. - `businessCountry` string โ€” The [two-character (Alpha-2) ISO country code](https://www.iso.org/obp/ui/#search/code/) for the business's address. - `legalAddress` string โ€” The business's legal address. When the value for `legalSameAsDBA` is `false`, include a value for this field. - `legalCity` string โ€” The business's legal city. When the value for `legalSameAsDBA` is `false`, include a value for this field. - `legalState` string โ€” The business's legal state. The value must be a [two-character state abbreviation](https://pe.usps.com/text/pub28/28apb.htm) or three-character abbreviation. When the value for `legalSameAsDBA` is `false`, include a value for this field. - `legalPostal` string โ€” The business's legal postal code. When the value for `legalSameAsDBA` is `false`, include a value for this field. - `legalCountry` string โ€” The [two-character (Alpha-2) ISO country code](https://www.iso.org/obp/ui/#search/code/) for the business's legal address. When the value for `legalSameAsDBA` is `false`, include a value for this field. - `merchantProfile` object โ€” Contains the set of merchant profile parameters. - `isDirectSalesMLM` boolean โ€” Specifies whether the direct sales organization is a multi-level marketing company. - `acceptCard` boolean โ€” Specifies whether the merchant accepts cards. Displays as radio buttons. - `acceptPrePayment` boolean โ€” Specifies whether the merchant accepts prepayment. Displays as radio buttons. When the value for this field is `true`, include values for `percentageSales` and `percentageCosts`. - `warranty` boolean โ€” Specifies whether the merchant offers warranties, dues, subscriptions, memberships, or extended services. Displays as radio buttons. When the value for this field is `true`, include a value for `warrantyDuration`. - `averageTicketAmount` number โ€” The business's average ticket amount. The value must be positive and may have up to two decimal places. - `highTicket` number โ€” The business's highest ticket amount. The value must be positive and may have up to two decimal places. - `monthlySalesVolume` number โ€” The business's monthly sales volume. The value must be positive and may have up to two decimal places. - `amex` string โ€” Indicates the setting for AMEX. May be either `existing` or `none`. If `amex` is `none`, you should not include the `amexSe` parameter. - `amexSe` string โ€” Indicates AMEX SE (service establishment) numbers that are assigned by American Express. If the `amex` parameter is `none`, you should not include a value for this parameter. - `cardPresentSwiped` number โ€” Specifies what percentage of Visa/Mastercard/Discover/AMEX transactions are card present swiped. The value must be positive and may have up to two decimal places. The total of the values for `cardPresentSwiped`, `cardPresentKeyed` `cardNotPresentMOTO`, and `cardNotPresentECommerce` must equal 100%. - `cardPresentKeyed` number โ€” Specifies what percentage of Visa/Mastercard/Discover/AMEX transactions are card present keyed. The value must be positive and may have up to two decimal places. The total of the values for `cardPresentSwiped`, `cardPresentKeyed` `cardNotPresentMOTO`, and `cardNotPresentECommerce` must equal 100%. - `cardNotPresentMOTO` number โ€” Specifies what percentage of Visa/Mastercard/Discover/AMEX transactions are card not present MOTO (Mail Order Telephone Order). The value must be positive and may have up to two decimal places. The total of the values for `cardPresentSwiped`, `cardPresentKeyed` `cardNotPresentMOTO`, and `cardNotPresentECommerce` must equal 100%. - `cardNotPresentECommerce` number โ€” Specifies what percentage of Visa/Mastercard/Discover/AMEX transactions are card not present ecommerce. The value must be positive and may have up to two decimal places. The total of the values for `cardPresentSwiped`, `cardPresentKeyed` `cardNotPresentMOTO`, and `cardNotPresentECommerce` must equal 100%. - `bank` object โ€” Contains the set of bank parameters. - `routingNumber` string โ€” The checking account's routing number. The value must contain only digits and contain nine characters. - `accountNumber` string โ€” The business checking account number. The value must contain only digits and contain from 3-17 characters. - `compliance` object โ€” Contains the set of compliance parameters. - `adc` boolean โ€” Specifies whether the business has ever experienced an Account Data Compromise (ADC). Displays as radio buttons. When the value for this field is `true`, include a value for `adcDate`. - `adcDate` string, date โ€” The date when the business experienced an Account Data Compromise (ADC). Format YYYY-MM-DD. When the value for `adc` is `true`, include a value for this field. - `pcidss` boolean โ€” Specifies whether the business has validated Payment Card Industry Data Security Standard (PCI DSS) compliance. Displays as radio buttons. When the value for this field is `true`, include a value for `pcidssDate`. - `pcidssDate` string, date โ€” The date when the business validated Payment Card Industry Data Security Standard (PCI DSS). Format YYYY-MM-DD. When the value for `pcidss` is `true`, include a value for this field. - `fcn` boolean โ€” Specifies whether the business or its service provider(s) receive, pass, transmit, or store the Full Cardholder Name (FCN) electronically. Displays as radio buttons. - `otherServiceProvider` boolean โ€” Specifies whether the business's transactions process through any other Service Provider. For example, web hosting companies, gateways, corporate offices. When the value for this field is `true`, include a value for `otherServiceProviderName`. - `otherServiceProviderName` string โ€” The name of the other service provider. When the value for `otherServiceProvider` is `true`, include a value for this field. - `directSalesMLM` object โ€” Contains the set of direct sales MLM parameters. - `generalProductsServices` GeneralProductsServices โ€” unresolved $ref - `generalAdvertise` string โ€” Specifes how and where the merchant advertises its products/services. - `financialBankruptcy` boolean โ€” Specifies whether the company has ever filed for bankruptcy. Displays as radio buttons. - `financialCommissionsRecruiting` boolean โ€” Specifies whether the direct sales business pays commission on recruiting. Displays as radio buttons. - `financialCommissionsSales` boolean โ€” Specifies whether the direct sales business pays commission on sales. Displays as radio buttons. - `financialGrossRevenue` string โ€” Specifies what percentage of the company's gross revenue is generated from product/service sales to consumer. - `financialRecruitingGrossRevenuePercentage` string โ€” Specifies what percentage of the company's gross revenue is generated from recruiting/signing up. - `financialStartup` boolean โ€” Specifies whether the business is a startup and, if so, if it is being financed. Displays as radio buttons. - `operationalAdvanceCharges` string โ€” Specifies how far in advance of fulfillment charges are made. - `operationalComplaints` boolean โ€” Specifies whether the comnpany monitors consumer complaint boards and Better Business Bureau and Consumer Financial Protection Bureau reviews, and responds to complaints. Displays as radio buttons. - `operationalDistributorContract` string โ€” Specifies the length of the distributor contract. - `operationalDistributorDoc` string โ€” Specifies how you provide the following to distributors: - Compensation structure/plan - Distributor agreement - Policies & procedures - `operationalDoesOfferTrial` boolean โ€” Specifies whether the company hoffers a trial attached to the product/service. Displays as radio buttons. If this is `true`, provide a value for `operationalTrialOffer`. - `operationalTrialOffer` string โ€” Describes the details of the trial offer attached to the product/service. If `directSalesMLM.operationalDoesOfferTrial` is `true`, provide information for this parameter. - `operationalHasPeakSeason` boolean โ€” Specifies whether the company has a peak payment season or period. Displays as radio buttons. If this is `true`, provide a value for `directSalesMLM.operationalPeakSeason`. - `operationalPeakSeason` string โ€” Describes the peak payment season or period. If `directSalesMLM.operationalHasPeakSeason` is `true`, provide information for this parameter. - `operationalInventoryPurchase` boolean โ€” Specifies whether distributors are required to make an initial or ongoing purchase of inventory. Displays as radio buttons. - `operationalMailTelephoneOrders` string โ€” Specifies who collects the card information and processes the transaction for mail/telephone orders. - `operationalPhysicalLocations` boolean โ€” Specifies whether there are physical locations for distributors to buy products. Displays as radio buttons. - `operationalProductFulfillment` 'company' | 'distributor' โ€” Specifies the entity that fulfills product orders. - `operationalRecurringBilling` boolean โ€” Specifies whether the company offers recurring billing on any products/services. If this is `true`, provide a value for `directSalesMLM.operationalRecurringBillingInfo`. - `operationalRecurringBillingInfo` string โ€” Describes how often the customer is charged on any products/services and if the recurring billing auto-renews at the year mark. If `directSalesMLM.operationalRecurringBilling` is `true`, provide information for this parameter. - `operationalRestockingFees` boolean โ€” Specifies whether the company charges a restocking fee. If this is `true`, provide a value for `directSalesMLM.operationalRefunds`. - `operationalRefunds` string โ€” Specifies who is responsible for issuing refunds and the amount of the restocking fee, if `directSalesMLM.operationalRestockingFees` is `true`. - `operationalTraining` boolean โ€” Specifies whether training is offered before a distributor can sell the products/services. Displays as radio buttons. - `reputationalWorkingWithAttorney` boolean โ€” Specifies whether the business is currently working or has ever worked with an attorney regarding its business model. If this is `true`, provide a value for `directSalesMLM.reputationalAttorney`. - `reputationalAttorney` string โ€” Specifies whether the business is currently working or has ever worked with an attorney regarding its business model, and if so, the attorney's name. If `directSalesMLM.reputationalWorkingWithAttorney` is `true`, provide information for this parameter. - `reputationalContact` string โ€” Specifies contact information for fulfillment house: name, address, contact person, phone number, and email address. - `reputationalDSA` boolean โ€” Specifies whether you have a membership with the Direct Sellers Association (DSA). Displays as radio buttons. - `reputationalIndictment` boolean โ€” Specifies whether the business has had an indictment. Displays as radio buttons. If this is `true`, provide a value for `directSalesMLM.reputationalSanctions`. - `reputationalSanctions` string โ€” Describes sactions fomr any criminal or regulatory indictments. If `directSalesMLM.reputationalIndictment` is `true`, provide information for this parameter. - `reputationalShipping` string โ€” Specifies how goods are shipped or services fulfilled (UPS, FedEx, third party, etc.). - `merchantSiteSurveyReport` object โ€” Contains the set of merchant site survey reports. - `merchantLocation` 'retail-location-with-store-front' | 'office-building' | 'residence' | 'warehouse' | 'other' โ€” Specifies the retail location for the business. If the value is `other`, provide a value for `merchantSiteSurveyReport.merchantLocationOther`. - `merchantLocationOther` string โ€” Describes the merchant location if the value for `merchantSiteSurveyReport.merchantLocation` is `other`. - `merchantProfileAnalysis` object โ€” Contains the set of merchant profile analysis parameters. - `questionsContactNumber` string โ€” The phone number for Nexio to call with questions about the application. - `generalUsername` string โ€” The username for website test credentials. - `generalPassword` string โ€” The password for website test credentials. - `generalAdvertise` GeneralAdvertise โ€” unresolved $ref - `generalBilledFrequency` string โ€” Specifies how often the merchant bills customers. For example, a one-time fee or monthly. Also specifies whether the merchant offers auto-ship enrollment. - `generalCancellation` string โ€” Specifies in detail the merchant's cancellation policy and how it advises customers of this policy. Alternatively, include a copy of the policy. - `generalCardPayments` string โ€” Specifies what system the merchant uses to enter card payments for processing. For example, shopping cart, gateway, point-of-sale software. - `generalControlPerson` string โ€” Specifies the name of any individual who owns, directly or indirectly, 25% or more of the equity interests of the legal entity. - `generalInAdvance` string โ€” Specifies how far in advance charges, bookings, and reservations are made before fulfillment/shipping. - `generalInventory` string โ€” Describes where inventory is and how the merchant fills orders. Please provide the name, address, contact person, phone number, and email address for any fulfillment company or drop shipper. - `generalNutraceutical` string โ€” If the merchant is selling nutraceutical products/ingestible supplements, specifies the manufacturer's name, address, and phone number. - `generalProductsServices` string โ€” Specifies the products/services the merchant offers to consumers, including price points. - `generalRefund` string โ€” Describes in detail the merchant's refund policy and how long customers are eligible to receive a refund or includes a copy of the policy. - `generalTelemarketing` string โ€” Specifies whether the merchant uses telemarketing (outbound or inbound - please specify). If not, describe how consumers enroll in the merchant's service(s) or purchase the product(s). Specifies all call scripts used with consumers, if applicable. - `isCollectionServices` boolean โ€” Specifies whether the merchant offers collection services. Displays as radio buttons. When the value in this field is `true`, include values for `merchantProfileAnalysis.collectionDebtType` and `merchantProfileAnalysis.collectionIndustries`. - `collectionDebtType` string โ€” Specifies the type of debt that the merchant collects (first party, third party, etc.). When the value for `merchantProfileAnalysis.isCollectionServices` is `true`, include a value for this field. - `collectionIndustries` string โ€” Lists from what industries the merchant collects (credit card, medical, etc.). When the value for `merchantProfileAnalysis.isCollectionServices` is `true`, include a value for this field. - `isConsulting` boolean โ€” Specifies whether the merchant offers services for document preparation services or financial consulting. When the value for this field is `true`, include values for `merchantProfileAnalysis.consultingFiling` and `merchantProfileAnalysis.consultingDescribe`. - `consultingDescribe` string โ€” Describes any debt relief, repayment, restructure, modification, or counseling programs the merchant offers and specifies whether the merchant assists the consumer in applying on their behalf. When the value for `merchantProfileAnalysis.isConsulting` is `true`, include a value for this field. - `consultingFiling` string โ€” Specifies whether the merchant is filing paperwork on the consumer's behalf to consolidate debt. When the value for `merchantProfileAnalysis.isConsulting` is `true`, include a value for this field. - `isCreditRepairServices` boolean โ€” Specifies whether the merchant offers credit repair services. When the value in this field is `true`, include values for the following: - `merchantProfileAnalysis.creditRepairFees` - `merchantProfileAnalysis.creditRepairTelemarketing` - `merchantProfileAnalysis.creditRepairAttorneyStaff` - `creditRepairAttorneyStaff` string โ€” Specifies whether the merchant has an attorney on staff. When the value for `merchantProfileAnalysis.isCreditRepairServices` is `true`, include a value for this field. - `creditRepairFees` string โ€” Describes all fees charged to customers. Include the purpose of each fee, when the fee is assessed, and what fee is permissible under the Credit Repair Organizations Act (CROA). When the value for `merchantProfileAnalysis.isCreditRepairServices` is `true`, include a value for this field. - `creditRepairTelemarketing` string โ€” Specifies whether the merchant uses telemarketing, (outbound or inbound). Describes the merchant's telemarketing practics and affirms that the merchant complies with the Telemarketing Sales Rule (TSR). When the value for `merchantProfileAnalysis.isCreditRepairServices` is `true`, include a value for this field. - `isLendingServices` boolean โ€” Specifies whether the merchant offers lending services. Displays as radio buttons. When the value for this field is `true`, include values for `merchantProfileAnalysis.lendingDisclose` and `merchantProfileAnalysis.lendingOriginate`. - `lendingDisclose` string โ€” Specifies how the merchant discloses interest rates (displayed in-store, etc.). When the value for `merchantProfileAnalysis.isLendingServices` is `true`, include a value for this field. - `lendingOriginate` string โ€” Specifies where the loan originated: online or in-person. When the value for `merchantProfileAnalysis.isLendingServices` is `true`, include a value for this field. - `isTravel` boolean โ€” Specifies whether the business is related to travel, including timeshare related businesses. When the value for this field is `true`, include values for the following: - `merchantProfileAnalysis.travelARC` - `merchantProfileAnalysis.travelInsurance` - `merchantProfileAnalysis.travelThirdParty` - `merchantProfileAnalysis.travelLicensedStates` - `merchantProfileAnalysis.travelCompany` - `travelARC` string โ€” Specifies the ARC/ASTA/IATAN/CLIA/USTOA numbers, if applicable. When the value for `merchantProfileAnalysis.isTravel` is `true`, include a value for this field. - `travelCompany` string โ€” The name of the company that fulfills travel services. When the value for `merchantProfileAnalysis.isTravel` is `true`, include a value for this field. - `travelInsurance` string โ€” Specifies whether the merchant offers travel insurance. If so, includes the name of the insurance provider. When the value for `merchantProfileAnalysis.isTravel` is `true`, you must include a value for this field. - `travelLicensedStates` string โ€” Lists the states in which the merchant is licensed to sell travel services. When the value for `merchantProfileAnalysis.isTravel` is `true`, you must include a value for this field. - `travelThirdParty` string โ€” Specifies whether the merchant uses any additional third-party vendors that result in additional fees (resort fees, attorneys, and so forth). When the value for `merchantProfileAnalysis.isTravel` is `true`, you must include a value for this field. ## Response `200` Success - object - `merchantLink` string โ€” The URL where you can find the online application for this merchant. - `token` string โ€” Indicates the token ID associated with the application. IF you neglect to save this value from the response, you can get it from the Dashboard under **Settings > Webhook Log**, or by contacting [Integrations Support](https://docs.nexiopay.com/page/contact-us). ## Other responses - `401` โ€” Unauthorized. For help with this error and other error codes, see [Common errors](https://docs.nexiopay.com/docs/common-errors) in the Guides area. --- [API](https://skmtc.dev/nexiopay/apis/payments-api-reference.md) ยท [All operations](https://skmtc.dev/nexiopay/apis/payments-api-reference/llms.txt) ยท [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nexiopay/payments-api-reference/revisions/b414b73979e5/schema)