Create merchant platform

Browse API reference

POST/merchant-platformscreateMerchant

Use this method to board a merchant with Payroc.

Note: This method is part of our Boarding solution. To help you understand how this method works with other Boarding methods, go to Board a Merchant.

In the request, include the following information:

Legal information, including its legal name and address.
Contact information, including the email address for the business.
Processing account information, including the pricing model, owners, and contacts for the processing account.

When you send a successful request, we review the merchant's information. After we complete our review and approve the merchant, we assign:

merchantPlatformId - Unique identifier for the merchant platform.
processingAccountId - Unique identifier for each processing account linked to the merchant platform.

You need to keep these to perform follow-on actions, for example, you need the processingAccountId to order terminals for the processing account.

Parameters

Name	In	Type	Description
`Idempotency-Key`Required	header	`string`	Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

Request body

application/json

Field Edit request inputs →

businessobjectrequired
Object that contains information about the business.
- addressesobject[]required
  Array of polymorphic objects that contain address information for the business.≥ 1 items
  - legalAddressobject
    Type of address.
    typestringrequired
    Type of address.legalAddress
    address1stringrequired
    Address line 1.≤ 150 chars
    address2string
    Address line 2.≤ 150 chars
    address3string
    Address line 3.≤ 150 chars
    citystringrequired
    City.≤ 50 chars
    countrystringrequired
    Two-digit country code for the country that the business operates in. The format follows the ISO-3166-1 standard.2–2 chars
    postalCodestringrequired
    Zip code or postal code.≤ 10 chars
    statestringrequired
    Name of the state or state abbreviation.≤ 50 chars
- contactMethodsobject[]required
  Array of polymorphic objects, which contain contact information. Note: You must provide an email address. The value of the type parameter determines which variant you should use: email Email address phone Phone number mobile Mobile number fax Fax number≥ 1 items
  - emailobject
    typestringrequired
    Type of contact method.email
    valuestringrequired
    Email address.≤ 50 chars
  - phoneobject
    typestringrequired
    Type of contact method.phone
    valuestringrequired
    Phone number.≤ 15 chars
  - mobileobject
    typestringrequired
    Type of contact method.mobile
    valuestringrequired
    Mobile number.≤ 15 chars
  - faxobject
    typestringrequired
    Type of contact method.fax
    valuestringrequired
    Fax number.≤ 15 chars
- countryOfOperationstring
  Two-digit code for the country that the business operates in. The format follows the ISO-3166 standard.US
- namestringrequired
  Legal name of the business.≤ 100 chars
- organizationTypestringrequired
  Type of organization.privateCorporationpublicCorporationnonProfitprivateLlcpublicLlcprivatePartnershippublicPartnershipsoleProprietor
- taxIdstringrequired
  Tax ID of the business.≤ 20 chars
metadataobject
Object that you can send to include custom data in the request.
processingAccountsobject[]required
Array of processingAccounts objects.≥ 1 items
- addendumsobject[]
  Array of polymorphic addendumEntry objects that indicate the additional forms that we should send with the Merchant Processing Agreement (MPA). The value of the type parameter determines which variant you should use: installmentPaymentsV1 Send this form if the merchant offers installment payments, loans, or leases. moneyServicesV1 Send this form if the merchant offers money services, for example, traveler's checks. telehealthV1 Send this form if the merchant provides telehealth services. firearmsV1 Send this form if the merchant sells firearms. pharmacyCnpComplianceV1 Send this form if the merchant is a pharmacy that accepts card-not-present (CNP) transactions. cbdV1 Send this form if the merchant sells any of the following products: CBD products Synthetic THC or Cannabis HHC Kratom Tianeptine Delta 8/9/10/0 THC products tobaccoCnpV1 Send this form if the merchant sells tobacco products and accepts CNP transactions. donationsV1 Send this form if the merchant accepts donations. cloverMerchantProcessingAmendmentV1 Send this form if the merchant requires Clover equipment. rocGivingV1 Send this form if the merchant uses Roc Giving.
  - option 1object
    Installment Payments, Loans, or Lease Questionnaire/Attestation for merchants that offer installment payments, loans, or leases.
    typestringrequired
  - option 2object
    Money Services Business Questionnaire for merchants that offer money services, for example, traveler's checks.
    typestringrequired
  - option 3object
    Telehealth Attestation for merchants that provide telehealth services.
    typestringrequired
  - option 4object
    Firearms Due Diligence for merchants that sell firearms.
    typestringrequired
  - option 5object
    Attestation of Compliance and Questionnaire for pharmaceutical merchants that accept CNP transactions.
    typestringrequired
  - option 6object
    CBD Attestation for merchants that sell any of the following products: CBD products Synthetic THC or Cannabis HHC Kratom Tianeptine Delta 8/9/10/0 THC products
    typestringrequired
  - option 7object
    CNP Tobacco Merchant Questionnaire for merchants that sell tobacco products and accept CNP transactions.
    typestringrequired
  - option 8object
    Donations Addendum for merchants that accept donations.
    typestringrequired
  - option 9object
    Clover Merchant Processing Amendment for merchants that order Clover equipment.
    lineItemsobjectrequired
    Object that contains information about the Clover equipment and accessories that the merchant wants to order.
    cloverBarCodeScannerobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverCashDrawerobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverCompactobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverCompactTetherCableobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverFlex4thGenobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverFlexPocketobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverHandsFreeScannerobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverKds14object
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverKds24object
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverKitchenPrinterobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverKitchenPrinterThermalobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverMiniLte3rdGenobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverSoloPosSystemobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverStationDuoGen2PosSystemobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverWeightScaleobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    typestringrequired
  - option 10object
    Roc Giving Addendum for merchants that use Roc Giving.
    accountAdminContactobjectrequired
    Object that contains contact details for the Roc Giving account administrator.
    emailAddressstringrequired
    Email address of the Roc Giving account administrator.≤ 50 chars
    firstNamestringrequired
    First name of the Roc Giving account administrator.≤ 50 chars
    lastNamestringrequired
    Last name of the Roc Giving account administrator.≤ 50 chars
    phonestring
    Phone number of the Roc Giving account administrator.≤ 15 chars
    autoCloseTimestringrequired
    Time that the processing terminal closes the batch in HH:mm format using the 24-hour clock.≤ 5 chars
    donorSupportPercentagenumberrequired
    Percentage of the total donation amount that a donor can add to their donation to provide additional support to the organization.0–100
    planstring
    Roc Giving pricing plan for the processing account. The value is one of the following: basic Merchant has access to the features available with the basic Roc Giving plan. advanced Merchant has access to the additional features available with the advanced Roc Giving plan.basicadvanced
    typestringrequired
- addressobjectrequired
  Polymorphic object that contains address information for the processing account.
  - addressobject
    Object that contains information about the address.
    address1stringrequired
    Address line 1.≤ 150 chars
    address2string
    Address line 2.≤ 150 chars
    address3string
    Address line 3.≤ 150 chars
    citystringrequired
    City.≤ 50 chars
    countrystringrequired
    Two-digit country code for the country that the business operates in. The format follows the ISO-3166-1 standard.2–2 chars
    postalCodestringrequired
    Zip code or postal code.≤ 10 chars
    statestringrequired
    Name of the state or state abbreviation.≤ 50 chars
- businessStartDatestringdaterequired
  Date that the business was established. The format of the value is YYYY-MM-DD.
- businessTypestring
  Type of business.retailrestaurantinternetmotolodgingnotForProfit
- categoryCodeintegerint32
  Merchant Category Code (MCC) for the type of business.≤ 4 chars
- contactMethodsobject[]required
  Array of polymorphic objects, which contain contact information. Note: You must provide an email address. The value of the type parameter determines which variant you should use: email Email address phone Phone number mobile Mobile number fax Fax number.≥ 1 items
  - emailobject
    typestringrequired
    Type of contact method.email
    valuestringrequired
    Email address.≤ 50 chars
  - phoneobject
    typestringrequired
    Type of contact method.phone
    valuestringrequired
    Phone number.≤ 15 chars
  - mobileobject
    typestringrequired
    Type of contact method.mobile
    valuestringrequired
    Mobile number.≤ 15 chars
  - faxobject
    typestringrequired
    Type of contact method.fax
    valuestringrequired
    Fax number.≤ 15 chars
- contactsobject[]
  Array of contact objects.
  - contactMethodsobject[]required
    Array of polymorphic objects, which contain contact information. Note: If you are adding information about an owner, you must provide at least an email address. If you are adding information about a contact, you must provide at least a contact number. The value of the type parameter determines which variant you should use: email Email address phone Phone number mobile Mobile number fax Fax number1–4 items
    emailobject
    typestringrequired
    Type of contact method.email
    valuestringrequired
    Email address.≤ 50 chars
    phoneobject
    typestringrequired
    Type of contact method.phone
    valuestringrequired
    Phone number.≤ 15 chars
    mobileobject
    typestringrequired
    Type of contact method.mobile
    valuestringrequired
    Mobile number.≤ 15 chars
    faxobject
    typestringrequired
    Type of contact method.fax
    valuestringrequired
    Fax number.≤ 15 chars
  - firstNamestringrequired
    Contact's first name.≤ 50 chars
  - identifiersobject[]
    Array of identifier objects.≥ 1 items
    typestringrequired
    Type of ID provided to verify identity.nationalId
    valuestringrequired
    Social Security Number (SSN) or Social Insurance Number (SIN).
  - lastNamestringrequired
    Contact's last name.≤ 50 chars
  - middleNamestring
    Contact's middle name.≤ 50 chars
  - typestringrequired
    Type of contact.managerrepresentativeothers
- doingBusinessAsstringrequired
  Trading name of the business.≤ 100 chars
- fundingobjectrequired
  Object that contains information about the funding schedule of the processing account.
  - acceleratedFundingFeeinteger
    Monthly fee in cents for accelerated funding. The value is in the currency's lowest denomination, for example, cents. We apply this fee if the value for fundingSchedule is sameday or nextday.
  - dailyDiscountboolean
    Indicates if we collect fees from the merchant's account each day.
  - fundingSchedulestring
    Indicates when funds are sent to the funding account. If you send a value of sameDay or nextDay, provide a value for acceleratedFundingFee. Note: If you send a value of sameday, funding includes all transactions the merchant ran before the ACH cut-off time.standardnextdaysameday
  - fundingAccountsobject[]
    Array of fundingAccounts objects.1–2 items
    metadataobject
    Metadata object you can use to include custom data with your request.
    nameOnAccountstringrequired
    Name of the account holder.
    paymentMethodsobject[]required
    Array of PaymentMethodAch objects.
    ACH payment methodobject
    typestring
    Payment method that we use to send funds to the account.ach
    valueobject
    Object that contains information about the funding account.
    accountNumberstringrequired
    Account number of the funding account.9–12 chars
    routingNumberstringrequired
    Routing number of the funding account.9–9 chars
    typestringrequired
    Type of funding account.checkingsavingsgeneralLedger
    usestringrequired
    Indicates if we send funds or withdraw funds from the account. credit Send funds to the account. debit Withdraw funds from the account. creditAndDebit Send funds and withdraw funds from the account. Note: If the funding account is associated with a funding recipient, we accept only a value of credit.creditdebitcreditAndDebit
- merchandiseOrServiceSoldstringrequired
  Description of the services or merchandise sold by the business.≤ 125 chars
- metadataobject
  Object that you can send to include custom data in the request. For more information about how to use metadata, go to Metadata.
- ownersobject[]required
  Collection of individuals that are responsible for a processing account. When you create a processing account, you must indicate at least one owner as either of the following: Control prong An individual who has a significant equity stake in the business and can make decisions for the processing account. You can add only one control prong to a processing account. Authorized signatory An individual who doesn't have an equity stake in the business but can make decisions for the processing account.≥ 1 items
  - addressobjectrequired
    Object that contains information about the address.
    address1stringrequired
    Address line 1.≤ 150 chars
    address2string
    Address line 2.≤ 150 chars
    address3string
    Address line 3.≤ 150 chars
    citystringrequired
    City.≤ 50 chars
    countrystringrequired
    Two-digit country code for the country that the business operates in. The format follows the ISO-3166-1 standard.2–2 chars
    postalCodestringrequired
    Zip code or postal code.≤ 10 chars
    statestringrequired
    Name of the state or state abbreviation.≤ 50 chars
  - contactMethodsobject[]required
    Array of polymorphic objects, which contain contact information. Note: If you are adding information about an owner, you must provide at least an email address. If you are adding information about a contact, you must provide at least a contact number. The value of the type parameter determines which variant you should use: email Email address phone Phone number mobile Mobile number fax Fax number1–4 items
    emailobject
    typestringrequired
    Type of contact method.email
    valuestringrequired
    Email address.≤ 50 chars
    phoneobject
    typestringrequired
    Type of contact method.phone
    valuestringrequired
    Phone number.≤ 15 chars
    mobileobject
    typestringrequired
    Type of contact method.mobile
    valuestringrequired
    Mobile number.≤ 15 chars
    faxobject
    typestringrequired
    Type of contact method.fax
    valuestringrequired
    Fax number.≤ 15 chars
  - dateOfBirthstringdaterequired
    Owner's date of birth. The format of this value is YYYY-MM-DD.
  - firstNamestringrequired
    Owner's first name.≤ 50 chars
  - identifiersobject[]required
    Array of IDs.≥ 1 items
    typestringrequired
    Type of ID provided to verify identity.nationalId
    valuestringrequired
    Social Security Number (SSN) or Social Insurance Number (SIN).
  - lastNamestringrequired
    Owner's last name.≤ 50 chars
  - middleNamestring
    Owner's middle name.≤ 50 chars
  - relationshipobjectrequired
    Object that contains information about the owner's relationship to the business.
    equityPercentagenumberpercentage
    Percentage equity stake that the owner holds in the business.
    isAuthorizedSignatoryboolean
    Indicates if the owner is an authorized signatory.
    isControlProngbooleanrequired
    Indicates if the owner is a control prong. You can identify only one control prong for a business.
    titlestring
    Owner's job title.
- pricingobjectrequired
  Polymorphic object that contains pricing information for the processing account. The value of the type parameter determines which variant you should use: intent Use a pricing agreement template. agreement Create a new pricing agreement.
  - intentobject
    pricingIntentIdstringrequired
    Unique identifier of the pricing intent.
    typestringrequired
    Type of pricing for the processing account. Note: To create a pricing intent, go to Create Pricing Intent.intent
  - agreementobject
    Polymorphic object that contains pricing agreement information for the processing account.
    typestringrequired
    agreement
    US pricing agreement version 5.2object
    Object that contains information about U.S. pricing intents for Merchant Processing Agreement (MPA) 5.2.
    baseobjectrequired
    Object that contains information about U.S. base fees.
    addressVerificationintegernullrequired
    Fee for each address verification request. The value is in the currency's lowest denomination, for example, cents.≥ 0
    annualFeeobjectrequired
    Object that contains information about the annual fee.
    amountintegerrequired
    Annual fee. The value is in the currency's lowest denomination, for example, cents.≥ 0
    billInMonthstring
    Indicates whether we collect the annual fee in June or December.junedecember
    batchintegerrequired
    Fee for each batch. The value is in the currency's lowest denomination, for example, cents.≥ 0
    chargebackinteger
    Fee for each chargeback. The value is in the currency's lowest denomination, for example, cents.750–5000
    earlyTerminationinteger
    Fee for early termination. The value is in the currency's lowest denomination, for example, cents.19500–59500
    maintenanceintegerrequired
    Monthly fee for maintenance. The value is in the currency's lowest denomination, for example, cents.≥ 500
    minimumintegerrequired
    Monthly fee that we charge when the merchant doesn't meet the minimum fee amount. This monthly fee is in the currency's lowest denomination, for example, cents.≥ 0
    pciNonComplianceinteger
    Fee that we apply each month if you aren't compliant with PCI standards. The value is in the currency's lowest denomination, for example, cents.3995–10000
    platinumSecurityobject
    Object that contains information about the Platinum Security fee.
    monthlyobject
    amountinteger
    Fee for Platinum Security. The value is in the currency's lowest denomination, for example, cents.
    billingFrequencystringrequired
    Indicates whether we bill your account monthly or annually.monthly
    annualobject
    amountinteger
    Fee for the Platinum Security, this is returned in the lowest unit of currency. For example, cents.
    billingFrequencystringrequired
    Indicates whether we bill your account monthly or annually.annual
    regulatoryAssistanceProgramintegernullrequired
    Annual fee for the regulatory assistance program. The value is in the currency's lowest denomination, for example, cents.≥ 0
    retrievalinteger
    Fee for each retrieval. The value is in the currency's lowest denomination, for example, cents.275–5000
    voiceAuthorizationinteger
    Fee for each voice authorization. The value is in the currency's lowest denomination, for example, cents.95–200
    countrystringrequired
    Two-digit code for the country that the pricing intent applies to. The format follows the ISO-3166-1 standard.US
    gatewayobject
    Object that contains information about the gateway fees for MPA 5.2.
    feesobjectrequired
    Object that contains information about the gateway fees.
    3dSecurePerTransactioninteger
    Fee for each transaction which utilizes 3D Secure. The value is in the currency's lowest denomination, for example, cents.≥ 0
    monthlyintegerrequired
    Monthly fee for the gateway. The value is in the currency's lowest denomination, for example, cents.≥ 0
    perDeviceMonthlyintegerrequired
    Monthly fee for each device. The value is in the currency's lowest denomination, for example, cents.≥ 0
    perTransactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    setupintegerrequired
    Fee for setting up your account with the gateway. The value is in the currency's lowest denomination, for example, cents.≥ 0
    tapToPayPerTransactioninteger
    Fee for each tap to pay transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    processorobject
    Object that contains information about U.S. processor fees.
    achobject
    Object that contains the fees for ACH transactions.
    feesobject
    Object that contains processing fees for ACH transactions.
    accountVerificationintegerrequired
    Fee for each account verification. The value is in the currency's lowest denomination, for example, cents.≥ 0
    batchintegerrequired
    Fee for each batch. The value is in the currency's lowest denomination, for example, cents.≥ 0
    discountRateAbove10000numberdoublerequired
    Percentage discount for ACH transfers equal to or more than $10,000.0–100
    discountRateUnder10000numberdoublerequired
    Percentage discount for ACH transfers less than $10,000.0–100
    monthlyMinimumintegerrequired
    Minimum monthly value of transactions. The value is in the currency's lowest denomination, for example, cents.≥ 0
    returnsintegerrequired
    Fee for each return. The value is in the currency's lowest denomination, for example, cents.≥ 0
    statementintegerrequired
    Fee for each statement. The value is in the currency's lowest denomination, for example, cents.≥ 0
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    unauthorizedReturnintegerrequired
    Fee for each unauthorized return. The value is in the currency's lowest denomination, for example, cents.≥ 0
    cardobject
    Object that contains information about card fees.
    Interchange Plus Planobject
    Object that contains information about Interchange Plus.
    feesobjectrequired
    Object that contains information about the fees.
    amexobject
    Object that contains the fees for American Express transactions.
    optBlueobject
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    typestringrequired
    Type of American Express program.optBlue
    volumenumberdoublerequired
    Percentage of the total transaction amount that the processor charges the merchant.0–100
    directobject
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    typestringrequired
    Type of American Express program.direct
    electronicBenefitsTransferobject
    Object that contains the fees for EBT transactions.
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    mastercardVisaDiscoverobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    pinDebitobject
    Object that contains the fees for PIN-debit transactions.
    additionalDiscountnumberdoublerequired
    Percentage of additional discount.0–100
    monthlyAccessintegerrequired
    Monthly access fee for using PIN-debit services. The value is in the currency's lowest denomination, for example, cents.≥ 0
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    specialityCardsobject
    Object that contains the fees for speciality cards.
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    planTypestringrequired
    Type of processing plan.interchangePlus
    Interchange Plus Plusobject
    Object that contains information about Interchange Plus Plus.
    feesobjectrequired
    Object that contains information about the fees.
    amexobject
    Object that contains the fees for American Express transactions.
    optBlueobject
    midQualRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    nonQualRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    qualifiedRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    typestringrequired
    Type of American Express program.optBlue
    directobject
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    typestringrequired
    Type of American Express program.direct
    electronicBenefitsTransferobject
    Object that contains the fees for EBT transactions.
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    mastercardVisaDiscoverobjectrequired
    midQualRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    nonQualRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    qualifiedRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    pinDebitobject
    Object that contains the fees for PIN-debit transactions.
    additionalDiscountnumberdoublerequired
    Percentage of additional discount.0–100
    monthlyAccessintegerrequired
    Monthly access fee for using PIN-debit services. The value is in the currency's lowest denomination, for example, cents.≥ 0
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    specialityCardsobject
    Object that contains the fees for speciality cards.
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    planTypestringrequired
    Type of processing plan.interchangePlusPlus
    Tiered pricing with three tiersobject
    Object that contains information about tiered pricing with three tiers.
    feesobjectrequired
    Object that contains information about the fees.
    amexobject
    Polymorphic object that contains fees for American Express transactions. The value of the type field determines which variant you should use: optBlue Amex OptBlue pricing program. direct Amex Direct pricing program.
    optBlueobject
    midQualRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    nonQualRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    qualifiedRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    typestringrequired
    Type of American Express program.optBlue
    directobject
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    typestringrequired
    Type of American Express program.direct
    electronicBenefitsTransferobject
    Object that contains the fees for EBT transactions.
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    mastercardVisaDiscoverobjectrequired
    midQualRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    nonQualRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    qualifiedRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    pinDebitobject
    Object that contains the fees for PIN-debit transactions.
    additionalDiscountnumberdoublerequired
    Percentage of additional discount.0–100
    monthlyAccessintegerrequired
    Monthly access fee for using PIN-debit services. The value is in the currency's lowest denomination, for example, cents.≥ 0
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    specialityCardsobject
    Object that contains the fees for speciality cards.
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    planTypestringrequired
    Type of processing plan.tiered3
    Tiered pricing with four tiersobject
    Object that contains information about tiered pricing with four tiers.
    feesobjectrequired
    Object that contains information about the fees.
    amexobject
    Polymorphic object that contains fees for American Express transactions. The value of the type field determines which variant you should use: optBlue Amex OptBlue pricing program. direct Amex Direct pricing program.
    optBlueobject
    midQualRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    nonQualRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    qualifiedRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    typestringrequired
    Type of American Express program.optBlue
    directobject
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    typestringrequired
    Type of American Express program.direct
    electronicBenefitsTransferobject
    Object that contains the fees for EBT transactions.
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    mastercardVisaDiscoverobjectrequired
    midQualRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    nonQualRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    qualifiedRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    premiumRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    pinDebitobject
    Object that contains the fees for PIN-debit transactions.
    additionalDiscountnumberdoublerequired
    Percentage of additional discount.0–100
    monthlyAccessintegerrequired
    Monthly access fee for using PIN-debit services. The value is in the currency's lowest denomination, for example, cents.≥ 0
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    specialityCardsobject
    Object that contains the fees for speciality cards.
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    planTypestringrequired
    Type of processing plan.tiered4
    Tiered pricing with six tiersobject
    Object that contains information about tiered pricing with six tiers.
    feesobjectrequired
    Object that contains information about the fees.
    amexobject
    Polymorphic object that contains fees for American Express transactions. The value of the type field determines which variant you should use: optBlue Amex OptBlue pricing program. direct Amex Direct pricing program.
    optBlueobject
    midQualRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    nonQualRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    qualifiedRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    typestringrequired
    Type of American Express program.optBlue
    directobject
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    typestringrequired
    Type of American Express program.direct
    electronicBenefitsTransferobject
    Object that contains the fees for EBT transactions.
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    mastercardVisaDiscoverobjectrequired
    regulatedCheckCardobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    unregulatedCheckCardobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    midQualRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    nonQualRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    qualifiedRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    premiumRateobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    pinDebitobject
    Object that contains the fees for PIN-debit transactions.
    additionalDiscountnumberdoublerequired
    Percentage of additional discount.0–100
    monthlyAccessintegerrequired
    Monthly access fee for using PIN-debit services. The value is in the currency's lowest denomination, for example, cents.≥ 0
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    specialityCardsobject
    Object that contains the fees for speciality cards.
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    planTypestringrequired
    Type of processing plan.tiered6
    Flat Rate Planobject
    Object that contains information about Flat Rate.
    feesobjectrequired
    Object that contains information about the Flat Rate fees.
    amexobject
    Polymorphic object that contains fees for American Express transactions.
    directobject
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    typestringrequired
    Type of American Express program.direct
    electronicBenefitsTransferobject
    Object that contains the fees for EBT transactions.
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    pinDebitobject
    Object that contains the fees for PIN-debit transactions.
    additionalDiscountnumberdoublerequired
    Percentage of additional discount.0–100
    monthlyAccessintegerrequired
    Monthly access fee for using PIN-debit services. The value is in the currency's lowest denomination, for example, cents.≥ 0
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    specialityCardsobject
    Object that contains the fees for speciality cards.
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    standardCardsobjectrequired
    Object that contains information about the processor fees.
    transactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdouble
    Percentage of total transaction amount that the processor charges the merchant.0–100
    planTypestringrequired
    Type of processing plan.flatRate
    Consumer Choice Planobject
    Object that contains information about ConsumerChoice.
    feesobjectrequired
    Object that contains information about the fees.
    electronicBenefitsTransferobject
    Object that contains the fees for EBT transactions.
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    merchantChargePercentagenumberdouble
    Percentage of the total transaction amount that the processor charges the merchant.0–100
    monthlySubscriptionintegerrequired
    Fee for the monthly subscription for the processing plan. The value is in the currency's lowest denomination, for example, cents.≥ 0
    pinDebitobject
    Object that contains the fees for PIN-debit transactions.
    additionalDiscountnumberdoublerequired
    Percentage of additional discount.0–100
    monthlyAccessintegerrequired
    Monthly access fee for using PIN-debit services. The value is in the currency's lowest denomination, for example, cents.≥ 0
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    specialityCardsobject
    Object that contains the fees for speciality cards.
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdoublerequired
    Merchant-authorized percentage on non-cash transactions.0–100
    planTypestringrequired
    Type of processing plan.consumerChoice
    RewardPayChoice Planobject
    Object that contains information about RewardPayChoice.
    feesobjectrequired
    Object that contains information about the fees.
    creditobjectrequired
    Object that contains information about fees for credit transactions.
    merchantChargePerTransactioninteger
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    tipsstring
    Indicates how the merchant manages tips.noTipstipPrompttipAdjust
    debitobjectrequired
    Object that contains information about fees for debit transactions.
    optionstring
    Indicates if debit transactions should be charged at interchange plus or flat rate pricing.interchangePlusflatRate
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    volumenumberdoublerequired
    Percentage of the total transaction that the processor charges the merchant.0–100
    monthlySubscriptionintegerrequired
    Fee for the monthly subscription for the processing plan. The value is in the currency's lowest denomination, for example, cents.≥ 0
    specialityCardsobject
    Object that contains the fees for speciality cards.
    transactionintegerrequired
    Fee for each transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    planTypestringrequired
    Type of processing plan.rewardPayChoice
    servicesobject[]
    Object that contains information about our additional services that the merchant can sign up for.
    option 1object
    Object that contains information about the Hardware Advantage Plan.
    enabledbooleanrequired
    Indicates if the merchant has signed up for the Hardware Advantage Plan.
    namestringrequired
    Name of the service.hardwareAdvantagePlan
    option 2object
    Object that contains the fees for account updater service.
    feesobjectrequired
    Object that contains information about the gateway fees.
    monthlyintegerrequired
    Monthly fee for Account Updater service. The value is in the currency's lowest denomination, for example, cents.≥ 0
    perUpdateintegerrequired
    Fee for each account update. The value is in the currency's lowest denomination, for example, cents.≥ 0
    setupintegerrequired
    Setup fee for Account Updater service. The value is in the currency's lowest denomination, for example, cents.≥ 0
    namestringrequired
    Name of the service.accountUpdater
    option 3object
    Object that contains the fees for wireless processing.
    feesobjectrequired
    monthlyAccessintegerrequired
    Monthly network access fee for Wireless Processing. The value is in the currency's lowest denomination, for example, cents.≥ 0
    setupintegerrequired
    Setup fee for Wireless Processing. The value is in the currency's lowest denomination, for example, cents.≥ 0
    namestringrequired
    Name of the service.wirelessProcessing
    option 4object
    Object that contains the fees for the Clover platform service.
    feesobjectrequired
    Object that contains the Clover platform fee amounts.
    dataProtectionPerMidintegerrequired
    Data Protection Services fee per MID. The value is in the currency's lowest denomination, for example, cents.≥ 0
    keyedAuthorizationPerTransactionintegerrequired
    Fee per keyed or card-not-present transaction. The value is in the currency's lowest denomination, for example, cents.≥ 0
    platformMonthlyintegerrequired
    Monthly platform fee for Clover. The value is in the currency's lowest denomination, for example, cents.≥ 0
    namestringrequired
    Name of the service.cloverProcessing
    option 5object
    Object that contains the fees for the Roc Services gateway.
    feesobjectrequired
    Object that contains the Roc Services fee amounts.
    monthlyintegerrequired
    Monthly fee for Roc Services. The value is in the currency's lowest denomination, for example, cents.≥ 0
    namestringrequired
    Name of the service.rocServicesProcessing
    versionstringrequired
    Version of the MPA.5.2
- processingobjectrequired
  Object that contains information about how we process transactions for the account.
  - achobject
    Object that contains information about Automated Clearing House (ACH) transactions.
    estimatedMonthlyTransactionsintegerrequired
    Estimated maximum number of transactions that the merchant will process in a month.
    limitsobjectrequired
    Object that contains information about transaction limits for the processing account.
    dailyDepositintegerrequired
    Maximum amount of total transactions allowed per day. The value is in the currency's lowest denomination, for example, cents.
    monthlyDepositintegerrequired
    Maximum amount of total transactions allowed per month. The value is in the currency's lowest denomination, for example, cents.
    singleTransactionintegerrequired
    Maximum amount allowed for a single debit or credit transaction. The value is in the currency's lowest denomination, for example, cents.
    naicsstring
    North American Industry Classification System (NAICS) code.≤ 6 chars
    previouslyTerminatedForAchboolean
    Indicates if the business or its principals were previously turned down for ACH processing.
    refundsobjectrequired
    Object that contains information about the ACH refund policy for the processing account.
    refundPolicyUrlstring
    URL of the written refund policy.≤ 2000 chars
    writtenRefundPolicybooleanrequired
    Indicates if the business has a written refund policy.
    transactionTypesstring[]
    List of transaction types that the processing account supports.
    transactionTypesOtherstring
    If you send a value of other for transactionTypes, provide a list of the supported transaction types.≤ 100 chars
  - cardAcceptanceobject
    Object that contains information about the types of cards that the processing account accepts.
    cardsAcceptedstring[]
    List of card types the merchant accepts.
    debitOnlyboolean
    Indicates if the merchant accepts only debit cards.
    hsaFsaboolean
    Indicates if the merchant accepts health savings account (HSA) and flexible spending account (FSA) cards.
    specialityCardsobject
    Information about the speciality cards that the merchant accepts.
    americanExpressDirectobject
    Object that indicates if the merchant accepts American Express Direct cards and contains the merchant’s American Express merchant number.
    enabledboolean
    Indicates if the merchant accepts American Express Direct.
    merchantNumberstring
    If the merchant accepts American Express Direct, provide their American Express merchant number.≤ 100 chars
    electronicBenefitsTransferobject
    Object that indicates if the merchant accepts Electronic Benefits Transfer (EBT) cards and contains the merchant’s Food and Nutrition Services (FNS) number.
    enabledboolean
    Indicates if the merchant accepts EBT.
    fnsNumberstring
    If the merchant accepts EBT, provide their FNS number.≤ 7 chars
    otherobject
    Object that contains information about other speciality cards that the merchant accepts.
    fleetMerchantIdstring
    If the merchant accepts Fleet, provide their Fleet merchant ID.≤ 50 chars
    voyagerMerchantIdstring
    If the merchant accepts Voyager, provide their Voyager merchant ID.≤ 50 chars
    wexMerchantNumberstring
    If the merchant accepts WEX, provide their WEX merchant number.≤ 50 chars
  - isSeasonalboolean
    Indicates if the processing account runs transactions on a seasonal basis. For example, if the processing account runs transactions during only the winter months, send a value of true.
  - monthlyAmountsobjectrequired
    Object that contains information about the monthly processing amounts for the processing account.
    averageintegerint64required
    Estimated average transaction amount each month. The value is in the currency's lowest denomination, for example, cents. You must provide an amount that is greater than zero.
    highestintegerint64required
    Estimated maximum transaction amount each month. The value is in the currency's lowest denomination, for example, cents. You must provide an amount that is greater than zero.
  - monthsOfOperationstring[]
    Months of the year that the processing account runs transactions.≤ 12 items
  - transactionAmountsobjectrequired
    Object that contains information about transaction amounts for the processing account.
    averageintegerint64required
    Estimated average transaction amount. The value is in the currency's lowest denomination, for example, cents. You must provide an amount that is greater than zero.
    highestintegerint64required
    Estimated maximum transaction amount. The value is in the currency's lowest denomination, for example, cents. You must provide an amount that is greater than zero.
  - volumeBreakdownobjectrequired
    Object that contains information about the types of transactions ran by the processing account. The percentages for transaction types must total 100%.
    cardPresentintegerint32required
    Estimated percentage of card-present transactions.
    ecommerceintegerint32required
    Estimated percentage of e-Commerce transactions.
    mailOrTelephoneintegerint32required
    Estimated percentage of mail order or telephone transactions.
- processorstring
  Processor that authorizes and settles transactions for the processing account. Note: We recommend that you include a value for the processor parameter and not rely on the default value.tsysfiserv
- signatureobjectrequired
  Polymorphic object that contains information about how we captured the owner's signature. The value of the type parameter determines which variant you should use: requestedViaDirectLink Request signature using a link. requestedViaEmail Request signature by email.
  - requestedViaDirectLinkobject
    Object that contains signature information if we captured the merchant’s signature by direct link.
    typestringrequired
    Method used to capture the owner's signature.requestedViaDirectLink
  - requestedViaEmailobject
    Object that contains signature information if we captured the merchant’s signature by email.
    typestringrequired
    Method used to capture the owner's signature.requestedViaEmail
- timezonestringrequired
  Time zone for the processing account.≤ 28 charsPacific/MidwayPacific/HonoluluAmerica/AnchorageAmerica/Los_AngelesAmerica/DenverAmerica/PhoenixAmerica/ChicagoAmerica/Indiana/Indianapolis+1 more
- websitestring
  Website address of the business.≤ 128 chars

Responses

Successful request. We created the merchant platform.

201 Created · application/json

{
  "business": {
    "addresses": [
      {
        "address1": "1 Example Ave.",
        "address2": "Example Address Line 2",
        "address3": "Example Address Line 3",
        "city": "Chicago",
        "country": "US",
        "postalCode": "60056",
        "state": "Illinois",
        "type": "legalAddress"
      }
    ],
    "contactMethods": [
      {
        "type": "email",
        "value": "jane.doe@example.com"
      }
    ],
    "countryOfOperation": "US",
    "name": "Example Corp",
    "organizationType": "privateCorporation",
    "taxId": "xxxxx6789"
  },
  "createdDate": "2024-07-02T12:00:00.000+00:00",
  "lastModifiedDate": "2024-07-02T12:00:00.000+00:00",
  "merchantPlatformId": "12345",
  "processingAccounts": [
    {
      "addendums": [],
      "doingBusinessAs": "Pizza Doe",
      "link": {
        "href": "https://api.payroc.com/v1/processing-accounts/38765",
        "method": "get",
        "rel": "processingAccount"
      },
      "processingAccountId": "38765",
      "processor": "tsys",
      "signature": {
        "link": {
          "href": "https://us.agreementexpress.net/mv2/viewer2.jsp?docId=00000000-0000-0000-0000-000000000000",
          "method": "get",
          "rel": "agreement"
        },
        "type": "requestedViaDirectLink"
      },
      "status": "pending"
    }
  ]
}

Response schema · 129 fields

businessobjectrequired
Object that contains information about the business.
- addressesobject[]required
  Array of polymorphic objects that contain address information for the business.≥ 1 items
  - legalAddressobject
    Type of address.
    typestringrequired
    Type of address.legalAddress
    address1stringrequired
    Address line 1.≤ 150 chars
    address2string
    Address line 2.≤ 150 chars
    address3string
    Address line 3.≤ 150 chars
    citystringrequired
    City.≤ 50 chars
    countrystringrequired
    Two-digit country code for the country that the business operates in. The format follows the ISO-3166-1 standard.2–2 chars
    postalCodestringrequired
    Zip code or postal code.≤ 10 chars
    statestringrequired
    Name of the state or state abbreviation.≤ 50 chars
- contactMethodsobject[]required
  Array of polymorphic objects, which contain contact information. Note: You must provide an email address. The value of the type parameter determines which variant you should use: email Email address phone Phone number mobile Mobile number fax Fax number≥ 1 items
  - emailobject
    typestringrequired
    Type of contact method.email
    valuestringrequired
    Email address.≤ 50 chars
  - phoneobject
    typestringrequired
    Type of contact method.phone
    valuestringrequired
    Phone number.≤ 15 chars
  - mobileobject
    typestringrequired
    Type of contact method.mobile
    valuestringrequired
    Mobile number.≤ 15 chars
  - faxobject
    typestringrequired
    Type of contact method.fax
    valuestringrequired
    Fax number.≤ 15 chars
- countryOfOperationstring
  Two-digit code for the country that the business operates in. The format follows the ISO-3166 standard.US
- namestringrequired
  Legal name of the business.≤ 100 chars
- organizationTypestringrequired
  Type of organization.privateCorporationpublicCorporationnonProfitprivateLlcpublicLlcprivatePartnershippublicPartnershipsoleProprietor
- taxIdstringrequired
  Tax ID of the business.≤ 20 chars
createdDatestringdate-time
Date that the merchant platform was created. We return this value in the ISO-8601 format.
lastModifiedDatestringdate-time
Date that the merchant platform was last modified. We return this value in the ISO-8601 format.
linksobject[]
Array of useful links related to your request.
- hrefstringrequired
  URL of the target resource.
- methodstringrequired
  HTTP method that you need to use with the target resource.
- relstringrequired
  Indicates the relationship between the current resource and the target resource.
merchantPlatformIdstring
Unique identifier that we assigned to the merchant platform.
metadataobject
Object that you can send to include custom metadata in the request.
processingAccountsobject[]required
Array of processingAccount objects.
- addendumsobject[]required
  The addendum types that were accepted and appended to the Merchant Processing Agreement for this processing account. Returns an empty array when no addendums were requested.
  - option 1object
    Installment Payments, Loans, or Lease Questionnaire/Attestation for merchants that offer installment payments, loans, or leases.
    typestringrequired
  - option 2object
    Money Services Business Questionnaire for merchants that offer money services, for example, traveler's checks.
    typestringrequired
  - option 3object
    Telehealth Attestation for merchants that provide telehealth services.
    typestringrequired
  - option 4object
    Firearms Due Diligence for merchants that sell firearms.
    typestringrequired
  - option 5object
    Attestation of Compliance and Questionnaire for pharmaceutical merchants that accept CNP transactions.
    typestringrequired
  - option 6object
    CBD Attestation for merchants that sell any of the following products: CBD products Synthetic THC or Cannabis HHC Kratom Tianeptine Delta 8/9/10/0 THC products
    typestringrequired
  - option 7object
    CNP Tobacco Merchant Questionnaire for merchants that sell tobacco products and accept CNP transactions.
    typestringrequired
  - option 8object
    Donations Addendum for merchants that accept donations.
    typestringrequired
  - option 9object
    Clover Merchant Processing Amendment for merchants that order Clover equipment.
    lineItemsobjectrequired
    Object that contains information about the Clover equipment and accessories that the merchant wants to order.
    cloverBarCodeScannerobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverCashDrawerobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverCompactobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverCompactTetherCableobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverFlex4thGenobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverFlexPocketobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverHandsFreeScannerobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverKds14object
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverKds24object
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverKitchenPrinterobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverKitchenPrinterThermalobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverMiniLte3rdGenobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverSoloPosSystemobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverStationDuoGen2PosSystemobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    cloverWeightScaleobject
    Object that contains information about the cost of each item and the number of items that the merchant wants to order.
    quantityintegerrequired
    Number of units.≥ 1
    totalPriceintegerrequired
    Total cost for all devices in this line item, in cents (USD).≥ 0
    typestringrequired
  - option 10object
    Roc Giving Addendum for merchants that use Roc Giving.
    accountAdminContactobjectrequired
    Object that contains contact details for the Roc Giving account administrator.
    emailAddressstringrequired
    Email address of the Roc Giving account administrator.≤ 50 chars
    firstNamestringrequired
    First name of the Roc Giving account administrator.≤ 50 chars
    lastNamestringrequired
    Last name of the Roc Giving account administrator.≤ 50 chars
    phonestring
    Phone number of the Roc Giving account administrator.≤ 15 chars
    autoCloseTimestringrequired
    Time that the processing terminal closes the batch in HH:mm format using the 24-hour clock.≤ 5 chars
    donorSupportPercentagenumberrequired
    Percentage of the total donation amount that a donor can add to their donation to provide additional support to the organization.0–100
    planstring
    Roc Giving pricing plan for the processing account. The value is one of the following: basic Merchant has access to the features available with the basic Roc Giving plan. advanced Merchant has access to the additional features available with the advanced Roc Giving plan.basicadvanced
    typestringrequired
- doingBusinessAsstringrequired
  Trading name of the business.
- linkobject
  Object that contains HATEOAS links for the processing account.
  - hrefstring
    Link to the resource.
  - methodstring
    HTTP method you can use to retrieve the resource.
  - relstring
    Relationship to the parent resource.
- processingAccountIdstring
  Unique identifier that we assigned to the processing account.
- processorstringrequired
  Processor that authorizes and settles transactions for the processing account. Note: We recommend that you include a value for the processor parameter and not rely on the default value.tsysfiserv
- signatureobject
  Polymorphic object that contains information about how we captured the owner's signature. The value of the type parameter determines which variant you should use: requestedViaDirectLink Request signature using a link. requestedViaEmail Request signature by email.
  - requestedViaDirectLinkobject
    Object that contains signature information if we captured the merchant’s signature by direct link.
    linkobject
    Object that contains links to the signed contract.
    hrefstringrequired
    URL of the target resource.
    methodstringrequired
    HTTP method that you need to use with the target resource.
    relstringrequired
    Indicates the relationship between the current resource and the target resource.
    typestringrequired
    Method used to capture the owner's signature.requestedViaDirectLink
  - requestedViaEmailobject
    Object that contains signature information if we captured the merchant’s signature by email.
    typestringrequired
    Method used to capture the owner's signature.requestedViaEmail
- statusstringrequired
  Status of the processing account. entered We have received information about the account, but we have not yet reviewed it. pending We have reviewed the information about the account, but we have not yet approved it. approved We have approved the account for processing transactions and funding. subjectTo We have approved the account, but we are waiting on further information. dormant Account is closed for a period. nonProcessing We have approved the account, but the merchant has not yet run a transaction. rejected We rejected the application for the processing account. terminated Processing account is closed. cancelled Merchant withdrew the application for the processing account. failed An error occurred while we were setting up the processing account. Note: You can subscribe to our processingAccount.status.changed event to get notifications when we change the status of a processing account. For more information about how to subscribe to events, go to Event Subscriptions.enteredpendingapprovedsubjectTodormantnonProcessingrejectedterminated+2 more

Validation error.

400 Bad Request · application/problem+json

{
  "detail": "Your request contained an addendum entry that is missing required fields.",
  "errors": [
    {
      "detail": "Missing required field.",
      "message": "lineItems is required for addendum type cloverMerchantProcessingAmendment.",
      "parameter": "processingAccounts[0].addendums[0].lineItems"
    }
  ],
  "status": 400,
  "title": "One or more validation errors occurred.",
  "type": "https://docs.payroc.com/api/errors#bad-request"
}

Response schema · 8 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- detailstring
  Short detail of the validation errors
- messagestring
  Error message
- parameterstring
  The parameter or field causing the issues
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Identity could not be verified

401 Unauthorized · application/problem+json

{
  "detail": "Your identity could not be verified",
  "status": 401,
  "title": "Not Authorized",
  "type": "https://docs.payroc.com/api/errors#not-authorized"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Do not have permissions to perform this action

403 Forbidden · application/problem+json

{
  "detail": "You do not have the required permissions to perform this action",
  "instance": "https://api.payroc.com/v1/exampleResource/3",
  "resource": "exampleResource",
  "status": 403,
  "title": "Forbidden",
  "type": "https://docs.payroc.com/api/errors#forbidden"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
instancestring
Resource path the action was attempted on
resourcestring
Resource the action was attempted on
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Not acceptable

406 Not Acceptable · application/problem+json

{
  "detail": "Resource does not support the representation requested",
  "status": 406,
  "title": "Not acceptable",
  "type": "https://docs.payroc.com/api/errors#not-acceptable"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Conflict

409 Conflict · application/problem+json

{
  "detail": "'Idempotency-Key' is already in use against a different request",
  "status": 409,
  "title": "Idempotency-Key in use",
  "type": "https://docs.payroc.com/api/errors#idempotency-key-in-use"
}

Response schema · 13 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- detailstring
  Short detail of the validation errors
- messagestring
  Error message
- parameterstring
  The parameter or field causing the issues
instancestring
Resource path to the existing resource
linkobject
Object that contains HATEOAS links for the resource.
- hrefstringrequired
  URL of the target resource.
- methodstringrequired
  HTTP method that you need to use with the target resource.
- relstringrequired
  Indicates the relationship between the current resource and the target resource.
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

An error has occured

500 Internal Server Error · application/problem+json

{
  "detail": "We are unable to process your request at this time",
  "errors": [
    {
      "message": "Service offline"
    }
  ],
  "status": 500,
  "title": "Api error",
  "type": "https://docs.payroc.com/api/errors#api-error"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- messagestring
  Error message
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Used in workflows

create-merchant-platform