paymentOfferEntity
The paymentOfferEntity type allows to describe the parameters for the modification of a payment order by e-mail.
the difference with paymentOfferInfo is that it contains the order ID and the email address of the order recipient.
Field name | Type | Description | Required | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
shopId | Long n8 | Shop ID | |||||||||||||||||||||||||||
offerId | Long an32 | Order reference | |||||||||||||||||||||||||||
reference | string an24 | Transaction ID or order reference | |||||||||||||||||||||||||||
ctxMode | string | Defines the mode of interaction with the payment gateway.
| |||||||||||||||||||||||||||
paymentURL | URL of the payment order | ||||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||
message* | string an2000 | Body of the e-mail message sent. | |||||||||||||||||||||||||||
recipient | string | E-mail of the recipient. | |||||||||||||||||||||||||||
subject* | string an255 | Subject of the e-mail message sent. | |||||||||||||||||||||||||||
validationMode | int | Payment validation mode :
| |||||||||||||||||||||||||||
validity | date | 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 | 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.