Skip to main content

Class GetCustomerFieldsResponse

Contains the results from GetCustomerFieldsRequest


Properties

NAMETYPEDESCRIPTION
RequestIdstringUnique identifier used to identify the request associated with the response.
ResultResponseResultTypeValue indicating type of result. Possible values: Error (default), Success, ValidationError, NoChange
ResultCodestringCan be Error or Resource code depending on type of result.
ResultMessagestringMessage regarding details of the Result.
ValidationResultsValidationResult[]Array of ValidationResult objects containing messages regarding input validation.
CredentialsTokenCredentialsCredentials for subsequent web service requests.
CustomerFieldsDataField[]The list of optional or required customer fields to capture for a deposit.

DataField

NAMETYPEDESCRIPTION
FieldNamestringThe dynamic field name used to capture custom values.
FieldTypeFieldTypeA grouping to identify where to show the fields.
IsRequiredboolIndicates that the field input is required.
TextstringThe text to display to the user.
ValidationstringThe regular expression used to validate the custom field.
ValidationMessagestringThe message to display when the validation fails.
ValuestringThe value the user input.

CustomerFields

FieldNameDescriptionNotes
Address1AddressMax length is 50 characters
Address2Suite/APT#Max length is 50 characters
CityCityMax length is 40 characters
StateState/RegionMax length is 2 characters
PostalCodePostal CodeMax length is 10 characters
CountryCountryMax length is 40 characters
CustomerNumberUnique identifier for the customer in the system. A unique value will be auto generated if one is not supplied.Max length is 50 characters
DaytimePhoneDaytime PhoneMax length is 14 characters
DaytimePhoneExtDaytime Phone ExtensionMax length is 6 characters
EveningPhoneEvening PhoneMax length is 14 characters
EveningPhoneExtEvening Phone ExtensionMax length is 6 characters
DLNumberDriver's License NumberMax length is 50 characters. Required when CustomerType is 'Individual' and config setting is set to required.
DLStateDriver's License StateMax length is 2 characters. Required when CustomerType is 'Individual' and config setting is set to required.
EmailEmailMax length is 60 characters
FaxFax NumberMax length is 20 characters
FirstNameFirst NameMax length is 30 characters. Required when CustomerType is 'Individual' or config setting is set to required.
LastNameThis 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.
SSNFedTaxIDThis field should contain the Federal Tax ID when CustomerType is 'Business' or the SSN when CustomerType is 'Individual'.Max length is 15 characters
CustomerData1Customer Data 1Max length is 50 characters
CustomerData2Customer Data 2Max length is 50 characters
CustomerData3Customer Data 3Max 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

TYPENAMEDESCRIPTION
System.Stringmessage

NullRequestResonse()

Declaration

public static Response NullRequestResonse()

Return Value

TYPEDESCRIPTION
Response

Success()

Declaration

public void Success()

Success(String)

Declaration

public void Success(string resultMessage)

Parameters

TYPENAMEDESCRIPTION
System.StringresultMessage