Path: CnPAPI.Engine.Request.Operation
Elements
- OperationType
- IPAddress
- EnableRestriction
- UrlReference
Operation element specifies the type of operation to be performed. Only Transaction type is available in Release 1.0. Additional operations will be added in the future releases.
Schema
<xsd:element name="Operation">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="OperationType"/>
<xsd:element ref="IPAddress" minOccurs="0"/>
<xsd:element ref="EnableRestriction" minOccurs="0"/>
<xsd:element ref="UrlReferrer" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
Example
<Operation>
<OperationType>Transaction</OperationType>
<IPAddress>192.168.0.11</IPAddress>
<DeclineFraud>false</DeclineFraud>
<EnableRestriction>true</EnableRestriction>
<UrlReferrer>https://secure.someDomain.com/donate.html</UrlReferrer>
</Operation>
OperationType
| Name | OperationType |
| Path | CnPAPI.Engine.Request. Operation.OperationType |
| Description | Define the type of operation to be performed. |
| Data Type | String |
| Range | Transaction |
| Default | |
| Operation | All operations |
| Input/output | Input |
| Version/Release | 1.2 |
| Required | Yes |
| Example | <OperationType>Transaction</OperationType> |
Schema
<xsd:element name= "OperationType" >
<xsd:simpleType >
<xsd:annotation >
<xsd:documentation> Define the type of operation to be performed</xsd:documentation >
</xsd:annotation >
<xsd:restriction base= "xsd:normalizedString" >
<xsd:enumeration value= "Transaction" />
</xsd:restriction >
</xsd:simpleType >
</xsd:element>
IPAddress
IP address of the computer used for making the transaction. The IP is saved for security and tracking purposes.
| Name | IPAddress |
| Path | CnPAPI.Engine.Request. Operation.IPAddress |
| Description | Card holder’s IP address (xxx.xxx.xxx.xxx) |
| Data Type | String |
| Range | Maximum 15 characters |
| Default | |
| Operation | All operation |
| Input/output | Input |
| Version/Release | 1.2 |
| Required | Yes |
| Example | <IPAddress>123.123.123.123</IPAddress>
You may pass: 0.0.0.0 if client IP cannot be determined, e.g. in Flash / Silverlight. |
Schema
<xsd:element name= "IPAddress" >
<xsd:simpleType >
<xsd:annotation >
<xsd:documentation> Card holder’s IP address (xxx.xxx.xxx.xxx)</xsd:documentation >
</xsd:annotation >
<xsd:restriction base= "xsd:normalizedString" >
<xsd:maxLength value= "15" />
</xsd:restriction >
</xsd:simpleType >
</xsd:element>
EnableRestriction
Country and state restrictions may be enabled in the administrative system and applied to the API transactions. Once enabled, payments originating from the restricted states & countries will decline. The IP address needs to be passed correctly since country will be based on the IP address.
| Name | EnableRestriction |
| Path | CnPAPI.Engine.Request. Operation.EnableRestriction |
| Description | Decline cards from states & countries that are restricted in the administrative system. |
| Data Type | Boolean |
| Range | true / false |
| Default | false |
| Operation | All operation |
| Input/output | Input |
| Version/Release | 2.9.2 |
| Required | No |
| Example | <EnableRestriction>false</EnableRestriction> |
Schema
<xsd:element name= "EnableRestriction" >
<xsd:simpleType >
<xsd:annotation >
<xsd:documentation />
</xsd:annotation >
<xsd:restriction base= "xsd:boolean" />
</xsd:simpleType >
</xsd:element >
UrlReferrer
The URL address of the donation page to be saved in the report.
| Name | UrlReferrer |
| Path | CnPAPI.Engine.Request. Operation.UrlReferrer |
| Description | The web site address of the page |
| Data Type | String |
| Range | 0-300 |
| Default | |
| Operation | All operation |
| Input/output | Input |
| Version/Release | 2.19 |
| Required | No |
| Example | <UrlReferrer>http://tracker1.com</UrlReferrer> |
Schema
<xsd:element name= "UrlReferrer" >
<xsd:simpleType >
<xsd:annotation >
<xsd:documentation><![CDATA[UrlReferrer.]]></xsd:documentation >
</xsd:annotation >
<xsd:restriction base= "xsd:normalizedString" >
<xsd:maxLength value= "300" />
</xsd:restriction >
</xsd:simpleType >
</xsd:element>
Uploading ....