Enum ST_TaskCode

Enumeration of task code should be or has been performed by the Web server.

Namespace: IFSWebServices.XmlInternationalServices
Assembly: WebServices.dll
Syntax
[Serializable]
public enum ST_TaskCode

Fields

Name Description
CancelPaidInternationalOrder

Call to this Web service allows cancelling international money orders payments. Orders with cancellable payments should be in the state

  • EP: Order paid. A money order is uniquely identified with the international money order. Otherwise the Web service would return the InternationalOrder_NotFound error. Order with cancellable payment is money order having a valid bilateral agreement, being in one of the states leading to payment cancellation state (refer to state transition diagram for full details). Otherwise the Web service would return the InternationalOrder_PaymentNotCancellable error. If it fails to deserialized the information in File element or if it misses the money order international identifier, it returns the MsgHandling_InvalidXML_DeserializationError error.
CertificatesInformation

Call to this Web service gets the certificates information from the stores. All the certificates in all the stores are returned. No call envelope is needed.
ChangePassword

This service is installed on the IFS Web server. Call to this Web service change the password of the user
ConfigurationFile

Call to this Web service get an xml configuration file from the Config folder.
Delete

Call to this Web service deletes files from the FTP folder and returns a result envelope. A Monord or a Resord file must only be deleted if it has been successfully processed and stored in the host system and IFSAck or IFSErr will be returned to the sending partner. An IFSAck or IFSErr file must only be deleted if it has been successfully processed and stored in the host system.
DeleteClearingReports

Call to this Web service will connect to FTP server and delete from FTP server a specific file in ClearingReports folder of the partner. Use in STEFI Web.
DeleteDailyRates

Call to this Web service will delete each exchange rate in FTP server.
Enroll

This service is installed on the enrollment server. Call to this Web service generates a certificate from a request.
GetBilateralAgreements

Call to this Web service return all the matching valid bilateral agreements. Valid bilateral agreements are agreements with the following criteria:

  • If element BusinessPartnerCode is specified, the issuing or paying organization match the specified element
  • If element ProductCode is specified, only agreements with this product code are returned
  • If element ProductTypeCode is specified, only agreements with this product type code are returned
  • The agreement is not suspended
  • The actual date is in the agreement validity period (between valid from and valid to dates)
  • Returned agreement can be a test or production agreement
GetClientCertificate

Call to this Web service retrieves a certificate that has been generated from a request.
GetCreatedInvoices

Call to this Web service will connect to FTP server and download signed created invoices files from the D.O. FTP folder ClearingReports which have file name respecting the naming convention for created invoices report: J1CXXX_CreatedInvoices_ClearingCycle_GenerationDateAndTime.xml. Use in STEFI Web.
GetDailyOrdersJournal

Call to this Web service search for issued, paid, and reimbursed international and domestic money orders at the given date by the given device. The event date is retrieved from the EventUTCDT. The device identifier can be deduced and retrieved from the CertifId. It returns the money orders which were issued, paid or reimbursed by the specified certified at the specified date. Part of the order details returned, it lists only these order events stored at the specified date by the specified certifId
GetDailyRates

Call to this Web service will download and process exchange rate in FTP server.
GetDomesticAmountsToIssue

Call to this Web service calculates the fee amount and set currencies, based on the corresponding service agreement, required for issuing a domestic money order.
GetDomesticOrders

Call to this Web service provides details about domestic money orders matching the provided information
GetInternationalAmountsToIssue

Call to this Web service calculates amounts and set currencies, based on the corresponding bilateral agreement, required for issuing an international money order. It calculates the transferred amount from deposited amount or it calculates deposited amount from transferred amount. It indicates the exchange rate use in the deposited exchange rate element. It calculates the fees according to the list of required services with fees for the agreement of the money order. Then it calculates the remuneration amount according to the bilateral agreement settings.
GetInternationalOrders

Call to this Web service finds international money orders matching the provided information. It returns all the available details about the money orders (e.g. purchase information, sender, payee, list of events, payment information, payment’s beneficiary, etc ). Starting from IFS 4.17 the GetInternationalOrders call to the web service is integrated with the UPU-IP. It has been extended to find international money oders that are issued by external partners.
GetInternationalOrderToPay

Call to this Web service finds payable international money orders matching the provided order identifier. Provided identifier can be an international money order identifier issued by an IFS partner (e.g. J20AFRAJPAORU4070000015233), a CTN (e.g FRA0000015233) or an international money order identifier issued by an external partner (er 11330998229). A payable money order should have a valid bilateral agreement, be in one of the states leading to payment state.
GetNetBalance

Call to this Web service will connect to FTP server and download signed net balance files from the D.O. FTP folder ClearingReports which have file name respecting the naming convention for net balance report: J1CXXX_NetBalance_ClearingCycle_GenerationDateAndTime.xml. Use in STEFI Web.
GetOrdersToInvoice

Call to this Web service will connect to FTP server and download signed orders to invoice files from the D.O. FTP folder ClearingReports which have file name respecting the naming convention for orders to invoice report: J1CXXX_OrdersToInvoice_GenerationDateAndTime.xml. Use in STEFI Web.
GetRevocationRequestList

Call to this Web service retrieves revocation request list. (Obsolete)
GetServerCertificate

Call to this Web service returns the certificate of the server used by IIS for the TLS connection. No call envelope is needed.
GetServiceAgreements

Call to this Web service return all the matching valid service agreements.
IssueDomesticOrder

Call to this Web service issues a new domestic money order. The money order is checked against the corresponding service agreement before being stored in the database.
IssueInternationalOrder

Call to this Web service issues a new international money order. The money order is checked against the corresponding bilateral agreement before being stored in the database. Note that a call to this Web service does not send an EDI Monord message. This operation is done later by a scheduled task.
Login

This service is installed on the IFS Web server. Call to this Web service checks the login and password of the user. The password is hashed.
PayDomesticOrder

Call to this Web service allows paying domestic money orders. The order should be payable. The following payment information is mandatory.

  • Money order identifier
  • Paid amount
  • First identification number (ex: passport number)
PayInternationalOrder

Call to this Web service allows paying international money orders. The order should be payable. The following payment information is mandatory.

  • International money order identifier
  • Paid amount
  • First identification number (ex: passport number) for cash payment
  • Bank account details for payment on account A payable money order is uniquely identified with the international money order. Otherwise the Web service would return the InternationalOrder_NotFound error. A payable money order is money order having a valid bilateral agreement and being in one of the states leading to payment state (refer to state transition diagram for full details). Otherwise the Web service would return the InternationalOrder_NotPayable error. Web service can proceed to the payment of international order only if all the mandatory payment information is past (paid amount, payment beneficiary details which include the first identification number or the bank account details according to product and the M38 standard requirements). If required payment details are missing, it returns the InternationalOrder_InvalidPaymentInformation error.

If it fails to deserialized the information in File element or if it misses the money order international identifier, it returns the MsgHandling_InvalidXML_DeserializationError error.
Receive

Call to this Web service collects files from FTP folder and provides the messages content in a result envelope. A processed file is not deleted on the FTP server and no IFSAck or IFSErr is generated.
ReimburseDomesticOrder

Call to this Web service allows reimbursing international money orders. Reimbursable orders should be in the state

  • EA: Reimbursement information cancelled
  • ED: Cancellation request accepted (for OT and GT only)
  • EE: Order expired (for OT only)
  • EI: Payment impossible (for OT and GT only)
  • NR: Sender notified for reimbursement (for IN and OR only)
ReimburseInternationalOrder

Call to this Web service allows reimbursing international money orders. Reimbursable orders should be in a state leading to reimbursement, one of the following:

  • EA: Reimbursement information cancelled
  • ED: Cancellation request accepted (for OT and GT only)
  • EE: Order expired (for OT only)
  • EI: Payment impossible (for OT and GT only)
  • NR: Sender notified for reimbursement (for IN and OR only) The following reimbursement information is mandatory:
  • International money order identifier
  • Paid amount
  • Beneficiary’s name
  • First identification number (ex: passport number) for cash reimbursement
  • Bank account details for reimbursement on account

A reimbursable money order is uniquely identified with the international money order. Otherwise the Web service would return the InternationalOrder_NotFound error.

A reimbursable money order is money order having a valid bilateral agreement and being in one of the states leading to reimbursement state (refer to state transition diagram for full details). Otherwise the Web service would return the InternationalOrder_NotReimbursable error.

Web service can proceed to the reimbursement of international order only if all the mandatory reimbursement information is past (reimbursed amount, reimbursement beneficiary details which include the first identification number or the bank account details according to product and the M38 standard requirements). If required reimbursement details are missing, it returns the InternationalOrder_InvalidReimbursementInformation error.

If it fails to desrialized the information in File element or if it misses the money order international identifier, it returns the MsgHandling_InvalidXML_DeserializationError error.
RequestClientCertificate

Call to this Web service is used to start the enrolment process. Then the user will have to wait for its enrollment to be granted (or rejected) by an device manager. Once the enrolment is done, the client must call GetClientCertificate to retrieve the corresponding certificate.
Send

Call to this Web service upload files to FTP folder and provides the messages content in a result envelope. Monord, Resord, IFSErr and IFSAck can be sent.
SynchronizeCertificates

Call to this service synchronizes the certificates from FTP. No call envelope is needed.
SynchronizeTime

Call to this service synchronizes the time of the Web server from the SNTP server. No call envelope is needed.
TrackInternationalOrder

Call to this Web service provides details about one international money order. It extracts all the money orders details (events, customers details) under the format of EDI messages (Monord and Resord).