Parameter Validations - POS API
- PC (Unlicensed)
Validation Overview
Validation Type | Scenario |
|---|---|
required | Mandatory parameter not sent in the request |
invalid | Wrong format |
type | Mismatch data type |
length | Data length exceeded |
Where we validate specific characters, a Regex is provided.
Parameter Validations
account_number
Case | Error Type |
Value zero or negative. | invalid |
Value with decimals. | invalid |
Value with higher precision | length |
Not sent | required |
Value different to a number. | type |
account_type
Case | Error Type |
Value with higher length | length |
Value different to a string. | type |
Value different to available values | invalid |
address_1
Case | Error Type |
Value with higher length | length |
Value different to a string. | type |
Not sent | required |
address_2
Case | Error Type |
Value with higher length | length |
Value different to a string. | type |
Not sent | required |
amount
Case | Error Type |
Value different to a number. | type |
Decimal point different to period. | invalid |
Value zero or negative. | invalid |
Value with higher precision and/or scale | length |
Not sent | required |
amount_requested
Case | Error Type |
Decimal point different to period. | invalid |
Value zero or negative. | invalid |
Value with higher precision and/or scale | length |
Value different to a number. | type |
authorization
Case | Error Type |
Value not started with "Bearer" followed by a space | invalid |
Token length different to 1000 characters | invalid |
Token not valid. | invalid |
Token expired. | invalid |
Not sent | required |
authorization_id
Case | Error Type |
Value different to a number | invalid |
Not sent | required |
auto_capture
Case | Error Type |
Different to the available values. | invalid |
business_address_1
Case | Error Type |
Value with higher length | length |
Not sent | required |
Value different to a string | type |
business_address_2
Case | Error Type |
Value with higher length | length |
Not sent | required |
Value different to a string. | type |
business_city
Case | Error Type |
Value with higher length | length |
Not sent | required |
Value different to a string. | type |
business_name
Case | Error Type |
Value with higher length | length |
Not sent | required |
Value different to a string. | type |
business_postal_code
Case | Error Type |
Value with higher length | length |
Not sent | required |
Value different to a string. | type |
business_phone
Case | Error Type |
Value with higher precision | length |
Not sent | required |
Value different to a number. | type |
Regex | /^(?([0-9]{3}))?[-. ]?([0-9]{3})[-. ]?([0-9]{4})/ |
business_province
Case | Error Type |
Different to the available values. | invalid |
Not sent | required |
Value different to a string. | type |
capture_id
Case | Error Type |
Client not valid. | invalid |
Not sent | required |
city
Case | Error Type |
Value with higher length | length |
Not sent | required |
Value different to a string. | type |
client_id
Case | Error Type |
Client ID not valid | invalid |
Not sent | required |
client_secret
Case | Error Type |
Value with higher length | length |
Not sent | required |
customer_id
Case | Error Type |
Value zero or negative. | invalid |
Value with decimals. | invalid |
Value with higher precision | length |
Not sent | required |
Value different to a number. | type |
date
Case | Error Type |
Value with wrong format | invalid |
dob
Case | Error Type |
Value with wrong format | invalid |
Not sent | required |
Regex | /([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))/ |
Case | Error Type |
Value with wrong format | invalid |
Not sent | required |
employer_name
Case | Error Type |
Value with wrong format | invalid |
employer_phone
Case | Error Type |
Value with wrong format | invalid |
Regex | /^(?([0-9]{3}))?[-. ]?([0-9]{3})[-. ]?([0-9]{4})/ |
ending_date
Case | Error Type |
Value with wrong format | invalid |
first_name
Case | Error Type |
Value with higher length | length |
Not sent | required |
Value different to a string. | type |
full_release
Case | Error Type |
Different to the available values. | invalid |
full_return
Case | Error Type |
Different to the available values. | invalid |
govid_expiry
Case | Error Type |
Value with wrong format | invalid |
Value with a date less than the current date | invalid |
Not sent | required |
govid_issuedby
Case | Error Type |
Different to the available values. | invalid |
Not sent | required |
govid_number
Case | Error Type |
Value zero or negative. | invalid |
Value with decimals. | invalid |
Value with higher precision | length |
Not sent | required |
Value different to a number. | type |
govid_type
Case | Error Type |
Different to the available values. | invalid |
Not sent | required |
grant_type
Case | Error Type |
Different to the available values. | invalid |
household_income
Case | Error Type |
Value negative. | invalid |
Value with higher precision | length |
Not sent | required |
Value different to a number. | type |
housing_type
Case | Error Type |
Different to the available values. | invalid |
Not sent | required |
input_type
Case | Error Type |
Different to the available values. | invalid |
lang
Case | Error Type |
Different to the available values. | invalid |
last_name
Case | Error Type |
Value with higher length | length |
Value different to a string. | type |
location_id
Case | Error Type |
Value different to a number | invalid |
merchant_id
Case | Error Type |
Value different to a number | invalid |
merchant_password
Case | Error Type |
Not sent | required |
Value different to a string. | type |
Value with higher length | length |
merchant_username
Case | Error Type |
Value with higher length | length |
Not sent | required |
Value different to a string. | type |
middle_name
Case | Error Type |
Value with higher length | length |
Value different to a string. | type |
monthly_housing_expenses
Case | Error Type |
Value with higher precision | length |
Not sent | required |
Value different to a number. | type |
occupation_id
Case | Error Type |
Different to the available values. | invalid |
Not sent | required |
occupation_title
Case | Error Type |
Value with higher length | length |
Not sent | required |
Value different to a string. | type |
page_number
Case | Error Type |
Not sent | required |
Value different to a number. | type |
page_size
Case | Error Type |
Value different to a number. | type |
personal_income
Case | Error Type |
Value with higher precision | length |
Not sent | required |
Value different to a number. | type |
phone_number
Case | Error Type |
Value with higher precision | length |
Not sent | required |
Value different to a number. | type |
Regex | /^(?([0-9]{3}))?[-. ]?([0-9]{3})[-. ]?([0-9]{4})/ |
piw
Case | Error Type |
Value with higher length | length |
Not sent | required |
Value different to a string. | type |
Regex | /^[a-zA-Z0-9]*$/ |
plan_id
Case | Error Type |
Value zero or negative. | invalid |
Value with decimals. | invalid |
Value with higher precision | length |
Not sent | required |
Value different to a number. | type |
postal_code
Case | Error Type |
Value with higher length | length |
Value different to a string. | type |
preferred_language
Case | Error Type |
Different to the available values. | invalid |
province
Case | Error Type |
Different to the available values. | invalid |
Value different to a string. | type |
reference
Case | Error Type |
Value with higher length | length |
Value different to a string. | type |
salutation
Case | Error Type |
Different to the available values. | invalid |
Not sent | required |
Value different to a string. | type |
security_answer
Case | Error Type |
Not sent | required |
Value different to a string. | type |
Value with higher length | length |
security_qid
Case | Error Type |
Value zero or negative. | invalid |
Value with decimals. | invalid |
Value with higher precision | length |
Not sent | required |
Value different to a number. | type |
sin
Case | Error Type |
Value zero or negative. | invalid |
Value with decimals. | invalid |
Value with higher precision | length |
Value different to a number. | type |
term
Case | Error Type |
Value zero or negative. | invalid |
Value with decimals. | invalid |
Value with higher precision | length |
Not sent | required |
Value different to a number. | type |
tos_agreement
Case | Error Type |
Different to the available values. | invalid |
Not sent | required |
transaction_type
Case | Error Type |
Different to the available values. | invalid |
Not sent | required |
vcc_number
Case | Error Type |
Value zero or negative. | invalid |
Value with decimals. | invalid |
Value with higher precision | length |
Value different to a number. | type |
verification_code
Case | Error Type |
Value zero or negative. | invalid |
Value with decimals. | invalid |
Value with higher precision | invalid |
Not sent | required |
Value different to a number. | type |
widget_session_id
Case | Error Type |
Value zero or negative | invalid |
Value with decimals | invalid |
Value with higher precision | invalid |
Not sent | required |
Value different to a string | type |
x-reference-id
Case | Error Type |
Value zero or negative | invalid |
Value with decimals | invalid |
Value with higher precision | invalid |
Not sent | required |
Value different to a string | type |