Objects Reference
Request/Response Parameters
| Name | Type | Description | ||||||||||||||||
| id | string | Application identifier | ||||||||||||||||
| name | string | Application name | ||||||||||||||||
| templateId | string | Application template identifier | ||||||||||||||||
| status | enum | Application status.
Available Values:
|
||||||||||||||||
| contactEmail | string | Notification target email | ||||||||||||||||
| businessDetails | object | Business details include business general information | ||||||||||||||||
| businessDetailsDocuments | object | Business details documents include business registration documents | ||||||||||||||||
| bankingDetails | object | Banking details include business bank and bank account information | ||||||||||||||||
| bankingDetailsDocuments | object | Banking details documents include business banking documents | ||||||||||||||||
| contactDetails | array | Contact details include business contact information | ||||||||||||||||
| ownerDetails | array | Owner details include business owner information | ||||||||||||||||
| businessProfile | object | Business profile includes information about the nature of a business | ||||||||||||||||
| businessProfileDocuments | object | Business profile documents include PCI compliance certificate | ||||||||||||||||
| businessFinancials | object | Business financials include business payment cards processing projections | ||||||||||||||||
| businessProcessingHistory | object | Business processing history includes historical data about payment card processing |
Business Details
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| businessDetails | object | Business details include business general information
Available Values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Business Documents
| Name | Type | Description | |||||
| registrationСertificate | object | Copy of the registration certificate
Available Values:
|
|||||
| proofOfAddress | object | Proof of address documents
Available Values:
|
|||||
| customDocument1 | object | Applicable in case of Get Application Template
Available Values:
|
|||||
| customDocument1 | object | Applicable in case Get/Create/Update Application
Available Values:
|
|||||
| customDocument2 | object | Applicable in case of Get Application Template
Available Values:
|
|||||
| customDocument2 | object | Applicable in case Get/Create/Update Application
Available Values:
|
|||||
| customDocument3 | object | Applicable in case of Get Application Template
Available Values:
|
|||||
| customDocument3 | object | Applicable in case Get/Create/Update Application
Available Values:
|
|||||
| articleOfIncorporation | object | Article Of Incorporation documents
Available Values:
|
Banking Details
If external bank validation was set up in the Template (External Bank Validation = PLAID) then empty “plaidAccessToken” is received via GET Application method in response instead of “accountNumber”, “accountType”, “accountHolderName”, “entityType”, “routingNumber”, “bankName” parameters If external bank validation was set up in the Template then “plaidAccessToken” is send via CREATE/UPDATE Application method in Request instead of “accountNumber”, “accountType”, “accountHolderName”, “entityType”, “routingNumber”, “bankName” parameters| Name | Type | Description | ||||||||||||
| plaidAccessToken | string | Max length is 255 characters | ||||||||||||
| bankAccount | object | Data object that contains bank account details parameters | ||||||||||||
| billingAddress | object | string with achaccounttype
Available Values:
|
Bank Account
| Name | Type | Description | |||
| accountNumber | string, Max 17, Min 3 | Bank account number | |||
| accountType | enum | String with account type.
Available Values:
|
|||
| accountHolderName | string, Max 120 | Bank account holder’s full name. | |||
| entityType | enum | String with Entity type.
Available Values:
|
|||
| routingNumber | string, Max 9, Min 9 | Bank routing number. | |||
| bankName | string, Max 255 | Bank name. |
Banking Documents
| Name | Type | Description | ||||
| voidCheck | object |
Copy of a void check.
Available Values:
|
||||
| customDocument1 | object | Applicable in case of Get Application Template
Available Values:
|
||||
| customDocument1 | object | Applicable in case Get/Create/Update Application
Available Values:
|
||||
| customDocument2 | object | Applicable in case of Get Application Template
Available Values:
|
||||
| customDocument2 | object | Applicable in case Get/Create/Update Application
Available Values:
|
||||
| customDocument3 | object | Applicable in case of Get Application Template
Available Values:
|
||||
| customDocument3 | object | Applicable in case Get/Create/Update Application
Available Values:
|
Contact Details
| Name | Type | Required | Description | ||||||||||||
| id | integer | ✓ | String with ContactType enumeration value |
||||||||||||
| contactType | enum | conditional | String with ContactType enumeration value
Available Values:
|
||||||||||||
| firstName | string, max 255 | conditional | Contact first name | ||||||||||||
| lastName | string, max 255 | conditional | Contact last name | ||||||||||||
| legalName | string, max 255 | conditional | Contact legal name | ||||||||||||
| string, max 100 | conditional | Contact’s email address Pattern: /^(?=[a-zA-Z0-9])[a-zA-Z0-9.!#$%&’+/=?^_`{|}~-]a-zA-Z0-9@[a-zA-Z0-9-]+(?:.[a-zA-Z0-9-]{2,})$/ | |||||||||||||
| mobilePhone | string, max 50 | conditional | Contact’s mobile phone number Pattern: ^([\+ ]+)?(\d[\d- ]+)?(\([\d- ]+\))?[\d- ]+\d$ | ||||||||||||
| homePhone | string, max 50 | conditional | Contact’s home phone number Pattern: ^([\+ ]+)?(\d[\d- ]+)?(\([\d- ]+\))?[\d- ]+\d$ | ||||||||||||
| address | object | conditional |
Available Values:
|
||||||||||||
| customField1 | object | conditional | Applicable in case of Get Application Template
Available Values:
|
||||||||||||
| customField1 | string | conditional | Applicable in case Get/Create/Update Application | ||||||||||||
| customField2 | object | conditional | Applicable in case of Get Application Template
Available Values:
|
||||||||||||
| customField2 | string | conditional | Applicable in case Get/Create/Update Application | ||||||||||||
| customField3 | object | conditional | Applicable in case of Get Application Template
Available Values:
|
||||||||||||
| customField3 | string | conditional | Applicable in case Get/Create/Update Application |
Owner Details
| Name | Type | Required | Description | ||||||||||||
| id | integer | ✓ | Parameter is used only for GET and UPDATE Application model | ||||||||||||
| firstName | string, max 255 | conditional | Business owner first name | ||||||||||||
| lastName | string, max 255 | conditional | Business owner last name | ||||||||||||
| idNumber | string, max 255 | conditional | Business owner identification document number | ||||||||||||
| giin | string | conditional | 1st and 2nd part Numbers and uppercase letters only 3rd – Uppercase letters only 4th – Numbers only Entered value must not contain spaces length can not be more than 19 characters | ||||||||||||
| string, max 100 | conditional | Business owner email address. Pattern: /^(?=[a-zA-Z0-9])[a-zA-Z0-9.!#$%&’+/=?^_`{|}~-]a-zA-Z0-9@[a-zA-Z0-9-]+(?:.[a-zA-Z0-9-]{2,})$/ | |||||||||||||
| mobilePhone | string, max 50 | conditional | Business owner mobile phone number. Pattern: ^([\+ ]+)?(\d[\d- ]+)?(\([\d- ]+\))?[\d- ]+\d$ | ||||||||||||
| homePhone | string, max 50 | conditional | Business owner home phone number. Pattern: ^([\+ ]+)?(\d[\d- ]+)?(\([\d- ]+\))?[\d- ]+\d$ | ||||||||||||
| address | object | conditional |
Available Values:
|
||||||||||||
| dateOfBirth | datetime | conditional | Business owner date of birth. | ||||||||||||
| position | string, max 255 | conditional | Business owner position. | ||||||||||||
| citizenShip | string, max 255 | conditional | Business owner citizenship. | ||||||||||||
| ownerShipDate | datetime | conditional | Ownership official date. | ||||||||||||
| ownershipPercentage | integer, max 100 | conditional | Business owner share of ownership in %. | ||||||||||||
| driversLicenceNumber | string | conditional | Business owner drivers license number. | ||||||||||||
| driversLicenceCountry | string | conditional | Required in case Mastercard MATCH validation is enabled. Else optional Country value should be in the list of available countries. | ||||||||||||
| driversLicenceState | string | conditional | Required in case Mastercard MATCH validation is enabled and “driversLicenceCountry” = “US” or “CA” or “AU”. Length can not be more than 3 characters | ||||||||||||
| customField1 | object | conditional | Applicable in case of Get Application Template
Available Values:
|
||||||||||||
| customField1 | string | conditional | Applicable in case Get/Create/Update Application | ||||||||||||
| customField2 | object | conditional | Applicable in case of Get Application Template
Available Values:
|
||||||||||||
| customField2 | string | conditional | Applicable in case Get/Create/Update Application | ||||||||||||
| customField3 | object | conditional | Applicable in case of Get Application Template
Available Values:
|
||||||||||||
| customField3 | string | conditional | Applicable in case Get/Create/Update Application | ||||||||||||
| сontrolProng | boolean | conditional | Control Prong. | ||||||||||||
| ownerDetailsDocuments | object | conditional | Owner details documents include documents provided by the business owner. |
Owner Documents
| Name | Type | Description | ||||
| proofOfId | object | Copy of an identification document of the business owner.
Available Values:
|
||||
| proofOfAddress | object | Copy of a document that can prove the business owner residence address.
Available Values:
|
||||
| personalGuarantee | object | Copy of a document that can serve as the business owner personal guarantee.
Available Values:
|
||||
| customDocument1 | object | Applicable in case of Get Application Template
Available Values:
|
||||
| customDocument1 | object | Applicable in case Get/Create/Update Application
Available Values:
|
||||
| customDocument2 | object | Applicable in case of Get Application Template
Available Values:
|
||||
| customDocument2 | object | Applicable in case Get/Create/Update Application
Available Values:
|
||||
| customDocument3 | object | Applicable in case of Get Application Template
Available Values:
|
||||
| customDocument3 | object | Applicable in case Get/Create/Update Application
Available Values:
|
||||
| driversLicenseFront | object | Copy of the Driver License document. Front side of the document.
Available Values:
|
||||
| driversLicenseBack | object | Copy of the Driver License document. Back side of the document.
Available Values:
|
Business Profile
| Name | Type | Description | ||||||||||||||||||||
| industry | enum | String with IndustryType enumeration value.
Available Values:
|
||||||||||||||||||||
| category | enum | String with the CategoryType enumeration value.
Available Values:
|
||||||||||||||||||||
| privacyPolicyURL | string, max 255 | Business privacy policy URL. Pattern: ^(https?:[\/]{2})(www.)?[a-zA-Z0-9@:%._\+~#=\-]{2,256}\.[a-z]{2,6}\b([a-zA-Z0-9@:%_\+.~#?&/=\-]*)$ | ||||||||||||||||||||
| returnsPolicyURL | string, max 255 | Business return policy URL. Pattern: ^(https?:[\/]{2})(www.)?[a-zA-Z0-9@:%._\+~#=\-]{2,256}\.[a-z]{2,6}\b([a-zA-Z0-9@:%_\+.~#?&/=\-]*)$ | ||||||||||||||||||||
| tcPolicyURL | string, max 255 | Business terms and conditions policy URL. Pattern: ^(https?:[\/]{2})(www.)?[a-zA-Z0-9@:%._\+~#=\-]{2,256}\.[a-z]{2,6}\b([a-zA-Z0-9@:%_\+.~#?&/=\-]*)$ | ||||||||||||||||||||
| gstExempt | boolean | Business goods and services tax exempt. | ||||||||||||||||||||
| gstNumber | string, max 255 | Business goods and services tax exempt number. In case gstExempt = ‘true’ gstNumber is required In case gstExempt = ‘false’ gstNumber should be null | ||||||||||||||||||||
| descriptionOfGoods | string, max 4000 | Description of goods and services. | ||||||||||||||||||||
| mccCode | string, max 255 | MCC code. | ||||||||||||||||||||
| seasonalBusiness | boolean | Business seasonal nature. | ||||||||||||||||||||
| seasonalBusinessMonths | array | Array with Seasonal business Months. Available values: January, February, March, April, May, June, July, August, September, October, November, December | ||||||||||||||||||||
| processingMethods | object | Processing Methods details.
Available Values:
|
||||||||||||||||||||
| merchantBillingType | enum | Merchant Billing Type details.
|
||||||||||||||||||||
| merchantPricingModel | enum | Merchant Pricing Model details.
Available Values:
|
||||||||||||||||||||
| saleChannels | array | Business sales channels details.
Available Values:
|
||||||||||||||||||||
| shipping | object | Business shipping details.
Available Values:
|
||||||||||||||||||||
| customField1 | object | applicable in case of get application template
Available Values:
|
||||||||||||||||||||
| customField1 | string | Applicable in case get/create/update application | ||||||||||||||||||||
| customField2 | object | applicable in case of get application template
Available Values:
|
||||||||||||||||||||
| customField2 | string | Applicable in case get/create/update application | ||||||||||||||||||||
| customField3 | object | Applicable in case of get application template
Available Values:
|
||||||||||||||||||||
| customField3 | string | Applicable in case get/create/update application |
Business Profile Documents
| Name | Type | Description | ||||
| pciCertificate | object | Copy of the PCI certificate.
Available Values:
|
||||
| customDocument1 | object | Applicable in case of Get Application Template
Available Values:
|
||||
| customDocument1 | object | Applicable in case Get/Create/Update Application
Available Values:
|
||||
| customDocument2 | object | Applicable in case of Get Application Template
Available Values:
|
||||
| customDocument2 | object | Applicable in case Get/Create/Update Application
Available Values:
|
||||
| customDocument3 | object | Applicable in case of Get Application Template
Available Values:
|
||||
| customDocument3 | object | Applicable in case Get/Create/Update Application
Available Values:
|
Business Financials
| Name | Type | Description | |||||
| volumeProjectionVisa | object | Data object that contains parameters with volume Projection.
|
|||||
| avgTicketPriceProjection | string | Projection of an average ticket price. Available symbols: 0-9, ‘.’ Format:Up to 18 digits – main part, Up to 2 digits – decimal part Regex:^(?:(?:[1-9]\d{0,17})|0)(?:\.\d{1,2})?$ | |||||
| annualVolumeProjection | object | Data object that contains parameters with annual volume Projection. | |||||
| monthlyVolumeProjection | object | Data object that contains parameters with monthly volume Projection. | |||||
| highestTicketPriceProjection | string | Projection of the highest ticket price. Available symbols: 0-9, ‘.’ Format:Up to 18 digits – main part, Up to 2 digits – decimal part Regex:^(?:(?:[1-9]\d{0,17})|0)(?:\.\d{1,2})?$ | |||||
| isAnnualAmexVolumeExceedMillionDollars | boolean | Is annual Amex volume exceeds 1Million?
|
|||||
| customField1 | object | Applicable in case of Get Application Template
Available Values:
|
|||||
| customField1 | string | Applicable in case Get/Create/Update Application | |||||
| customField2 | object | Applicable in case of Get Application Template
Available Values:
|
|||||
| customField2 | string | Applicable in case Get/Create/Update Application | |||||
| customField3 | object | Applicable in case of Get Application Template
Available Values:
|
|||||
| customField3 | string | Applicable in case Get/Create/Update Application |
Business Processing History
| Name | Type | Description | |||||
| volumeHistory | object | Data object that contains parameters with volume history.
|
|||||
| avgTicketPriceHistory | string | History of an average ticket price. Available symbols: 0-9, ‘.’ Format:Up to 18 digits – main part, Up to 2 digits – decimal part Regex:^(?:(?:[1-9]\d{0,17})|0)(?:\.\d{1,2})?$ | |||||
| monthlyVolumeHistory | object | Data object that contains parameters with volume history. | |||||
| annualVolumeHistory | object | Data object that contains parameters with volume history. | |||||
| highestTicketPriceHistory | string | History of the highest ticket price. Available symbols: 0-9, ‘.’ Format:Up to 18 digits – main part, Up to 2 digits – decimal part Regex:^(?:(?:[1-9]\d{0,17})|0)(?:\.\d{1,2})?$ | |||||
| previousBankruptcy | boolean | Business bankruptcy. | |||||
| previousPersonalBankruptcy | boolean | Previous Personal bankruptcy. | |||||
| customField1 | object | Applicable in case of Get Application Template
Available Values:
|
|||||
| customField1 | string | Applicable in case Get/Create/Update Application | |||||
| customField2 | object | Applicable in case of Get Application Template
Available Values:
|
|||||
| customField2 | string | Applicable in case Get/Create/Update Application | |||||
| customField3 | object | Applicable in case of Get Application Template
Available Values:
|
|||||
| customField3 | string | Applicable in case Get/Create/Update Application |
{
"name": "string",
"templateId": 0,
"contactEmail": "string",
"applicationBody": {
"businessDetails": {
"name": "string",
"legalName": "string",
"registrationNumber": "string",
"ownershipType": "Individual",
"taxId": "string",
"giin": "string",
"incorporationDate": "2022-05-16T12:44:22.835Z",
"businessAddress": {
"street": "string",
"apartment": "string",
"city": "string",
"country": "string",
"stateCode": "string",
"zip": "string"
},
"corporateAddress": {
"street": "string",
"apartment": "string",
"city": "string",
"country": "string",
"stateCode": "string",
"zip": "string"
},
"companyWebsiteUrl": "string",
"dbaName": "string",
"dbaWebsiteUrl": "string",
"dynamicDescriptor": "string",
"description": "string",
"customerServicePhone": "string",
"customerServiceEmail": "string",
"fax": "string",
"socialMediaAccounts": [
{
"socialNetwork": "Facebook",
"accountName": "string"
}
],
"agreement": true,
"customField1": "string",
"customField2": "string",
"customField3": "string",
"phoneNumber": "string",
"emailAddressForNotices": "string",
"numberOfLocations": 0,
"numberOfOutlets": 0
},
"businessDetailsDocuments": {
"registrationCertificate": {
"fileName": "string",
"fileBody": "string"
},
"proofOfAddress": {
"fileName": "string",
"fileBody": "string"
},
"customDocument1": {
"fileName": "string",
"fileBody": "string"
},
"customDocument2": {
"fileName": "string",
"fileBody": "string"
},
"customDocument3": {
"fileName": "string",
"fileBody": "string"
},
"articleOfIncorporation": {
"fileName": "string",
"fileBody": "string"
}
},
"bankingDetails": {
"bankAccount": {
"accountNumber": "string",
"accountType": "Savings",
"accountHolderName": "string",
"entityType": "Personal",
"routingNumber": "string",
"bankName": "string"
},
"billingAddress": {
"country": "US",
"stateCode": "NY",
"apartment":"25, 90503"
"street": "667 Madison Avenue, Upper East Side",
"city": "New York",
"zip": "10065"
}
},
"bankingDetailsDocuments": {
"voidCheck": {
"fileName": "string",
"fileBody": "string"
},
"customDocument1": {
"fileName": "string",
"fileBody": "string"
},
"customDocument2": {
"fileName": "string",
"fileBody": "string"
},
"customDocument3": {
"fileName": "string",
"fileBody": "string"
}
},
"contactDetails": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"contactType": "Statements",
"firstName": "string",
"lastName": "string",
"legalName": "string",
"email": "string",
"mobilePhone": "string",
"homePhone": "string",
"address": {
"street": "string",
"apartment": "string",
"city": "string",
"country": "string",
"stateCode": "string",
"zip": "string"
},
"customField1": "string",
"customField2": "string",
"customField3": "string"
}
],
"ownerDetails": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"firstName": "string",
"lastName": "string",
"idNumber": "string",
"giin": "string",
"email": "string",
"mobilePhone": "string",
"homePhone": "string",
"address": {
"street": "string",
"apartment": "string",
"city": "string",
"country": "string",
"stateCode": "string",
"zip": "string"
},
"dateOfBirth": "2022-05-16T12:44:22.835Z",
"position": "string",
"citizenship": "string",
"ownershipDate": "2022-05-16T12:44:22.835Z",
"ownershipPercentage": 0,
"driversLicenceNumber": "string",
"driversLicenceCountry": "string",
"driversLicenceState": "string",
"customField1": "string",
"customField2": "string",
"customField3": "string",
"controlProng": true,
"ownerDetailsDocuments": {
"proofOfId": {
"fileName": "string",
"fileBody": "string"
},
"proofOfAddress": {
"fileName": "string",
"fileBody": "string"
},
"personalGuarantee": {
"fileName": "string",
"fileBody": "string"
},
"customDocument1": {
"fileName": "string",
"fileBody": "string"
},
"customDocument2": {
"fileName": "string",
"fileBody": "string"
},
"customDocument3": {
"fileName": "string",
"fileBody": "string"
},
"driversLicenseFront": {
"fileName": "string",
"fileBody": "string"
},
"driversLicenseBack": {
"fileName": "string",
"fileBody": "string"
}
}
}
],
"businessProfile": {
"industry": "InformationTechnology",
"category": "Retail",
"privacyPolicyUrl": "string",
"returnsPolicyUrl": "string",
"tcPolicyUrl": "string",
"gstExempt": true,
"gstNumber": "string",
"descriptionOfGoods": "string",
"saleChannels": [
{
"channelType": "string",
"percentageOfSales": 0
}
],
"shipping": {
"shippingRequired": true,
"inventory": true,
"deliveryTimePercentage": {
"oneToSevenDays": 0,
"eightToFourteenDays": 0,
"fifteenToThirtyDays": 0,
"moreThanThirtyDays": 0
}
},
"pciCompliance": {
"isEnabled": true,
"pciLevel": "DssLevelOne",
"storesSensitiveData": true,
"dataCompromised": true
},
"customField1": "string",
"customField2": "string",
"customField3": "string",
"mccCode": "string",
"seasonalBusiness": true,
"seasonalBusinessMonths": ["January"],
"processingMethods": {
"deviceTerminal": 0,
"moTo": 0,
"online": 0
},
"merchantBillingType": "Debit",
"merchantPricingModel": "DailyDiscount"
},
"businessProfileDocuments": {
"pciCertificate": {
"fileName": "string",
"fileBody": "string"
},
"customDocument1": {
"fileName": "string",
"fileBody": "string"
},
"customDocument2": {
"fileName": "string",
"fileBody": "string"
},
"customDocument3": {
"fileName": "string",
"fileBody": "string"
}
},
"businessFinancials": {
"volumeProjection": {
"visa": "string",
"mastercard": "string",
"americanExpress": "string",
"localDebitCard": "string",
"discover": "string"
},
"avgTicketPriceProjection": "string",
"customField1": "string",
"customField2": "string",
"customField3": "string",
"annualVolumeProjection": {
"visa": "string",
"mastercard": "string",
"americanExpress": "string",
"localDebitCard": "string",
"discover": "string"
},
"monthlyVolumeProjection": {
"visa": "string",
"mastercard": "string",
"americanExpress": "string",
"localDebitCard": "string",
"discover": "string"
},
"highestTicketPriceProjection": "string",
"isAnnualAmexVolumeExceedMillionDollars": true
},
"businessProcessingHistory": {
"volumeHistory": {
"visa": "string",
"mastercard": "string",
"americanExpress": "string",
"localDebitCard": "string",
"discover": "string"
},
"avgTicketPriceHistory": "string",
"previousBankruptcy": true,
"customField1": "string",
"customField2": "string",
"customField3": "string",
"monthlyVolumeHistory": {
"visa": "string",
"mastercard": "string",
"americanExpress": "string",
"localDebitCard": "string",
"discover": "string"
},
"annualVolumeHistory": {
"visa": "string",
"mastercard": "string",
"americanExpress": "string",
"localDebitCard": "string",
"discover": "string"
},
"highestTicketPriceHistory": "string",
"previousPersonalBankruptcy": true
}
}
}