Class Envelope

Envelope elements can be required or optional in the envelope.xsd schema.
However some optional elements in the schema can be mandatory depending on the Web method called.

The table below describes the elements purpose, possible values and occurrence from the schema point of view. Elements must appear in the specified sequence.

Element or attributePossible values
Envelope[1]It is the root element
Envelope@XMLVersion[1]It is the version of the envelope. It is a string with a length of 2 characters. Values can be
• 1
• 2
Envelope@Direction[1]It indicates whether the envelope is an input (call) or output (result) parameter. It is a string. Values can be
• Call
• Result
Envelope/Task[0..n]They are the task elements to be executed.
Envelope/Task@Code[1 per Task]It indicates which task should be or has been performed by the Web server. It is a string. The values can be
• Delete
• Receive
• Send
• Login
• SynchronizeCertificates
• SynchronizeTime
• CertificatesInformation
• ConfigurationFile
• GetBilateralAgreements
• GetMobileBilateralAgreements
• TrackInternationalOrder
• GetInternationalAmountsToIssue
• IssueInternationalOrder
• GetInternationalOrders
• GetMobileInternationalOrders
• GetInternationalOrderToPay
• PayInternationalOrder
• CancelPaidInternationalOrder
• ReimburseInternationalOrder
• GetServiceAgreements
• GetMobileServiceAgreements
• GetDomesticOrders
• GetMobileDomesticOrders
• GetDomesticAmountsToIssue
• IssueDomesticOrder
• PayDomesticOrder
• ReimburseDomesticOrder
• GetServerCertificate
• RequestClientCertificate
• GetClientCertificate
• Enroll
• Revoke
• GetCertificateRevocationList
• GetMobileCustomers
• GetCustomers
• SetCustomer
• ...
Envelope/Task/Success[0..1 per Task]Only and always present in result envelope. It indicates if the task execution is successful for every item or if the task failed. It is a boolean. If one item has a result/Code different than success, the task/Success is false. Values can be
• true
• false
Envelope/Task/DateTime[0..1 per Item]UTC date and time of the task execution. It is only and always present in result envelope. For example
• 2025-05-30T09:30:10Z
Envelope/Task/Item[0..n per Task]Items that have to be or have been processed by the task execution. They can be present in a call or result envelopes. They are elements matching a specific data definition according to the task being performed.
Envelope/Task/Item/FileName[0..1 per Item]It is the name of the file that has to be or has been processed. It can be present in a call or result envelope. It is a string with a maximal length of 100 characters. For example
• network_settings.xml
Envelope/Task/Item/File[0..1 per Item]The description can be found in Item file.
See File.
Envelope/Task/Item/ProductCode[0..1 per Item]It is the product code of the item that has to be or has been processed by the task execution. It can be present in call or result envelope. It is a string. Values can be
• OR
• GT
• IN
• OT
Envelope/Task/Item/ProductTypeCode[0..1 per Item]It is the product type code of the item that has to be processed by the task execution. It can be urgent (U) or normal (N). It can be present in call envelope. It is a string. Values can be
• N
• U
Envelope/Task/Item/BusinessPartnerCode[0..1 per Item]It is the business partner of the EDI message.
It is used by the Receive task call envelope.It is a string with a length of 6 characters.For example.
• J1CBDA
Envelope/Task/Item/ClearingIndicator[0..1 per Item]It indicates whether the EDI message is using the clearing or not. If not specified the value is considered false. It is used by the Send task call envelope. It is a boolean. Values can be
• true
• false
Envelope/Task/Item/StoreName[0..1 per Item]It is the machine store name of a certificate. It is always and only used by the CertificatesInformation task result envelope.
It is a string with a maximal length of 256 characters. For example
• IFS_PROD_CONTAINER
Envelope/Task/Item/MoneyOrderIdentifier[0..1 per Item]It is the money order identifier of the item. For some Web services, it can also be the Customer Transaction Number (CTN). It is used in call and result envelopes. It is a string with a maximum length of 35 characters. For example
• J20AAZAFRAORN2050000000009(IFS money order)
• 11330998229 (External money order)
Envelope/Task/Item/EDIXmlVersion[0..1 per Item]It is the XML version of the EDI message. It is always and only used by the TrackInternationalOrder result envelope.
It is a string with a maximum length of 2 characters.The value is
• 04
Envelope/Task/Item/Result[0..1 per Item]They are the item results elements. They are only and always used in result envelopes. If the item has been successfully processed, it is one success element. If errors were raised, it is the list of errors.
Envelope/Task/Item/Result/Code[0..1 per Result]The list of possible values can be found in section Item result.
See Code.
Envelope/Task/Item/Result/Description[0..1 per Result]It is the description for success or error. In case of an error, it can contain instructions to solve the issue. It is a string with a maximal length of 2048.
The list of possible values is available in section Item result.
See Code.
There is always a description for a Result/Code.
For example
• Method SynchronizeCertificates failed while trying to validate license or synchronizing certificates.Please check the event log for details.
Envelope/Task/Item/Result/Event[0..1 per Result]It is the money order event concerned by the item result. It is used in the result envelope. It is an element.
Envelope/Task/Item/Result/Event@MoneyOrderIdentifier[1 per Event]It is the money order identifier of the result. It is used in the result envelope. It is a string with a maximum length of 35 for the money orders issued by IFS partner. For example
• J20AAZAFRAORN2050000000009
The money order that issued by an external partners has a different format.For example:
• 11330998229
Envelope/Task/Item/Result/Event@StateIndicatorCode[1 per Event]It is the money order event state code indicator of the result. It is used in the result envelope. It is a string. Values can be

• AC
• CC
• DR
• DS
• EC
• EP
• EW
• FP
• NP
• TD
• ED
• EE
• EI
• FD
• FE
• FI
• EA
• ER
• FA
• FK
• FR
• FX
• NR
Envelope/Task/Item/Result/Event@DateTime[1 per Event]It is the money order event UTC date and time of the result envelope. It is used in the result. For example
• 2025-05-30T09:30:10Z
Inheritance
System.Object
Envelope
Implements
System.ComponentModel.INotifyPropertyChanged
Namespace: IFSWebServices.XmlInternationalServices
Assembly: WebServices.dll
Syntax
[Serializable]
public class Envelope : INotifyPropertyChanged

Properties

Direction

It indicates whether the envelope is an input (call) or output (result) parameter. It is a string. Values can be:

  • Call
  • Result
Declaration
public ST_Direction Direction { get; set; }
Property Value
Type Description
ST_Direction

Task

They are the task elements to be executed.

Declaration
public List<EnvelopeTask> Task { get; set; }
Property Value
Type Description
System.Collections.Generic.List<EnvelopeTask>

XMLVersion

It is the version of the envelope. It is a string with a length of 2 characters. Values can be:

  • 01
  • 02
Declaration
public string XMLVersion { get; set; }
Property Value
Type Description
System.String

Methods

RaisePropertyChanged(String)

Declaration
protected void RaisePropertyChanged(string propertyName)
Parameters
Type Name Description
System.String propertyName

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged