Receipt

Table of Contents  [ Hide]

SendReceipt
WID
Language
OrganizationInformation
ThankYouMessage
TermsCondition
Deductible
EmailNotificationList
NotificationEmail
CustomParameters
Parameter
Field
Value

Path: CnPAPI.Engine.Request.Order.Receipt

Elements:

• SendReceipt
• WID
• Language
• OrganizationInformation
• ThankYouMessage
• TermsCondition
• Deductible
• EmailNotificationList
• CustomParameters

Schema

      <xsd:element name="Receipt">

            <xsd:complexType>

                  <xsd:sequence>

                        <xsd:element ref="SendReceipt" minOccurs="0"/>

                        <xsd:element ref="CheckOutPageID" minOccurs="0"/>

                        <xsd:element ref="WID" minOccurs="0"/>

                        <xsd:element ref="Language" minOccurs="0"/>

                        <xsd:element ref="OrganizationInformation" minOccurs="0"/>

                        <xsd:element ref="ThankYouMessage" minOccurs="0"/>

                        <xsd:element ref="TermsCondition" minOccurs="0"/>

                        <xsd:element ref="Deductible" minOccurs="0"/>

                        <xsd:element ref="EmailNotificationList" minOccurs="0"/>

        <xsd:element ref="CustomParameters" minOccurs="0"/>       

                  </xsd:sequence>

            </xsd:complexType>

      </xsd:element>

Example

 <Receipt>

 <SendReceipt>true</SendReceipt>

 < WID >1234</ WID >

 <Language>ENG</Language>

 <OrganizationInformation>Nonprofit 123</OrganizationInformation>

 <ThankYouMessage><![CDATA[Thank you for your support]]></ThankYouMessage>

 <TermsCondition><![CDATA[All donations are tax deductible.]]></TermsCondition>

 <Deductible>1</Deductible>

 <EmailNotificationList>

 <NotificationEmail>Notify.Jim@EmailAddress.com</NotificationEmail>

 <NotificationEmail>Notify.Merry@EmailAddress.com</NotificationEmail>

 </EmailNotificationList>

 </Receipt>

SendReceipt

Schema

      <xsd:element name="SendReceipt">

            <xsd:simpleType>

                  <xsd:annotation>

                        <xsd:documentation>If True the receipt will be emailed to the card holder.</xsd:documentation>

                  </xsd:annotation>

                  <xsd:restriction base="xsd:boolean"/>

            </xsd:simpleType>

      </xsd:element>

WID

Schema

      <xsd:element name="WID">

            <xsd:simpleType>

                  <xsd:annotation>

                        <xsd:documentation>The receipt information as set by the checkout page will be used if the CheckOutPageID is specified.  If specified, other Receipt elements will NOT be used.</xsd:documentation>

                  </xsd:annotation>

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

                        <xsd:minInclusive value="1"/>

                        <xsd:maxInclusive value="9999999999"/>

                  </xsd:restriction>

            </xsd:simpleType>

      </xsd:element>

Note:

Prior to release 2.19 the element was called CheckoutPageID. Backward compatability has been maintained and the element will also work with CheckoutPageID. It is recommended that the new WID parameter be used for consistency. Prior implementations with CheckoutPageID will work and no change is required.

Language

Schema

      <xsd:element name="Language">

            <xsd:simpleType>

                  <xsd:annotation>

                        <xsd:documentation>The receipt language to be used.  If CheckOutPageID is listed the language of the checkout page will be used for the receipt.</xsd:documentation>

                  </xsd:annotation>

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

                        <xsd:enumeration value="ENG"/>

                        <xsd:enumeration value="CHN"/>

                        <xsd:enumeration value="DEU"/>

                        <xsd:enumeration value="ITA"/>

                        <xsd:enumeration value="SPN"/>

                        <xsd:enumeration value="POL"/>

                        <xsd:enumeration value="JAP"/>

                        <xsd:enumeration value="RUS"/>

                        <xsd:enumeration value="FRN"/>

                        <xsd:enumeration value="POR"/>

                  </xsd:restriction>

            </xsd:simpleType>

      </xsd:element>

OrganizationInformation

Schema

      <xsd:element name="OrganizationInformation">

            <xsd:simpleType>

                  <xsd:annotation>

                        <xsd:documentation>Organization information to be used.  This node will be Ignored if CheckOutPageID is used.</xsd:documentation>

                  </xsd:annotation>

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

                        <xsd:maxLength value="200"/>

                  </xsd:restriction>

            </xsd:simpleType>

      </xsd:element>

ThankYouMessage

Schema

      <xsd:element name="ThankYouMessage">

            <xsd:simpleType>

                  <xsd:annotation>

                        <xsd:documentation>The Thank You message appearing after the salutation.  This node will be ignored if the CheckOutPageID node is used.</xsd:documentation>

                  </xsd:annotation>

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

                        <xsd:maxLength value="500"/>

                  </xsd:restriction>

            </xsd:simpleType>

      </xsd:element>

TermsCondition

Schema

      <xsd:element name="TermsCondition">

            <xsd:simpleType>

                  <xsd:annotation>

                        <xsd:documentation><![CDATA[The terms & conditions to be added at the bottom of the receipt.  Typically the text provides proof that the patron has read the terms & conditions and has agreed to it.  This node will be ignored if the CheckOutPageID is used.]]></xsd:documentation>

                  </xsd:annotation>

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

                        <xsd:maxLength value="1500"/>

                  </xsd:restriction>

            </xsd:simpleType>

      </xsd:element>

Deductible

Schema

      <xsd:element name="Deductible">

            <xsd:simpleType>

                  <xsd:annotation>

                        <xsd:documentation>Should the tax deductible listing show up on the receipt?  If Yes, tax deductible portion will appear on the receipt.  If CheckOutPageID is used, this node will be ignored.</xsd:documentation>

                  </xsd:annotation>

                  <xsd:restriction base="xsd:boolean"/>

            </xsd:simpleType>

      </xsd:element>

EmailNotificationList

Path: CnPAPI.Engine.Request.Order.Receipt.EmailNotificationLis

A container for providing email list so engine can send notification email to associated person

Element:

• NotificationEmail

Schema

      <xsd:element name="EmailNotificationList">

            <xsd:complexType>

                  <xsd:sequence>

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

                  </xsd:sequence>

            </xsd:complexType>

      </xsd:element>

NotificationEmail

Schema

      <xsd:element name="NotificationEmail">

            <xsd:simpleType>

                  <xsd:annotation>

                        <xsd:documentation>Email address(es) to be notified for the transaction.  NotificationEmail should be used for the organization’s notification.  Card holder’s receipt will be sent to the email listed as part of the card holder information.</xsd:documentation>

                  </xsd:annotation>

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

                        <xsd:maxLength value="50"/>

                  </xsd:restriction>

            </xsd:simpleType>

      </xsd:element>

CustomParameters

Path: CnPAPI.Engine.Request.Order.Receipt.CustomParameters

Custom parameters are additional fields that may be passed as part of each transaction.  These parameters will post back in the response.  These fields will NOT be included in the receipt and are primarily designed for interaction between external applications.  For example MemberID’s being passed back for updating a database.

 Elements

• Parameter

Schema

  <xsd:element name="CustomParameters">

    <xsd:complexType>

      <xsd:sequence>

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

      </xsd:sequence>

    </xsd:complexType>

  </xsd:element>

Parameter

Path: CnPAPI.Engine.Request.Order.Receipt.CustomParameters.Parameter

Elements:

• Field
• Value

Schema

  <xsd:element name="Parameter">

    <xsd:complexType>

      <xsd:sequence>

        <xsd:element ref="Field"/>

        <xsd:element ref="Value"/>

      </xsd:sequence>

    </xsd:complexType>
  </xsd:element>

Example

      <CustomParameters>

            <Parameter>

                  <Field>ClientID</Field>

                  <Value>12345</Value>

            </Parameter>

            <Parameter>

                  <Field>MembershipLevel</Field>

                  <Value>Platinum</Value>

            </Parameter>
      </CustomParameters>

Field

Schema

  <xsd:element name="Field">

    <xsd:simpleType>

      <xsd:annotation>

        <xsd:documentation>Additional information to be used with post back response</xsd:documentation>

      </xsd:annotation>

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

        <xsd:maxLength value="100"/>

      </xsd:restriction>

    </xsd:simpleType>
  </xsd:element>

Value

Schema

  <xsd:element name="Value">

    <xsd:simpleType>

      <xsd:annotation>

        <xsd:documentation><![CDATA[Value for the Field.]]></xsd:documentation>

      </xsd:annotation>

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

        <xsd:maxLength value="300"/>

      </xsd:restriction>

    </xsd:simpleType>

  </xsd:element>