Class GetCustomerFieldsResponse
Contains the results from GetCustomerFieldsRequest
Properties
NAME | TYPE | DESCRIPTION |
---|---|---|
RequestId | string | Unique identifier used to identify the request associated with the response. |
Result | ResponseResultType | Value indicating type of result. Possible values: Error (default), Success, ValidationError, NoChange |
ResultCode | string | Can be Error or Resource code depending on type of result. |
ResultMessage | string | Message regarding details of the Result. |
ValidationResults | ValidationResult[] | Array of ValidationResult objects containing messages regarding input validation. |
Credentials | TokenCredentials | Credentials for subsequent web service requests. |
CustomerFields | DataField[] | The list of optional or required customer fields to capture for a deposit. |
DataField
NAME | TYPE | DESCRIPTION |
---|---|---|
FieldName | string | The dynamic field name used to capture custom values. |
FieldType | FieldType | A grouping to identify where to show the fields. |
IsRequired | bool | Indicates that the field input is required. |
Text | string | The text to display to the user. |
Validation | string | The regular expression used to validate the custom field. |
ValidationMessage | string | The message to display when the validation fails. |
Value | string | The value the user input. |
CustomerFields
FieldName | Description | Notes |
---|---|---|
Address1 | Address | Max length is 50 characters |
Address2 | Suite/APT# | Max length is 50 characters |
City | City | Max length is 40 characters |
State | State/Region | Max length is 2 characters |
PostalCode | Postal Code | Max length is 10 characters |
Country | Country | Max length is 40 characters |
CustomerNumber | Unique identifier for the customer in the system. A unique value will be auto generated if one is not supplied. | Max length is 50 characters |
DaytimePhone | Daytime Phone | Max length is 14 characters |
DaytimePhoneExt | Daytime Phone Extension | Max length is 6 characters |
EveningPhone | Evening Phone | Max length is 14 characters |
EveningPhoneExt | Evening Phone Extension | Max length is 6 characters |
DLNumber | Driver's License Number | Max length is 50 characters. Required when CustomerType is 'Individual' and config setting is set to required. |
DLState | Driver's License State | Max length is 2 characters. Required when CustomerType is 'Individual' and config setting is set to required. |
Max length is 60 characters | ||
Fax | Fax Number | Max length is 20 characters |
FirstName | First Name | Max length is 30 characters. Required when CustomerType is 'Individual' or config setting is set to required. |
LastName | This field should contain the company name when CustomerType is 'Business' or the last name when CustomerType is 'Individual'. | Max length is 60 characters. Required field. |
SSNFedTaxID | This field should contain the Federal Tax ID when CustomerType is 'Business' or the SSN when CustomerType is 'Individual'. | Max length is 15 characters |
CustomerData1 | Customer Data 1 | Max length is 50 characters |
CustomerData2 | Customer Data 2 | Max length is 50 characters |
CustomerData3 | Customer Data 3 | Max length is 50 characters |
Examples
{
"__type":"GetCustomerFieldsResponse:#JackHenry.Eps.Mobile.RDC",
"CustomerFields":
[
{
"__type":"DataField:#JackHenry.Eps.Mobile.RDC",
"FieldName":"String Content",
"Text":"String Content",
"IsRequired":true,
"Value":"String Content",
"Validation":"String Content",
"ValidationMessage":"String Content",
"FieldType":FieldType.Transaction,
}
],
}
Methods
Exception(string)
Declaration
public void Exception(string message)
Parameters
TYPE | NAME | DESCRIPTION |
---|---|---|
System.String | message |
NullRequestResonse()
Declaration
public static Response NullRequestResonse()
Return Value
TYPE | DESCRIPTION |
---|---|
Response |
Success()
Declaration
public void Success()
Success(String)
Declaration
public void Success(string resultMessage)
Parameters
TYPE | NAME | DESCRIPTION |
---|---|---|
System.String | resultMessage |