Mandate parameters
Payment parametersThe following system parameters can (or must) be used in the mapping to create a valid mandate request:
- = not allowed (must be left empty)
X = mandatory
O = mandatory with rules
| OUTPUT NAME | DESCRIPTION | FORMAT | MANDATORY | COMMENTS |
|---|---|---|---|---|
| *MandateContract | The name of the contract that must be used for this mandate | String | x | |
| *LanguageCode | The mandate request language | xx-XX (i.e. en-US) | If empty: entity language is used | |
| *MandateNumber | The unique number for this mandate request | String | ? | If empty: the mandate provider will create one |
| *MandateProviderLinkUrl | An optional link to the mandate if this is known already | String | ? | If empty: the mandate provider will create one. If supplied [*MandateNumber] is mandatory too |
| *Description | A brief description for this mandate | String | x | |
| *CurrencyCode | The currency of the amount | XXX (i.e. EUR, USD) | If empty: entity currency is used | |
| *Amount | The total amount to pay | Decimal (xx,xx or xx.xx) | ||
| *Gender | Gender of the client | Char (M, F or U) | If empty: U (unknown) is used | |
| *FirstName | The first name of the client | String | ? | Not mandatory for Twikey |
| *LastName | The last name of the client | String | ? | Not mandatory for Twikey |
| *MailAddress | Mail address | String (xx@xx.xx) | x | Always mandatory |
| *MailAddressesCC | Mail address(es) in the CC (; separated) | String (xx@xx.xx); (yy@yy.yy) | Only interesting when SendType is mail | |
| *PhoneNumber | (Mobile) phone number | String | Only mandatory when SendType is sms | |
| *Street | The street of the customer or company | String | x | |
| *Number | The number of the street | String | x | |
| *ZipCode | The zip code of the address | String | x | |
| *City | The city name of the address | String | x | |
| *Country | The country of the address | String | x | |
| *CompanyName | Company name | String | ? | Mandatory if company number is supplied |
| *CompanyNumber | Company number (ie:VAT number) | String | ? | Mandatory if company name is supplied |
| *SendType | Indicates via what medium a mandate request link must be sent | mail, sms or nosend | If empty: nosend | |
| *SendDateTime | The date when a mandate request must be sent to the customer | Date | If empty: current date and time (send immediately) | |
| *ExpirationDateTime | The date that this request will expire | Date | If empty: default expiration time after send is used | |
| *MailTemplate | The name of the mail template that must be used (when *SendType is mail) | String (name of the mail template) | If empty and *SendType is mail: the default mail template is used | |
| *MessageTemplate | The name of the message template that must be used (when *SendType is sms) | String (name of the message template) | If empty and *SendType is sms: default message template is used | |
| *ShortenedUrl | You can supply a shortened URL that has been created before | String | The URL must be valid and unique. If left empty, the system will generate a shortened URL | |
| *AcceptUrl | The URL to which the customer is directed after a successful transaction. | Available to automated external calls when creating a mandate. | ||
| *DeclineUrl | The URL to which the customer is directed after a rejected transaction. | Available to automated external calls when creating a mandate. | ||
| *ErrorUrl | The URL to which the customer is directed when an error occurs. | Available to automated external calls when creating a mandate. | ||
| *FailUrl | The URL to which the customer is directed when the transaction failed or the user clicked on 'cancel'. | Available to automated external calls when creating a mandate. | ||
| *HomeUrl | The URL to which the customer is directed when he clicks on 'home'. | Available to automated external calls when creating a mandate. | ||
| *ContactName | The name that must be used as contact setting instead of the entity name. | When this parameter is used, the parameter information will be used on the payment screen and NOT the data of the account. | ||
| *ContactMailAddress | The e-mail address to be used with contact details instead of the entity e-mail address | When this parameter is used, the parameter information will be used on the payment screen and NOT the data of the account. | ||
| *ContactPhoneNumber | The telephone number to be used with contact details instead of the entity telephone number | When this parameter is used, the parameter information will be used on the payment screen and NOT the data of the account. | ||
| *ContactAddressStreet | The street of the address to be used with contact information instead of the street of the entity | When this parameter is used, the parameter information will be used on the payment screen and NOT the data of the account. | ||
| *ContactAddressNumber | The house number of the address to be used with contact details instead of the house number of the entity | When this parameter is used, the parameter information will be used on the payment screen and NOT the data of the account. | ||
| *ContactAddressExtraAddressLine | The extra address line of the address to be used with contact information instead of the extra address line of the entity | When this parameter is used, the parameter information will be used on the payment screen and NOT the data of the account. | ||
| *ContactAddressZipCode | The zip code of the address to be used with contact details instead of the zip code of the entity | When this parameter is used, the parameter information will be used on the payment screen and NOT the data of the account. | ||
| *ContactAddressCity | The city of the address to be used with contact information instead of the city of the entity | When this parameter is used, the parameter information will be used on the payment screen and NOT the data of the account. | ||
| *ContactAddressCountry | The country of the address to be used with contact details instead of the country of the entity | When this parameter is used, the parameter information will be used on the payment screen and NOT the data of the account. | ||
| *EntityEnableFullWidthScreenHeader | Returns 'True' if the full width screen header is enabled, otherwise 'False' is returned | |||
| *EntityEnableFullWidthMailHeader | Returns 'True' if the full width mail header is enabled, otherwise 'False' is returned |
Date updated: 2020-08-18
