Class AddItemRequest

This method is used to add an item to a batch.

---

Properties

NAME	TYPE	DESCRIPTION
RequestId	string	Unique identifier used to identify the request. Used when associating the request to the response.
RequestDate	dateTime	DateTime request was made. Request timeout is 1 minute.
Credentials	TokenCredentials	REQUIRED. The credentials given from your last response.
Amount	decimal	REQUIRED. The amount in DECIMAL format.
BatchReference	string	REQUIRED. The batch number to add the item to.
CustomerReference	string	The unique value assigned to each customer that can be retrieved using the GetCustomersRequest.
DataFields	DataField[]	The optional, or required, additonal information to be saved along with the item. This depends upon the GetSettings.ShowDataEntry and if the sub items are REQUIRED.
FrontImage	string	REQUIRED. The JPEG Base64 representation of the front image captured. Minimum size of 1600 x 1200.
GeoLocation	GeoLocation	DEPRECATED. This property is no longer used.
LocationReference	string	This field is not used.
RearImage	string	REQUIRED. The JPEG Base64 representation of the back image captured. Minimum size of 1600 x 1200.

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.

GeoLocation

NAME	TYPE	DESCRIPTION
Latitude	Double
Longitude	Double

Examples

{
      "__type":"AddItemRequest:#JackHenry.Eps.Mobile.RDC",
      "BatchReference":"String Content",
      "LocationReference":"String Content",
      "Amount":12678967.54,
      "FrontImage":"String Content",
      "RearImage":"String Content",
      "CustomerReference":"String Content",
      "DataFields":
     [
        {
              "__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,
        }
     ],
      "GeoLocation":
}

Methods

Validate(IValidatorContext)

Declaration

public override void Validate(IValidatorContext context)

Parameters

TYPE	NAME	DESCRIPTION
JHA.EPS.SharedService.Common.Validator.IValidatorContext	context

Overrides

AuthenticatedRequest.Validate(IValidatorContext)

Exceptions

TYPE	DESCRIPTION
JHA.EPS.SharedService.Common.Validator.ValidationResult	BatchReference cannot be null or empty
JHA.EPS.SharedService.Common.Validator.ValidationResult	BatchReference exists in our system
JHA.EPS.SharedService.Common.Validator.ValidationResult	BatchReference refers to an open batch
JHA.EPS.SharedService.Common.Validator.ValidationResult	Terminal is enabled
JHA.EPS.SharedService.Common.Validator.ValidationResult	FrontImage cannot be null or empty
JHA.EPS.SharedService.Common.Validator.ValidationResult	RearImage cannot be null or empty
JHA.EPS.SharedService.Common.Validator.ValidationResult	Customer exists in our system
JHA.EPS.SharedService.Common.Validator.ValidationResult	Customer is valid for association