paymentOfferInfo

The paymentOfferInfo type allows to describe the parameters for a creation of a payment order by e-mail.

Table 1. paymentOfferInfo
Field name Type Description Required
shopId Long n8 Shop ID
reference string an24 Transaction ID or order reference  
ctxMode string Defines the mode of interaction with the payment gateway.
  • TEST
  • PRODUCTION
amount long The amount of the transaction presented in the smallest unit of the currency (ex: cent for Eur).
currency int Currency code of the transaction (ISO 4217 standard).

E.g.: 978 for euro (EUR)
locale string Language code used to send notifications (e-mail or SMS payment confirmation)

List of available languages

Language ISO 639-1 standard
German de
English en
Chinese zh
Spanish es
French fr
Italian it
Japanese ja
Dutch nl
Polish pl
Portuguese pt
Russian ru
Swedish sv
message* string an2000 Body of the e-mail message sent.
recipients Array [1-100] List of e-mail addresses.

An order is created by recipient (min 1, max 100).
subject* string an255 Subject of the e-mail message sent.
validationMode int Payment validation mode :
  • 0 = Automatic (by default)
  • 1 = Manual.
validity dateTime Validity date of the order.

Can not be less than the current date and may not exceed 90 days.

Date in ISO 8601 format defined by W3C.

Example : 2016-07-16T19:20:00Z.
sendMail boolean Sends the e-mail to the recipient if true.
expandedData string Allows to add dynamically any of the form field.

Examples:

Create a payment order n times and in English
vads_payment_config=MULTI:first=1000;
count=3;period=30&vads_language=en

Propose the registration of the card during payment

vads_page_action=ASK_REGISTER_PAY

Make a one-click payment

vads_identifier=9685332147463547785213301
  
device string Possible value = « MAIL »
template string

Name of the e-mail template used for the payment order.

  

* The fields message and subject become optional when template is filled.

Initialization example with JAVA

private PaymentOfferInfo initInfo() 
{
	PaymentOfferInfo info = new paymentOfferInfo();
	info.setShopId(PDV_ID);
	info.setAmount(10000);
	info.setCurrency(978);
	info.setCtxMode("PRODUCTION");
	info.getRecipients().add(MAIL1);
	info.getRecipients().add(MAIL2);
	info.setLocale("fr");
	info.setMessage(BODY);
	info.setReference("REF-ORDRE");
	info.setDevice(PaymentDevice.MAIL.toString());
	info.setSubject(SUBJECT);
	info.setValidationMode(0);
	info.setValidity(UtilWsTests.getNewDate(90));
	info.setSendMail(true);
	info.setExpandedData("vads_payment_config=MULTI:first=1000;count=3;period=30&vads_language=en");
	return info;
}