Application section criteria

Get valid criteria for a given SectionName

POST https://<PayEngine-host>/onboarding/criteria

This method should be considered extremely valuable in that it always provides the current validation criteria for the given section. Allowing the corresponding User Interface screen to be built/rendered with an accurate set of valid requirements (which are subject to change without notice, due to the dynamic integration with live business data).

Request Body

Name	Type	Description
section*	string	The section name is one of the following: business_information, business_information_address, owner_officer, processing_information, fee_schedule
property*	string	Optional property in case you want to get valid criteria for an individual field.

200

{
    "error": false,
    "data": {
        "RT": "Retail",
        "RTIP": "Retail with Tips",
        "DN": "Restaurant",
        "MP": "MOTO",
        "IN": "Internet",
        "LD": "Lodging",
        "SMK": "Supermarket",
        "UTIL": "Utility",
        "PHA": "Pharmacy",
        "FI": "Financial Institution",
        "BB": "Business to Business"
    }
}

Raw Body

{
  "section": "business_information",
  "property": "business_type"
}

Node.js

var axios = require('axios');
var data = JSON.stringify({"section":"business_information","property":""});

var config = {
  method: 'post',
  url: 'https://{{hostname}}/api/onboarding/criteria',
  headers: { 
    'accept': 'application/json', 
    'Authorization': 'Basic {{YOUR_API_SECRET}}', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Possible Field Definition Table

Section	Property	Description
business_information	business_type business_category mccsic type_of_tax	Business information
bank_information	type_of_account
processing_information	qualified_processing
owner_officer	country_of_issuance title	Owner information