Introducing web services payment order by e-mail

Web services are developed according to the version 1.2 of the SOAP protocol (Simple Object Access Protocol) and are described by the following wsdl file :

If you use a proxy to connect to the Internet via an application server, contact your system administrator to make sure whether it is necessary to configure the access to this URL.

In order to secure the exchange, it is encrypted according to the HTTPS protocol. Furthermore, a signature mechanism has been set up to validate and authenticate the exchange of data.

Description of the service

This service allows to automate the creation / modification of a payment order to one or more recipients.

For it, two methods are available :

  • create for the creation of a payment order by e-mail.
  • update for the modification of a payment order by e-mail.

The response returned by the server contains the list of created / modified orders.

Each order is associated with a numeric ID, an e-mail address and a payment URL.

Sending to a list of recipients :

It is possible to define a list of recipients in the request.

In this case, one payment order is created for each recipient. There are therefore as many payment order as recipients.

Thus, after the payment, each transaction match an unique recipient.

In order to identify all created orders, the reference field is incremented by 1 in 3 digits.

These characters are concatenated to the reference with a hyphen. Example : [ref]-001, [ref]-002, [ref]-003.

Example of a payment order created with the reference field filled with"Recovery" :

If the order is sent to 3 recipients, then 3 orders will be created with following references :

  • Recovery-001
  • Recovery-002
  • Recovery-003

Use of an E-mail marketing tool :

If the merchant wish to use his own mailing tool, he must disable the automatic sending in the payment order creation / modification requests.

By analyzing the response, he will find all required datas to fill the e-mail : payment URL, order reference and recipient e-mail address.