CustomFieldList

Path: CnPAPI.Engine.Request.Order. CardHolder.CustomFieldList

Custom fields are additional fields that may be passed as part of each transaction. Custom fields are stored and may be retrieved through the report section of the administrative system. Custom fields are also sent as part of the receipt if SendReceipt element is true.

Elements

• CustomField

Schema

 <xsd:element name= "CustomFieldList" >  

 <xsd:complexType >  

 <xsd:sequence >  

 <xsd:element ref= "CustomField" maxOccurs="unbounded" />  

 </xsd:sequence >  

 </xsd:complexType >  

 </xsd:element>

CustomField

Path: CnPAPI.Engine.Request.Order. CardHolder.CustomFieldList.CustomField

Elements:

• FieldName
• FieldValue

Schema

 <xsd:element name="CustomField">

 <xsd:complexType >  

 <xsd:sequence >  

 <xsd:element ref= "FieldName" />  

 <xsd:element ref= "FieldValue" />  

 </xsd:sequence >  

 </xsd:complexType >  

 </xsd:element>

Example

 <CustomFieldList>

 <CustomField>

 <FieldName>Employer</FieldName>

 <FieldValue>Good Company</FieldValue>

 </CustomField>

 <CustomField>

 <FieldName>Occupation</FieldName>

 <FieldValue>Good Job</FieldValue>

 </CustomField>

 <CustomField>

 <FieldName>Place of Employment</FieldName>

 <FieldValue>Blacksburg, Virginia</FieldValue>

 </CustomField>

 </CustomFieldList>

FieldName

Schema

 <xsd:element name= "FieldName" >  

 <xsd:simpleType >  

 <xsd:annotation >  

 <xsd:documentation> Additional information collected from the card holder. Field name is typically used as the question for the field and the FieldValue used as the answer. Example: Who is your employer? FieldName will be saved and may be exported through the report section.</xsd:documentation >  

 </xsd:annotation >  

 <xsd:restriction base= "xsd:normalizedString" >  

 <xsd:maxLength value= "200" />  

 </xsd:restriction >  

 </xsd:simpleType >  

 </xsd:element>

FieldValue

Schema

 <xsd:element name= "FieldValue" >  

 <xsd:simpleType >  

 <xsd:annotation >  

 <xsd:documentation><![CDATA[Answer to the FieldName question. Example: Click & Pledge for the Who is your Employer? FieldName. FieldValue will be saved and may be exported through the report section.]]></xsd:documentation >  

 </xsd:annotation >  

 <xsd:restriction base= "xsd:normalizedString" >  

  <xsd:maxLength value= "500" />  

 </xsd:restriction >  

 </xsd:simpleType >  

 </xsd:element>