Using an Invite Code

To Use an Invite Code:

An Invite Code serves one major purpose (determining the merchant's rates, fees, Portfolio, Sales Agent, etc.) but can be used two different ways. To submit merchant details through the Boarding API on the QuickStart program. Or, by giving the prospective merchant an Invite Code along with a URL to MX™ Merchant.

Using an Invite Code through the Boarding API:

Simply submit the Invite Code in your payload with the new merchant information. Use this method when more integration has been done to your website to accept the required data fields.

Follow the instructions above to create an Invite Code in MX™ ISOAgent and include that Invite Code in the inviteCode parameter. If the payload includes the inviteCode parameter, the API validation will be trimmed down from the normal required fields. The example below contains all the information that can be submitted in the payload to board a QuickStart merchant with the required fields indicated. If any of the non-required fields are submitted, MX™ ISOAgent will be populated with those values. If those non-required fields are not submitted, default values will be populated in MX™ ISOAgent. Values submitted in the payload that are already included in the Invite Code will be ignored.

Example Request:

POST https://api.mxisoagent.com/boarding/v2/merchant HTTP/1.1
        Accept: application/json
        Authorization: OAuth oauth_consumer_key="yourKey",oauth_token="xxxxxxxxxxxxx",
                        oauth_timestamp="1379952200.7666",oauth_nonce="xxxxxxxxxxxxx",
                        oauth_signature="xxxxxxxxxxxxx",oauth_signature_method="HMAC-SHA1",oauth_version="1.0"
        Content-Type: application/json; charset=utf-8
        Host: api.mxisoagent.com
        Content-Length: 1561
        Expect: 100-continue
        {
            "inviteCode":"TZS4-BEH8-R7VS",
            "referenceId":"15bb9b53-8b55-47e58082",
     *      "category":"5172",
     *      "businessType":4,
            "website":"www.test.com",
            "sells":"website hosting",
            "returnPolicy":"Web space",
            "delivery":1,
     *      "swipedPercent":0,
     *      "legalName":"Webhost Test",
     *      "legalAddress":"2001 website pkwy",
     *      "legalCity":"Milton",
     *      "legalState":"GA",
     *      "legalZip":"30004",
     *      "legalPhone":"7701234567",
     *      "legalCorporationType":4,
            "legalCorporationDate":"2000-01-01T00:00:00",
     *      "taxIdType":0,
     *      "taxId":"000000001",
     *      "taxName":"Tax Name",
     *      "taxState":"NY",
     *      "owner":[{
                    "id":0,
             *      "name":"test test",
             *      "ssn":"123556889",
                    "dob":"1980-02-02T00:00:00",
             *      "ownership":50.0,
             *      "phone":"7701234567",
                    "cell":"7701234567",
             *      "email":"[email protected]",
             *      "street":" first 123 street",
             *      "city":"Milton",
             *      "state":"GA",
             *      "zipCode":"30005"}],
     *      "locationName":"Webhost Test",
     *      "locationAddress":"2001 website pkwy",
     *      "locationCity":"Milton",
     *      "locationState":"GA",
     *      "locationZip":"30005",
     *      "locationPhone":"4045689321",
            "locationFax":"4045689322",
     *      "statementName":"Statement Name",
            "statementPhone":"8002357894",
            "fundingAccount":[{
             *      "name":"Test Bank Name",
             *      "routingNumber":"987654321",
             *      "accountNumber":"979879878978",
             *      "accountType":1,
             *      "achMethod":2,
             *      "discountPaid":2,
                    "bankingRoutingID":0,
                    "address":"123 Bank Street",
                    "city":"bankCity",
                    "stateCode":"BS",
                    "zipcode":"123456",
                    "zipcodeExtension":null,
                    "telephone":"3333333333"}],
            "processor":0,
            "portfolio":null,
            "program":null,
            "tags": null,
            "compLabel":null
            "initiatorMeta":null
        }

Additional fields returned in GET

"id",
            "xmid",
            "appId",
            "dateAdded",
            "dateApproved",
            "dateClosed",
            "status",
            "fundingDelayDays",
            "fundingDailyMax",
            "fundingMonthlyMax",
            "fundingTransactionMax",
            "fundingOnHold",
            "statusReason"