Appendices

Payload Data Specifications link

 

Data fields are listed in the JSON Sections (groups) to make it convenient for you to find the fields you require. Within the group, the fields are listed in alphabetical order.

The appendix lists the following information for each data field.

 

Column Contents
Section The JSON group that contains this data field
Required

YES: A value for the data field is required and you must supply it.

NO: A value for the data field is not required and you do not have to supply it

Definition The description, meaning, and/or use of the field
Type The data type expected (Date, Decimal, Multiple, Text, Phone, Yes/No)
Max Size When present, the maximum number of characters allowed
Allowed Values When present, the list of the exact values that this field may contain

 

 

 

DATA TYPE

Description

Examples

Date

The day of the year in the format YYYY-MM-DD.

1981-01-03, 2018-09-14

Decimal

A number with digits placed to the left and right of a decimal point

45.6, 145.78, 12.0

Multiple

Any number of the Allowed Values can be used.

September, October, November, December, January, February, March, April, May, June, July, August

Text

Human-readable sequences of characters and the words they form.

19245 W. 100th Street, Ralph Oscar, Montreal, Cost Plus

Phone

The digits of the phone number.

8888375309, 9012012211

Yes/No

A field that allows only two values Yes or No.

Yes, No

 

 

 

The data required in the OwnersOrOfficers section varies by the type of business. Therefore, this section requires special attention as there are numerous conditional fields.

Types of business include Sole Proprietorship, Corporation, Government, Limited Liability Company, Partnership, or Not for Profit. 

The file attached lists the Data Definitions in the first tab.

Subsequent tabs outline the required fields for each type of business.

  • If the field is required, it will state Required.
  • If the field is not required, it will be blank.
  • If there is a specified value for the field, the value will appear in the field.

 

The AppLink Web API returns standard HTTP Status Codes. 

 

Status Description
200s - OK Successful
400 - Bad Request The request was unsuccessful, often due to missing a required parameter.
401 - Unauthorized Incorrect API_key provided
402 - Request Failed The parameters were valid, but the request failed.
404 - Not Found The requested resource doesn't exist.
409 - Conflict The request conflicts with another request.
429 - Too Many Requests

Too many requests hit the API simultaneously.

500, 502, 503, 504 - Server Errors Something went wrong on the server.

 

NOTE:
Data fields that are conditionally required (required only if another data field has a certain value) are not listed in Appendix 1.

Sample Payloads link

The following are some examples of JSON payloads associated with merchants with the different ownership structures.

 

 

Payload Example: Sole Proprietorship link

JSON
{ "MerchantBusinessInformation": { "LegalName": "AppLink API Test US", "CorporateAddressCivicNum": "123", "CorporateAddressStreet": "Main Street", "CorporateAddressPobox": "12345", "CorporateAddressUnitDesignator": "Unit", "CorporateAddressUnit": "1", "CorporateCity": "Austin", "CorporateState": "TX", "CorporateZip": "78758", "CorporateTelephone": "1234567890", "FederalTaxId": "900680910", "BusinessEmail": "test@ppi.me", "BusinessPresence": "10_years", "BusinessPresenceMonths": "5", "MailingAddress": "Corporate_Address", "SupportLine": "1234567890", "StatementDescriptor": "AppLink API Test US", "MailingAttention": "John Doe", "PrefContactEmail": "test@ppi.me", "PrefContactPhone": "1234567890" }, "DbaInformation": { "DbaName": "AppLink API Test US", "LocationAddressCivicNum": "123", "LocationAddressStreet": "Main Street", "LocationAddressUnitDesignator": "Unit", "LocationAddressUnit": "1", "LocationCity": "Austin", "LocationState": "TX", "LocationZip": "78758", "LocationTelephone": "5124567890" }, "OwnersOrOfficers": { "OwnerCitizenship": "US", "OwnerCountry": "US", "BusinessStartupDate": "01/01/2006", "OwnerList": [{ "Guarantor": true, "Title": "Owner", "Email": "test@ppi.me", "PercentOwnership": 100, "FirstName": "John", "LastName": "Doe", "Birthday": "01/01/1980", "ResidenceAddressCivicNum": "123", "ResidenceAddressStreet": "Main Street", "ResidenceAddressUnitDesignator": "Unit", "ResidenceAddressUnit": "1", "City": "Austin", "State": "TX", "Zip": "78758", "Telephone": "1234567890", "SocialSecurity": "123456789" }] }, "ContractVersionEtf": { "MerchantSignDate": "01/01/2017" }, "BankInformation": { "BankTransit": "011601029", "BankDda": "12345678" }, "Agent": "Test Agent", "Office": "Test Agent US" }

Payload Example: Corporation link

JSON
{ "MerchantBusinessInformation": { "LegalName": "AppLink API Test US", "CorporateAddressCivicNum": "123", "CorporateAddressStreet": "Main Street", "CorporateAddressPobox": "12345", "CorporateAddressUnitDesignator": "Unit", "CorporateAddressUnit": "1", "CorporateCity": "Austin", "CorporateState": "TX", "CorporateZip": "78758", "CorporateTelephone": "1234567890", "FederalTaxId": "900680910", "BusinessEmail": "test@ppi.me", "BusinessPresence": "10_years", "BusinessPresenceMonths": "5", "MailingAddress": "Corporate_Address", "SupportLine": "1234567890", "StatementDescriptor": "AppLink API Test US", "MailingAttention": "John Doe", "PrefContactEmail": "test@ppi.me", "PrefContactPhone": "1234567890" }

Payload Example: Government link

JSON
{ "MerchantBusinessInformation": { "LegalName": "AppLink API Test US", "CorporateAddressCivicNum": "123", "CorporateAddressStreet": "Main Street", "CorporateAddressPobox": "12345", "CorporateAddressUnitDesignator": "Unit", "CorporateAddressUnit": "1", "CorporateCity": "Austin", "CorporateState": "TX", "CorporateZip": "78758", "CorporateTelephone": "1234567890", "FederalTaxId": "900680910", "BusinessEmail": "test@ppi.me", "BusinessPresence": "10_years", "BusinessPresenceMonths": "5", "MailingAddress": "Corporate_Address", "SupportLine": "1234567890", "StatementDescriptor": "AppLink API Test US", "MailingAttention": "John Doe", "PrefContactEmail": "test@ppi.me", "PrefContactPhone": "1234567890" }

Payload Example: Limited Liability Company (LLC) link

JSON
{ "MerchantBusinessInformation": { "LegalName": "AppLink API Test US", "CorporateAddressCivicNum": "123", "CorporateAddressStreet": "Main Street", "CorporateAddressPobox": "12345", "CorporateAddressUnitDesignator": "Unit", "CorporateAddressUnit": "1", "CorporateCity": "Austin", "CorporateState": "TX", "CorporateZip": "78758", "CorporateTelephone": "1234567890", "FederalTaxId": "900680910", "BusinessEmail": "test@ppi.me", "BusinessPresence": "10_years", "BusinessPresenceMonths": "5", "MailingAddress": "Corporate_Address", "SupportLine": "1234567890", "StatementDescriptor": "AppLink API Test US", "MailingAttention": "John Doe", "PrefContactEmail": "test@ppi.me", "PrefContactPhone": "1234567890" }

Payload Example: Partnership link

JSON
{ "MerchantBusinessInformation": { "LegalName": "AppLink API Test US", "CorporateAddressCivicNum": "123", "CorporateAddressStreet": "Main Street", "CorporateAddressPobox": "12345", "CorporateAddressUnitDesignator": "Unit", "CorporateAddressUnit": "1", "CorporateCity": "Austin", "CorporateState": "TX", "CorporateZip": "78758", "CorporateTelephone": "1234567890", "FederalTaxId": "900680910", "BusinessEmail": "test@ppi.me", "BusinessPresence": "10_years", "BusinessPresenceMonths": "5", "MailingAddress": "Corporate_Address", "SupportLine": "1234567890", "StatementDescriptor": "AppLink API Test US", "MailingAttention": "John Doe", "PrefContactEmail": "test@ppi.me", "PrefContactPhone": "1234567890" }

Payload Example: Not for Profit link

JSON
{ "MerchantBusinessInformation": { "LegalName": "AppLink API Test US", "CorporateAddressCivicNum": "123", "CorporateAddressStreet": "Main Street", "CorporateAddressPobox": "12345", "CorporateAddressUnitDesignator": "Unit", "CorporateAddressUnit": "1", "CorporateCity": "Austin", "CorporateState": "TX", "CorporateZip": "78758", "CorporateTelephone": "1234567890", "FederalTaxId": "900680910", "BusinessEmail": "test@ppi.me", "BusinessPresence": "10_years", "BusinessPresenceMonths": "5", "MailingAddress": "Corporate_Address", "SupportLine": "1234567890", "StatementDescriptor": "AppLink API Test US", "MailingAttention": "John Doe", "PrefContactEmail": "test@ppi.me", "PrefContactPhone": "1234567890" }

Need Help?

How can we help you today?  Our team is standing by and just a click away.