Boarding Merchants

Modified on Wed, 3 May, 2023 at 1:30 PM

TABLE OF CONTENTS

Boarding the Merchant
Retrieving a Merchant
Updating a Merchant
Onboarding Object
Onboarding Response Object
Create Merchant Sample
Update Merchant Sample
Get Merchant Sample

Boarding a Merchant on the ACME Platform

These APIs are used for seller, or merchant, onboarding. ACME designed this overall process via an auto-boarding API that returns a MID (merchant ID) in real-time used for payment processing APIs, this MID can be auto-approved within a few minutes if underwriting clears. In practice, the onboarding is done incrementally as several pieces of data need to be collected either via front-end software flows or, in some cases, by complementing via the ACME onboarding team. Requirements depend on the country's regulations for the merchant being onboarded.

We follow the underwriting regulations per country, which we automate. Currently in the US, and soon Canada, we support card processing and banking regulations such as KYC (Know Your Customers), AML (Anti Money Laundering), checks against blacklisted merchants with MATCH , GIACT for banking identity checks as well as LexisNexis for further identification checks verifications.

The general type of seller data needed before a seller can be activated for payment processing is segmented into

"identity" so that the underwriting process (software or manual) can apply the local country regulations by industry to verify the identity.
bank account information to deposit the payment proceeds to the seller
rate card information to take the ISV proceeds and settle via an already given ISV bank account.
Upon submitting seller information, the system performs a series of background checks and underwriter approval normally occurs within 2 minutes if the provided data is valid

Note those APIs will be in Sandbox in early Q1 2023 for integrations and in prod by Q1.

Boarding the Merchant

This endpoint is used to submit the merchant data which will be used to underwriting the merchant.

POST v1/payment/onboard

Request Body

Include an Onboarding object as the body of the request.

Sample Request

POST https://sandX-api.acmepayments.net/v1/payment/onboard

Response

Returns the Onboarding response object with the MID.

Retrieving a Merchant

Use this endpoint to find out the status of the merchant being onboarded.

GET v1/payment/onboard/{boardingRefId}

Request Parameter

The boardingRefId in the URL of the request.

Sample Request

GET https://sandX-api.acmepayments.net/v1/payment/onboard/f299a04f-0c6c-4176-b47b-ad08bb0c718a

Response

Returns the requested Onboarding response object.

Updating a Merchant

Update a merchant's details.

PATCH v1/payment/onboard/{boardingRefId}

Request Parameter

The boardingRefId in the URL of the request.

Request Body

The Onboarding object.

Sample Request

PATCH https://sandX-api.acmeticketing.net/v1/payment/onboard/f299a04f-0c6c-4176-b47b-ad08bb0c718a

Returns

Returns the updated Onboarding response object.

Onboarding Object

This is the object used for verification purposes in the automated underwriting multi stage process. Setting up a Rate Card will be needed before processing can begin.

Name	Type	Description	Validation	POST	PATCH
boardingRefId	string	Unique ID supplied by the caller and will be used for deduping	Must be UUID	Required	N/A
billingDescriptor	string	Billing Descriptor	Max 22 character. * ; _ . , and & are the only special characters allowed. ACME will prefix with 'AT *' for all merchants	Required	Optional, empty value
businessAddresses	List	List of businessAddresses objects	Must contain address type ‘Physical’	Required	Optional
businessAddresses.addressLine1	string	Address line 1	Max 40 characters. No commas. Special characters #, $, @, are allowed.	Required	Required field if businessAddresses is populated
businessAddresses.addressLine2	string	Address line2	Max 40 characters, No char validation	Optional	Optional, empty value will delete
businessAddresses.city	string	City	Max 28 characters. No char validation.	Required	Required field if businessAddresses is populated
businessAddresses.country	string	Country	Enumeration value. Refer to Onboarding Enumeration table	Required	Required field if businessAddresses is populated
businessAddresses.postalCode	string	Postal Code	^\d{5}$ Must be 5 digits.	Required	Required field if businessAddresses is populated
businessAddresses.postalCodeExtension	string	Postal Code Extension	^\d{4}$ Must be 4 digits.	Optional	Optional
businessAddresses.state	string	State	Enumeration value. Refer to Onboarding Enumeration table	Required	Required field if businessAddresses is populated
businessAddresses.type	string	Business address type	Enumeration value. Refer to Onboarding Enumeration table	Required	Required field if businessAddresses is populated
businessBankAccount	Object	Details of the bank account		Required	Optional
businessBankAccount.accountNumber	string	Direct deposit account number	Max 17 numbers. ^\d{1,17}$ Testing Note: Use unique value to avoid errors	Required	Required field if businessBankAccount is populated
businessBankAccount.accountType	string	Direct Deposit Account Type	Enumeration value. Refer to Onboarding Enumeration table	Required	Required field if businessBankAccount is populated
businessBankAccount.achType	string	Checking account deposit type	Enumeration value. Refer to Onboarding Enumeration table.	Required if accountType is Checking	Required if accountType is Checking. Empty value will delete
businessBankAccount.routingNumber	string	Direct deposit account routing	Max 9 numbers. ^\d{9}$ Testing Note: Must be a valid routing number	Required	Required field if businessBankAccount is populated
businessContacts	List	List of businessContacts		Required	Optional
businessContacts.email	string	Email address of the business contact	Max 64 characters	Required	Optional. Empty value will delete
businessContacts.faxNumber	string	Fax number of the business contact	Max 10 characters	Optional	Optional. Empty value will delete
businessContacts.firstName	string	First name of the business contact	Max 15 characters	Required	Required field if businessContacts is populated
businessContacts.lastName	string	Last name of the business contact	Max 25 characters	Required	Required field if businessContacts is populated
businessContacts.middleInitial	string	Middle initial of the business contact	Max 1 characters	Optional	Optional. Empty value will delete
businessContacts.phoneNumber	string	Phone number of the business contact	Max 10 characters	Required	Optional. Empty value will delete
businessContacts.phoneNumberExt	string	Phone number extension of the business contact	Max 8 characters	Optional	Optional. Empty value will delete
businessContacts.title	string	Title of the business contact	Max 40 characters	Optional	Optional. Empty value will delete
businessContacts.type	string	Type of merchant contact	Enumeration value. Refer to Onboarding Enumeration table	Required	Required field if businessContacts is populated
businessEstablishedDate	string	Business established date	Format 'yyyy-mm-dd'. Cannot be in the future.	Required	Optional. Empty value will delete
businessLegalName	string	Legal name of the merchant	40 characters. Valid special characters are space , ' & ; - _	Required	N/A (not editable)
businessOwners	List	List of businessOwners objects	If Ownership type is LLC, Partnership, NonProfit or PrivateCorporation: Control Owner firstName, lastName, ssn, dob, addressLine1, city, state, country, and postalCode are required. When a Beneficial owner is 25% or more, then firstName, lastName, ssn, dob, addressLine1, city, state, country, postalCode are mandatory here as well. If Ownership type is Government, FinancialInstitution, Trust, PublicCorporation, or SECRegulatedCorporation: Control Owner Information is optional. When provided, firstName, lastName, addressLine1, city, state, country, postalCode are mandatory. They can add up to 10 additional Beneficial owners (in addition to Control Owner). When provided, firstName, lastName, addressLine1, city, state, country, postalCode are mandatory. If Ownership type is SoleProprietorship: Beneficial Owner1 with firstName, lastName, addressLine1, city, state, country, postalCode, and DOB is mandatory. No other Owner type can be added.	Required	Optional
businessOwners.addressLine1	string	owner address line 1	Max 40 characters. Only latin-1 characters allowed.	See businessOwners validation notes	Required field if businessOwners is populated
businessOwners.addressLine2	string	owner address line2	Max 40 characters. Only latin-1 characters allowed.	Optional	Optional. Empty value will delete
businessOwners.businessOwnershipPercentage	integer	Business owner stake percentage	Digit between 0 and 100. All owners must add up to less than or equal to 100.	Optional	Optional
businessOwners.city	string	owner city	Max 28 characters. Only latin-1 characters allowed.	See businessOwners validation notes	Required field if businessOwners is populated
businessOwners.country	string	owner country	Enumeration value. Refer to Onboarding Enumeration table Required if IssuedIds.idType enum contains AlienID. CreditBureau, Mexican consulate, passport.	See businessOwners validation notes	See validation
businessOwners.dateOfBirth	string	Business owner date of birth	Format yyyy-mm-dd. Cannot be in the future.	See businessOwners validation notes	Optional. Empty value will delete
businessOwners.email	string	Business owner email	Max 64 characters. Email id must contain @ and .	Optional	Optional. Empty value will delete
businessOwners.faxNumber	string	Business owner fax number	Max 10 digits	Optional	Optional. Empty value will delete
businessOwners.firstName	string	Business Owner first name	Max 15 characters. Only latin-1 characters allowed.	See businessOwners validation notes	Required field if businessOwners is populated
businessOwners.identification	List	List of identifications		Optional	Optional
businessOwners.identification.dateExpired	string	Date on which id expires	Format yyyy-mm-dd.	Optional	Optional
businessOwners.identification.dateIssued	string	Date on which ID has been issued	Format yyyy-mm-dd.	Optional	Optional. Empty value will delete
businessOwners.identification.idNumber	string	ID number of the owner	Max 40 alpha numberic characters	Required	Required field if identification is populated
businessOwners.identification.idType	string	owner identification type	Enumeration value. Refer to Onboarding Enumeration table	Required	Required field if identification is populated
businessOwners.identification.issuedCity	string	City in which ID has been issued	Max 28 characters	Optional	Optional. Empty value will delete
businessOwners.identification.issuedCountry	string	Country code in which ID has been issued	Enumeration value. Refer to Onboarding Enumeration table	Optional	Optional. Empty value will delete
businessOwners.identification.issuedState	string	State in which ID has been issued.	Enumeration value. Refer to Onboarding Enumeration table State code is required for idType= DriverLicense, StateId, MilitaryID, CreditBureau	Optional	Optional. Empty value will delete
businessOwners.lastName	string	Business owner last name	Max 25 characters. Only latin-1 characters allowed.	See businessOwners validation notes	Required field if businessOwners is populated
businessOwners.middleInitial	string	Business owner middle Initial	Max 1 character. Only latin-1 characters allowed.	Optional	Optional. Empty value will delete
businessOwners.phoneNumber	string	Business owner phone number	^\d{10}$ Must be 10 digits.	Optional	Optional. Empty value will delete
businessOwners.phoneNumberExt	string	Business owner phone number extension	Max 8 digits.	Optional	Optional. Empty value will delete
businessOwners.postalCode	string	Owner postal code	^\d{5}$	See businessOwners validation notes	Optional. Empty value will delete
businessOwners.postalCodeExt	string	owner postal code extension	^\d{4}$	Optional	Optional
businessOwners.ssn	string	Business owner ssn	Max 9 digits. ^\d{9}$ String	See businessOwners validation notes	Optional. Empty value will delete
businessOwners.state	string	owner state	Enumeration value. Refer to Onboarding Enumeration table	See businessOwners validation notes	Required field if businessOwners is populated
businessOwners.title	string	Title of the business owner	Max 40 characters. Only latin-1 characters allowed.	Required	Optional. Empty value will delete
businessOwners.type	string	Type of the business owner	Enumeration value. Refer to Onboarding Enumeration table	Required	Required field if businessOwners is populated
businessOwnershipType	string	Ownership type	Enumeration value. Refer to Onboarding Enumeration table	Required	Required field if businessOwners is populated
businessType	string	business type	Enumeration value. Refer to Onboarding Enumeration table	Required	Optional. Empty value will delete
businessWebsiteUrl	string	Business website	Max 80 characters. Validation using ^(http://www.\|https://www.\|http://\|https://)?[a-z0-9]+([-.]{1}[a-z0-9]+).[a-z]{2,5}(:[0-9]{1,5})?(/.)?$	Required	Optional. Empty value will delete
dbaName	string	Doing business as name	40 characters. Valid special characters are space , ' & ; - _	Required	Optional
merchantCategoryCode	string	Merchant category code	Only allows 8398 or 7991	Required	N/A
taxId	string	Federal Tax ID Number. For CA, EIN employer identification number	^\d{9}$. Must be 9 digits. No dashes in between numbers.	Required	N/A

Onboarding Enumerations

Enum type	Enum’s
businessAddresses.type	"Physical" "Mailing" "TerminalDeployment"
businessBankAccount.accountType	"Checking" "Savings"
businessBankAccount.achType	"CommercialChecking" "PrivateChecking"
businessContacts.type	"CustomerService" "TerminalDeployment" "Primary"
businessOwners.identification.idType	"AlienId" "CreditBureau" "DriversLicense" "StateId" "MexicanConsulate" "MilitaryId" "Other" "Passport"
businessOwners.type	"ControlOwner" "BeneficialOwner1" "BeneficialOwner2" "BeneficialOwner3" "BeneficialOwner4" "BeneficialOwner5" "BeneficialOwner6" "BeneficialOwner7" "BeneficialOwner8" "BeneficialOwner9" "BeneficialOwner10"
businessOwnershipType	"PublicCorporation" "PrivateCorporation" "SECRegulatedCorporation" "Government" "SoleProprietorship" "LLC" "Partnership" "NonProfit" "FinancialInstitution" "Trust"
businessType	"AutoRental" "ECommerce" "Lodging" "MOTO" "Restaurant" "Retail"
country	"US" "CA"
IssuedIds.idType	"AlienId" "CreditBureau" "DriversLicense" "StateId""MexicanConsulate" "MilitaryId" "Other" "Passport"
state	"AK" "AL" "AR" "AZ" "CA" "CO" "CT" "DC" "DE" "FL" "GA" "HI" "IA" "ID" "IL" "IN" "KS" "KY" "LA" "MA" "MD" "ME" "MI" "MN" "MO" "MS" "MT" "NC" "ND" "NE" "NH" "NJ" "NM" "NV" "NY" "OH" "OK" "OR" "PA" "RI" "SC" "SD" "TN" "TX" "UT" "VA" "VT" "WA" "WI" "WV" "WY" "PR" "GU" "VI" "AB" "BC" "MB" "NB" "NL" "NS" "NT" "NU" "ON" "PE" "QC" "SK" "YT"

Onboarding Response Object

See Onboarding object for the parameters with no description

Name	Description	POST	PATCH	GET
boardingRefId	Reference id supplied in the original create sub-merchant call	✅	✅	✅
status	Status of the merchant.	✅		✅
mid	ACME MID for the merchant. This is the mid that is used in all the Payment URLs			✅
errorInfo	Error Info holds the validation error messages.			✅
createDate	Creation timestamp in UTC	✅
dbaName			✅	✅
billingDescriptor			✅	✅
businessType			✅	✅
merchantCategoryCode				✅
businessEstablishedDate			✅	✅
websiteUrl				✅
ownershipType				✅
taxId				✅
legalName			✅
storeNumber			✅
businessOwners				✅
businessOwners.title				✅
businessOwners.firstName				✅
businessOwners.middleInitial				✅
businessOwners.lastName				✅
businessOwners.phoneNumber				✅
subMerchant.businessContacts.phoneNumberExt				✅
businessContacts.email				✅
businessContacts.faxNumber				✅
businessContacts.type				✅
businessAddresses			✅	✅
businessAddresses.addressLine1			✅	✅
businessAddresses.addressLine2			✅	✅
businessAddresses.city			✅	✅
businessAddresses.state			✅	✅
businessAddresses.country			✅	✅
businessAddresses.postalCode			✅	✅
businessAddresses.postalCodeExtension			✅	✅
businessAddresses.type			✅	✅
businessAcceptedCards	Owner accepted cards		✅	✅
businessAcceptedCards.type	Card type that will be accepted	✅	✅	✅
businessAcceptedCards.attributes	Details of the American Express and Discover (name value pair)	✅	✅	✅
businessBankAccount			✅	✅
businessBankAccount.ddaType				✅
businessBankAccount.achType			✅	✅
businessBankAccount.accountNumber			✅	✅
businessBankAccount.routingNumber			✅	✅

Create Merchant Sample

Request Body

{
  "boardingRefId": "a5812217-2df7-453c-b524-65gebb4fb9e7",
  "tenantProvisioned": true,
  "tenantId": "107",
  "taxId": "343434409",
  "businessLegalName": "Exp LLC w/ 3 Beneficial owners",
  "dbaName": "Exp LLC w/ 3 Beneficial owners",
  "billingDescriptor": "MYP*LLC 3Beneficialowners",
  "businessOwnershipType": "LLC",
  "businessType": "Restaurant",
  "merchantCategoryCode": "7393",
  "businessEstablishedDate": "2015-09-28",
  "businessWebsiteUrl": "www.removeamexoptoutoptionattribute.com",
  "businessAddresses": [
    {
      "type": "Physical",
      "addressLine1": "444 Main St",
      "city": "NoName",
      "state": "CO",
      "country": "US",
      "postalCode": "81601"
    }
  ],
  "businessBankAccount": {
    "accountType": "Checking",
    "achType": "CommercialChecking",
    "accountNumber": "333962222",
    "routingNumber": "102000076"
  },
  "businessOwners": [
    {
      "type": "ControlOwner",
      "title": "Mr",
      "firstName": "Jack",
      "middleInitial": "I",
      "lastName": "Hammer",
      "phoneNumber": "8003459876",
      "phoneNumberExt": "12",
      "email": "[email protected]",
      "ssn": "987934058",
      "dateOfBirth": "1983-09-12",
      "businessOwnershipPercentage": 20,
      "addressLine1": "444 Main St",
      "addressLine2": "Ste 140",
      "city": "Noname",
      "state": "CO",
      "country": "US",
      "postalCode": "81601",
      "postalCodeExtension": "2401",
      "identification": [
        {
          "idType": "DriversLicense",
          "idNumber": "943-9804",
          "issuedState": "CA",
          "issuedCity": "",
          "issuedCountry": "US",
          "dateIssued": "2015-10-10",
          "dateExpires": "2025-10-10"
        }
      ]
    },
    {
      "type": "BeneficialOwner1",
      "title": "Mrs",
      "firstName": "Fay",
      "lastName": "Daway",
      "phoneNumber": "8003459876",
      "businessOwnershipPercentage": 20,
      "email": "[email protected]",
      "addressLine1": "3100 Lone Cone Rd",
      "city": "Norwood",
      "state": "CO",
      "country": "US",
      "postalCode": "81423"
    }
  ],
  "businessContacts": [
    {
      "type":"CustomerService",
      "title": "Ms",
      "firstName": "Donna",
      "lastName": "Bradley",
      "phoneNumber": "8003459800",
      "email": "[email protected]",
      "faxNumber": "9705467851"
    },
    {
      "type": "TerminalDeployment",
      "title": "Mr",
      "firstName": "Peter",
      "lastName": "Parker",
      "phoneNumber": "8003459800",
      "email": "[email protected]"
    }
  ]
}

Response Body

{
    "boardingRefId": "a5812267-2df7-493r-b534-65khpo4fb9e7",
    "tenantId": "107",
    "tenantProvisioned": "true",
    "status": "Pending",
    "createDate": "2022-10-03T16:32:26-07:00",
    "businessAcceptedCards": [
        {
            "type": "Visa",
            "attributes": []
        },
        {
            "type": "MasterCard",
            "attributes": []
        },
        {
            "type": "Discover",
            "attributes": [
                {
                    "name": "Acquired",
                    "value": "Yes"
                },
                {
                    "name": "AccountNumber",
                    "value": "601105107413782"
                }
            ]
        },
        {
            "type": "AmericanExpress",
            "attributes": [
                {
                    "name": "AmexProgram",
                    "value": "OptBlue"
                },
                {
                    "name": "AccountNumber",
                    "value": "3541072468"
                },
                {
                    "name": "ReceiveOptBlueMarketing",
                    "value": "Yes"
                }
            ]
        }
    ]
}

Update Merchant Sample

Request Body

{
    "boardingRefId": "08500ea0-4d11-46d9-9a89-3850ddcd1bd6",
    "tenantId": "107",
    "status": "Pending",
    "createDate": "2022-12-19T17:25:29+00:00",
    "dbaName": "FISTEST& name",
    "billingDescriptor": "AT *LLC 1Beneficial11",
    "businessType": "Retail",
    "businessEstablishedDate": "2015-09-28",
    "businessWebsiteUrl": "https://www.mhhjehdydrgdpwhigawwtiaghuwhkvcudyuwthmfaafzqekytkdeifcaduvzrnde.com",
    "updatedDate": "2023-01-13T00:35:14+00:00",
    "businessAddresses": [
        {
            "type": "Physical",
            "addressLine1": "444 Main St",
            "addressLine2": "444 Main St",
            "city": "Los angeles",
            "state": "CA",
            "country": "US",
            "postalCode": "01601",
            "postalCodeExtension": "1234"
        },
        {
            "type": "TerminalDeployment",
            "addressLine1": "444 Main St",
            "addressLine2": null,
            "city": "NoName",
            "state": "CO",
            "country": "US",
            "postalCode": "81601",
            "postalCodeExtension": null
        }
    ],
    "businessAcceptedCards": [
        {
            "type": "Visa",
            "attributes": []
        },
        {
            "type": "MasterCard",
            "attributes": []
        },
        {
            "type": "Discover",
            "attributes": [
                {
                    "name": "Acquired",
                    "value": "Yes"
                },
                {
                    "name": "AccountNumber",
                    "value": "601105108265439"
                }
            ]
        },
        {
            "type": "AmericanExpress",
            "attributes": [
                {
                    "name": "AmexProgram",
                    "value": "OptBlue"
                },
                {
                    "name": "AccountNumber",
                    "value": "3642009831"
                },
                {
                    "name": "ReceiveOptBlueMarketing",
                    "value": "Yes"
                }
            ]
        }
    ],
    "businessBankAccount": {
        "accountType": "Chequing",
        "achType": "PrivateChequing",
        "accountNumber": "33396111112345678",
        "routingNumber": "102000076"
    },
    "businessOwners": [
        {
            "type": "ControlOwner",
            "title": "MR",
            "firstName": "JackJackJackaa",
            "middleInitial": "I",
            "lastName": "Hammer",
            "phoneNumber": "8003451876",
            "phoneNumberExt": "1123",
            "faxNumber": null,
            "email": "[email protected]",
            "ssn": "987934058",
            "dateOfBirth": "1983-09-12",
            "businessOwnershipPercentage": 5,
            "addressLine1": "900 Parkway",
            "addressLine2": "Ste 140",
            "city": "Noname",
            "state": "CO",
            "country": "US",
            "postalCode": "81601",
            "postalCodeExtension": "1236",
            "identification": [
                {
                    "idType": "DriversLicense",
                    "idNumber": "943-9804",
                    "issuedState": "CA",
                    "issuedCity": "Los Angeles",
                    "issuedCountry": "US",
                    "dateIssued": "2015-10-10",
                    "dateExpires": "2035-10-10"
                }
            ]
        },
        {
            "type": "BeneficialOwner1",
            "title": "Mrs",
            "firstName": "Fay",
            "middleInitial": null,
            "lastName": "Daway",
            "phoneNumber": null,
            "phoneNumberExt": null,
            "faxNumber": null,
            "email": "[email protected]",
            "ssn": null,
            "dateOfBirth": null,
            "businessOwnershipPercentage": 20,
            "addressLine1": "3100 Lone Cone Rd",
            "addressLine2": null,
            "city": "Norwood",
            "state": "CO",
            "country": "US",
            "postalCode": "81423",
            "postalCodeExtension": null,
            "identification": []
        }
    ],
    "businessContacts": [
        {
            "title": null,
            "firstName": "Donna",
            "middleInitial": null,
            "lastName": "Bradley",
            "phoneNumber": "9705467851",
            "phoneNumberExt": null,
            "email": "[email protected]",
            "faxNumber": "9705467851",
            "type": "Primary"
        },
        {
            "title": "Mr",
            "firstName": "Peter",
            "middleInitial": null,
            "lastName": "Parker",
            "phoneNumber": "8003459800",
            "phoneNumberExt": null,
            "email": "[email protected]",
            "faxNumber": null,
            "type": "TerminalDeployment"
        },
        {
            "title": "Mr",
            "firstName": "Peter",
            "middleInitial": "M",
            "lastName": "Service",
            "phoneNumber": "8003459800",
            "phoneNumberExt": "1234",
            "email": "[email protected]",
            "faxNumber": "9705467851",
            "type": "CustomerService"
        }
    ]
}

Response Body

{
    "boardingRefId": "08500ea0-4d11-46d9-9a89-3850ddcd1bd6",
    "tenantId": "107",
    "tenantProvisioned": "true",
    "taxId": "343434987",
    "businessLegalName": "My business ",
    "dbaName": "FISTEST& name",
    "billingDescriptor": "AT *LLC 1Beneficial11",
    "businessOwnershipType": "Trust",
    "businessType": "Retail",
    "merchantCategoryCode": "7991",
    "businessEstablishedDate": "2015-09-28",
    "businessWebsiteUrl": "https://www.mhhjehdydrgdpwhigawwtiaghuwhkvcudyuwthmfaafzqekytkdeifcaduvzrnde.com",
    "businessAddresses": [
        {
            "type": "Physical",
            "addressLine1": "444 Main St ",
            "addressLine2": "444 Main St",
            "city": "Los angeles",
            "state": "CA",
            "country": "US",
            "postalCode": "01601",
            "postalCodeExtension": "1234"
        }
    ],
    "businessBankAccount": {
        "accountType": "Chequing",
        "achType": "PrivateChequing",
        "accountNumber": "33396111112345678",
        "routingNumber": "102000076"
    },
    "businessOwners": [
        {
            "type": "ControlOwner",
            "title": "MR",
            "firstName": "JackJackJackaa",
            "middleInitial": "I",
            "lastName": "Hammer",
            "phoneNumber": "8003451876",
            "phoneNumberExt": "1123",
            "email": "[email protected]",
            "ssn": "987934058",
            "dateOfBirth": "1983-09-12",
            "businessOwnershipPercentage": 5,
            "addressLine1": "900 Parkway",
            "addressLine2": "Ste 140",
            "city": "Noname",
            "state": "CO",
            "country": "US",
            "postalCode": "81601",
            "postalCodeExtension": "1236",
            "identification": [
                {
                    "idType": "DriversLicense",
                    "idNumber": "943-9804",
                    "issuedState": "CA",
                    "issuedCity": "Los Angeles",
                    "issuedCountry": "",
                    "dateIssued": "2015-10-10",
                    "dateExpires": "2035-10-10"
                }
            ]
        }   
    ],
    
    "businessContacts": [
        {
            "type": "CustomerService",
            "title": "Mr",
            "middleInitial": "M",
            "firstName": "Peter ",
            "lastName": "Service",
            "phoneNumber": "8003459800",
            "phoneNumberExt": "1234",
            "email": "[email protected]",
            "faxNumber": "9705467851"
        }
    ]
}

Get Merchant Sample

Response Body

{
  "boardingRefId": "a5911217-2df7-353d-y624-55gebb7fb9e8",
  "status": "Pending",
  "taxId": "343434409",
  "businessLegalName": "Exp LLC w/ 3 Beneficial owners",
  "dbaName": "Exp LLC w/ 3 Beneficial owners",
   "billingDescriptor": "AT *MYP*LLC 3Beneficialowners",
   "businessOwnershipType": "LLC",
   "businessType": "Restaurant",
   "merchantCategoryCode": "7393",
   "businessEstablishedDate": "2015-09-28",
   "businessWebsiteUrl": "www.removeamexoptoutoptionattribute.com",
   "storeNumber": "000000383",
   "createCorrelationId": "7f2341cf-98b5-4c4f-b67c-6880891184f8",
   "businessAddresses": [
       {
           "type": "Physical",
           "addressLine1": "444 Main St",
           "addressLine2": null,
           "city": "NoName",
           "state": "CO",
           "country": "US",
           "postalCode": "81601",
           "postalCodeExtension": null
       }
   ],
   "businessAcceptedCards": [
       {
           "type": "Visa",
           "attributes": []
       },
       {
           "type": "MasterCard",
           "attributes": []
       },
       {
           "type": "Discover",
           "attributes": [
               {
                   "name": "Acquired",
                   "value": "Yes"
               },
               {
                   "name": "AccountNumber",
                   "value": "601105107385428"
               }
           ]
       },
       {
           "type": "AmericanExpress",
           "attributes": [
               {
                   "name": "AmexProgram",
                   "value": "OptBlue"
               },
               {
                   "name": "AccountNumber",
                   "value": "3541072468"
               },
               {
                   "name": "ReceiveOptBlueMarketing",
                   "value": "Yes"
               }
           ]
       }
   ],
   "businessBankAccount": {
       "accountType": "Checking",
       "achType": "CommercialChecking",
       "accountNumber": "333962223",
       "routingNumber": "102000076"
   },
    "businessOwners": [
        {
            "type": "ControlOwner",
            "title": "Mr",
            "firstName": "Jack",
            "middleInitial": "I",
            "lastName": "Hammer",
            "phoneNumber": "8003459876",
            "phoneNumberExt": "12",
            "faxNumber": null,
            "email": "[email protected]",
            "ssn": "987934058",
            "dateOfBirth": "1983-09-12",
            "businessOwnershipPercentage": 20,
            "addressLine1": "444 Main St",
            "addressLine2": "Ste 140",
            "city": "Noname",
            "state": "CO",
            "country": "US",
            "postalCode": "81601",
            "postalCodeExtension": "2401",
            "identification": [
                {
                    "idType": "DriversLicense",
                    "idNumber": "943-9804",
                    "issuedState": "CA",
                    "issuedCity": null,
                    "issuedCountry": "US",
                    "dateIssued": "2015-10-10",
                    "dateExpires": "2025-10-10"
                }
            ]
        }
    ],
    "businessContacts": [
        {
            "title": "Ms",
            "firstName": "Donna",
            "middleInitial": null,
            "lastName": "Bradley",
            "phoneNumber": "8003459800",
            "phoneNumberExt": null,
            "email": "[email protected]",
            "faxNumber": null,
            "type": "Primary"
        }
    ],
    "mid": "4445057059412"
}