You are here:

Mandate parameters

The 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 NAMEDESCRIPTIONFORMATMANDATORYCOMMENTS
*MandateContractThe name of the contract that must be used for this mandateStringx
*LanguageCodeThe mandate request languagexx-XX (i.e. en-US)If empty: entity language is used
*MandateNumberThe unique number for this mandate requestString?If empty: the mandate provider will create one
*MandateProviderLinkUrlAn optional link to the mandate if this is known alreadyString?If empty: the mandate provider will create one. If supplied [*MandateNumber] is mandatory too
*DescriptionA brief description for this mandateStringx
*CurrencyCodeThe currency of the amountXXX (i.e. EUR, USD)If empty: entity currency is used
*AmountThe total amount to payDecimal (xx,xx or xx.xx)
*GenderGender of the clientChar (M, F or U)If empty: U (unknown) is used
*FirstNameThe first name of the clientString?Not mandatory for Twikey
*LastNameThe last name of the clientString?Not mandatory for Twikey
*MailAddressMail addressString ([email protected])xAlways mandatory
*MailAddressesCCMail address(es) in the CC (; separated)String ([email protected]); ([email protected])Only interesting when SendType is mail
*PhoneNumber(Mobile) phone numberStringOnly mandatory when SendType is sms
*StreetThe street of the customer or companyStringx
*NumberThe number of the streetStringx
*ZipCodeThe zip code of the addressStringx
*CityThe city name of the addressStringx
*CountryThe country of the addressStringx
*CompanyNameCompany nameString?Mandatory if company number is supplied
*CompanyNumberCompany number (ie:VAT number)String?Mandatory if company name is supplied
*SendTypeIndicates via what medium a mandate request link must be sentmail, sms or nosendIf empty: nosend
*SendDateTimeThe date when a mandate request must be sent to the customerDateIf empty: current date and time (send immediately)
*ExpirationDateTimeThe date that this request will expireDateIf empty: default expiration time after send is used
*MailTemplateThe 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
*MessageTemplateThe 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
*ShortenedUrlYou can supply a shortened URL that has been created beforeStringThe URL must be valid and unique. If left empty, the system will generate a shortened URL
*AcceptUrlThe URL to which the customer is directed after a successful transaction.Available to automated external calls when creating a mandate.
*DeclineUrlThe URL to which the customer is directed after a rejected transaction.Available to automated external calls when creating a mandate.
*ErrorUrlThe URL to which the customer is directed when an error occurs. Available to automated external calls when creating a mandate.
*FailUrlThe 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.
*HomeUrlThe URL to which the customer is directed when he clicks on 'home'. Available to automated external calls when creating a mandate.
*ContactNameThe 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 addressWhen this parameter is used, the parameter information will be used on the payment screen and NOT the data of the account.
*ContactPhoneNumberThe telephone number to be used with contact details instead of the entity telephone numberWhen this parameter is used, the parameter information will be used on the payment screen and NOT the data of the account.
*ContactAddressStreetThe street of the address to be used with contact information instead of the street of the entityWhen 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 entityWhen 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 entityWhen this parameter is used, the parameter information will be used on the payment screen and NOT the data of the account.
*ContactAddressZipCodeThe zip code of the address to be used with contact details instead of the zip code of the entityWhen 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 entityWhen 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 entityWhen this parameter is used, the parameter information will be used on the payment screen and NOT the data of the account.
*EntityEnableFullWidthScreenHeaderReturns 'True' if the full width screen header is enabled, otherwise 'False' is returned
*EntityEnableFullWidthMailHeaderReturns 'True' if the full width mail header is enabled, otherwise 'False' is returned
Date updated: 2020-08-18
Trust Guard