Parameters
This is an overview of available parameters. Default values are set in bold.
You'll find detailed specifications for each parameter under Specification.
| Name | Values | Comment | Default value | Mandatory |
|---|---|---|---|---|
| merchantnumber | Find your merchant number in the menu Settings -> Payment system in the ePay administration | Yes | ||
| currency | See a list of currencies | Use either the currency code name or the numeric code, e.g. DKK or 208. | Yes | |
| amount | Amount in minor units | If subscription is enabled, this can be set to 0. | Yes | |
| orderid | Alphanumeric. a-Z 0-9. Max. 20 characters. See specification for more | Orderid is your reference from your shopsystem to our administration. It is also passed on to the acquirer. The use of special characters is not recommended, though they might be accepted. | No | |
| windowstate | 1 = Overlay 2 = iframe 3 = Full screen 4 = Integrated payment form | Overlay, iframe and the integrated payment form will only work correctly if you're using the simple integration. Please note that when using the integrated payment form, you can only accept payment cards (i.e. paymentcollection =1). | 1 | No |
| mobile | 0 = Disabled 1 = Auto detect 2 = Force mobile | Apply this parameter to use the mobile window. Please notice that not all payment methods are supported by the mobile window. | 1 | No |
| windowid | This defines which window to use. Available windows are found in the ePay administration under Settings -> Payment window. | 1 | No | |
| paymentcollection | 0 = Customer choice 1 = Payment cards 2 = Home Banking 3 = Invoice 4 = Mobile 5 = Other 7 = ViaBill | 0 | No | |
| lockpaymentcollection | 0 = Disabled 1 = Enabled | If paymentcollection is not 0, this is used to lock the payment collection. | 0 | No |
| paymenttype | See specification for more | Specify which payment type logos to show. Use a comma (,) to separate multiple payment types. If you don't want to accept a specific payment type, please contact our support team. | No | |
| language | 0 = Auto detect 1 = Danish 2 = English 3 = Swedish 4 = Norwegian 5 = Greenlandic 6 = Icelandic 7 = German 8 = Finnish 9 = Spanish 10 = French 11 = Polish 12 = Italian 13 = Dutch | 1 | No | |
| encoding | UTF-8 | No | ||
| cssurl | Use this to override parts of the payment window v2 stylesheet. | No | ||
| mobilecssurl | This is used to override a URL to a custom theme for the mobile window. | No | ||
| instantcapture | 0 = Manual 1 = Enabled | 0 | No | |
| splitpayment | 0 = Disabled 1 = Enabled | Please read this before using splitpayment. Split payment is supported by Nets/Teller, Clearhaus and ePay. You only need to specify the Parameter when you have Nets/Teller as acquirer | 0 | No |
| instantcallback | 0 = Asynchrony 1 = Instantly | 1 | No | |
| callbackurl | Must be a valid http or https URL. Only port 80 and 443 can be used. Accept parameters will be appended. | No | ||
| accepturl | Must be a valid http or https URL Accept parameters will be appended. | No | ||
| cancelurl | Must be a valid http or https URL. | No | ||
| ownreceipt | ** 0 = Disabled** 1 = Enabled | 0 | No | |
| ordertext | Only text is accepted. HTML will be stripped. | No | ||
| group | Max. 100 characters. | No | ||
| description | Max. 1024 characters. | No | ||
| hash | This is the MD5 string of all parameters combined with the ePay secret key. | Only if MD5 is enabled | ||
| subscription | 0 = Disabled 1 = Enabled 2 = Update subscription | subscriptionid is returned with the accept and callback parameters. If this parameter is enabled, amount can be set to 0. | 0 | No |
| subscriptionid | When subscription = 2, subscriptionid must be the ID of the subscription you want to update. | No | ||
| subscriptionname | Max. 100 characters. | No | ||
| mailreceipt | Use this to receive an email with information about the payment when it is completed. This is NOT for your customer's order confirmation. | No | ||
| googletracker | Typically in the form UA-XXXXXXX. See specification for more | No | ||
| backgroundcolor | HEX color code without #. Only used for = 1 and windowstate = 2 | A7A7A7 | No | |
| opacity | 0-100 | Only used for windowstate = 1 | 50 | No |
| declinetext | Overwrites the system decline text. | No | ||
| iframeheight | Only available for windowstate = 2. Set the iframe height in pixels (px). | 780 | No | |
| iframewidth | Only available for windowstate = 2. Set the iframe width in pixels (px). | 778 | No | |
| timeout | Defines a time span in which the payment can be completed. The value is specified in minutes, e.g. 15 for 15 minutes. | No | ||
| invoice | Type: JSON string | The invoice object as a JSON string | No | |
| phonenumber | Type: string Max-length: 8 | A Danish mobile number without the international country code, it will be prefilled in the MobilePay window when doing the actual MobilePay payment. | No | |
| accountinformation | Type: JSON string | The accountinformation object as a JSON string | No | |
| recurringfrequency | Type: integer Max value: 9999 | The minimum number of days between authorizations on the subscription. Use 1 for irregular intervals or if unknown. If no value is supplied we will default the value to 1. | No | |
| recurringexpiration | Type: string | The expiration date of the subscription, when no further authorizations will be made, in ISO 8601 format. If no values is supplied we will set a value based on the card expiration date. | No | |
| merchantrisk | Type: JSON string | The merchantrisk object as a JSON string | No | |
| subscriptiontype | Type: string Values: "recurring", "cardonfile" | Indicates if the subscription is a recurring payment subscription or a cardonfile subscription used for making MIT (Merchant Initiated) transactions. Default is recurring. | "recurring" | No |
| securitylevel | Type: string Values: "none", "require3d" | The security level to be used for SCA. No value means "no preference" and decision will be up to issuer, whereas "None" means SCA excemption, and "Required3D" means mandate SCA. | No | |
| securityexemption | Type: string Values: "LowValuePayment" | The exemption to be used, if omitted, exemption is not attempted for payment. | No |