Creating a payment order by e-mail

Important :

  • If sendMAIL= true, an e-mail is received by each buyer with a single payment URL.
  • If sendMAIL= false, the buyer will not receive e-mail. The merchant has the task to chose the way to pass the payment URL on to the buyer.

The create function allows to create a payment order. It takes as input the following parameters:

Field name Type Description Required
info paymentOfferInfo Parameters for the creation of a payment order (see paymentOfferInfo)
wsSignature string Signature

The signature computation is done using the parameters in the following order:

shopId, reference, ctxMode, amount, currency, locale, message, recipients, subject, validationMode, validity, sendMail, expandedData

Notes :

In the signature computation:

  • The dateTime fields must be formated in YYYYMMDD.

    Example : 2016-06-22T23:00:00+00:00 becomes 20160622

  • The string field recipients should be in brackets [...]. The e-mail addresses must be separated by a comma and a space.

    Examples:

    [email]

    [email1, email2, email3]

The create function returns a paymentOfferResponse response type.

Example of XML generated file

<?xml version="1.0" encoding="UTF-8"?> 
<SOAP-ENV:Envelope xmlns:SOAP-ENV=""
 xmlns:ns1="">
 <SOAP-ENV:Body> 
	 <ns1:create> 
		 <info> 
			 <shopId>12345678</shopId>
			 <ctxMode>TEST</ctxMode>
			 <subject>Your payment order</subject>
			 <message>Hello, please find below a payment link</message>
			 <device>MAIL</device>
			 <reference>CMD123</reference>
			 <validity>2016-06-22T23:00:00+00:00</validity>
			 <amount>10000</amount>
			 <validationMode>0</validationMode>
			 <currency>978</currency>
			 <locale>fr</locale>
			 <sendMail>true</sendMail>
			 <recipients>test@test.fr</recipients>
			 <recipients>test1@test.fr</recipients>
			 <expandedData>vads_payment_config=MULTI:first=1000;count=3;period=30&vads_language=en</expandedData>
		 </info>
		 <signature>1ee15221a1b9c062e01ba4a790e46581418f72fb</signature>
	 </ns1:create>
 </SOAP-ENV:Body>
 </SOAP-ENV:Envelope>

Corresponding signature computation:

12345678+CMD123+TEST+10000+978+fr+Hello, please find below a payment link+[test@test.fr, test1@test.fr]+Your payment order+0+20160622+1+vads_payment_config=MULTI:first=1000;count=3;period=30;vads_language=en+certificat

Example of XML generated file with use of e-mail template

<?xml version="1.0" encoding="UTF-8"?> 
<soap:Envelope xmlns:soap=""
 xmlns:v2="">
 	<soap:Header/>   
	<soap:Body> 
	 <v2:create> 
		<info>            
			<shopId>12345678</shopId>            
			<ctxMode>TEST</ctxMode>            
			<reference>CMD123</reference>            
			<template>templateTest</template>            
			<device>MAIL</device>            
			<validity>2017-12-10T19:20:00Z</validity>            
			<amount>10000</amount>            
			<validationMode>0</validationMode>           
			<currency>978</currency>          
			 <locale>fr</locale>            
			<sendMail>true</sendMail>            
			<recipients>test@test.fr</recipients>           
			<expandedData>vads_payment_config=MULTI:first=1000;count=3;period=30</expandedData>  
		 </info>
 			<signature>719595eecd97ec87de35fb6973ab425b6d45ab61</signature>
	 </v2:create>
    </soap:Body>
</soap:Envelope>

Corresponding signature computation:

12345678+CMD123+TEST+10000+978+fr+[test@test.fr]+0+20171210+1+vads_payment_config=MULTI:first=1000;count=3;period=30+certificate