Please wait ...


Loading...

Specification

This section describes the available parameters separately.

merchantnumber

Required 
You have two merchant numbers: a test merchant number (used for testing only) and production merchant number for real payments. Find your merchant numbers in the ePay menu under Settings -> Payment system.

currency

Required
The currency parameter accepts the currency number as well as the currency code, e.g. 208 or DKK. Find a complete list of valid currencies here.

amount

Required
The amount specified in minor units. For the currency GBP, the amount must be specified in “pennies”. An amount of GBP 104,99 must be specified as 10499. For currencies without minor units, the amount 95 is specified as 95.

The parameter doesn’t accept any separators (e.g. dot (.) as thousands separator).

amount can be set to 0 (zero) if subscription is enabled.

orderid

The order ID from your own system. This order ID is used as reference between your own system and ePay. Any numbers from 0-9 and characters from a-Z are allowed.

Non-numeric characters will be stripped for Swedbank.


Notice!

Nets/Teller supports up to 9 characters in the order ID.
Bambora and Swedbank support a maximum of 12 characters.

windowid

Define which payment window to use. If you have several shops/domains and want to open different payment windows (with different logos or settings) for each domain, use the parameter windowid to govern which window to open.

You can see your payment windows in the ePay administration under Settings -> Payment window.

mobile

This parameter is used to activate the mobile payment window. Please note that not all payment methods are supported by the mobile payment window.

NameValue
Deactivated0
Auto detect (default)1
Force2

paymentcollection

A payment collection is a grouping of all the different payment types. By setting this value, the payment window will open with this collection method selected.

Customer choice0
Payment cards1
Giftcard6
Home banking2
Invoice3
Mobile4
Other5
ViaBill7

lockpaymentcollection

You can lock your payment collection method if paymentcollection is set. This means the customer cannot change the collection method. For instance, if you only want to accept payments by payment card, set paymentcollection to 1 and lockpaymentcollection to 1.

Disabled0
Enabled1
 

paymenttype

The paymenttype parameter is used to define which payment types logos to show. You can define multiple payment types by separating the values with comma (,). For instance, if you only want to accept Dankort, Visa, and MasterCard, use the following value: 1,3,4. This will not block payments from payment types not defined. Contact ePay if you don’t want to accept payments from a specific payment type.

A defined payment type is ignored if paymentcollection is set and the payment type is not in this collection.

NameValuePayment method
Dankort/Visa Dankort1Payment cards
Visa / Visa Electron3Payment cards
Mastercard4Payment cards
JCB6Payment cards
Maestro7Payment cards
Diners Club8Payment cards
American Express9Payment cards
Forbrugsforeningen11Payment cards
Danske Netbetalinger13Home banking
PayPal14Other
Klarna17Invoice
SveaWebPay18Invoice
SEB (SE)19Home banking
Nordea (SE)20Home banking
Handelsbanken (SE)21Home banking
Swedbank (SE)22Home banking
ViaBill23ViaBill
Beeptify24Other
iDEAL25Home banking
Paii27Mobile
Brandts Gavekort28Giftcard
MobilePay Online29Mobile

language

This is the language displayed in the payment window. If you use auto detection and the found language is not available, the language shifts to English.

If this parameter is not defined, the default setting is Danish.

You can edit the texts shown in the payment window. To do so, go to Settings -> Payment window in your ePay administration, and open the translation tool. Next, click on ‘Create language’, choose the language you want to create, and attach it to a country. Press the button ‘Edit translations’ by the language you just created. You will now see the language files, and you can edit the translations for the language.

Auto Detect (default)
0
Danish1
English2
Swedish3
Norwegian4
Greenlandic5
Icelandic6
German7
Finnish8
Spanish9
French10
Polish11
Italian12
Dutch13

encoding

The encoding of your data. The standard format is UTF-8.

cssurl

This parameter overrides parts of the payment window stylesheet. To use this parameter, a valid http or https URL pointing to the location of your stylesheet must be specified.

Please download our example of a CSS stylesheet here.

mobilecssurl

Set a custom theme for the mobile window with this parameter.

Our mobile theme can be downloaded from here.
Start by importing this into ThemeRollerModify the theme and download it. Upload the *.css file to your website, and set the mobilecssurl to the public location. The mobile window will now use your custom theme.

instantcapture

Enable this parameter to capture payments instantly (as soon as they are authorised). By default, this value is 0, and the payment must be captured manually in the ePay administration.

You may only use this parameter if the goods are delivered instantly, such as downloads or services.

Notice!

When using instantcapture for payments to Teller, two operations are made: authorize and capture. Sometimes the capture fails, which results in a complete decline of the transaction.

Capture manually0
Enabled 1

splitpayment

If an order is split into several deliveries, this parameter can be enabled to capture the payments as the deliveries are shipped. As such, you can split the payment into two or more transactions and capture smaller parts of the amount one at a time.

At this point, Nets and Teller are the only acquirers that support split payments. The other acquirers will be added later.


Notice!
If splitpayment is enabled and is not supported by the acquirer, the payment will be processed as a regular payment which cannot be split into several transactions.

splitpayment
is not available for 3D Secure payments.

Disabled0
Enabled1

accepturl

The URL to which customers are sent when the payment is approved and the payment window is closed. If ownreceipt is set to 1, the customer is sent directly to the accepturl.

cancelurl

This is a URL the customers are directed to if the payment window is closed before the payment is completed. This is only used if windowstate is 3.

Notice!
The domain must be registered in your ePay administration under Settings -> Payment system. If the domain is not registered, you will get an error message.

callbackurl

This URL is used to update the ordering system, also called (I)PN or (Instant) Payment Notification. When the payment is approved, ePay calls this URL as if it was an accepturl (server to server).

Notice!
The domain must be added in your ePay administration under Settings -> Payment system. If the domain is not registered, you will get an error message.

instantcallback

If you use callbacks, you can set this parameter to determine when your callbackurl is called.

Asynchronously0
Enabled1

ownreceipt

When using this parameter, the customers are redirected to your accepturl as soon as the payment is made. The receipt shown in the payment window is skipped. A valid accepturl must be defined to use ownreceipt.

Receipt in the payment window0
Own receipt1

ordertext

This defines a text shown in the payment window while the payment is being completed, and on the receipt. The text will appear on the printout of the receipt.

group

The group to which the payment is associated. The parameter is a string which can contain a-Z and 0-9. If the group doesn't exist, it is automatically created when you start using the parameter.

Click here to read more about groups.

description

This is the description of the payment. This description can be seen in the ePay administration. Please remember to use encoding to avoid issues with special characters.

hash

This field is used to create an MD5 stamp in the internet shop, which is validated by ePay to avoid customers manipulate with the data. The stamp has to be created by the value of all parameters sent to ePay combined with the ePay secret key.

Examples are available here.

subscription

If this parameter is enabled, a subscription is created. The amount can be set to 0 (zero) to create a new subscription without completing a transaction. A unique subscriptionid will be returned to your accepturl and callbackurl.

When you want to make a new authorisation on your subscription, you must complete it through our subscription web service.
Notice:
You need a separate agreement with your acquirer to use this feature. Please contact your acquirer for more information.

Disabled (default)0
Create subscription1
Update subscription2



Notice
A subscription cannot be created if you're using one of the following payment methods:

  • Nordea e-betaling
  • Danske Netbetaling
  • PayPal

subscriptionid

When subscription = 2, subscriptionid must be the ID of the subscription you want to update.

subscriptionname

This can be used in connection with subscription. If subscription is set to 1, a name or reference can be specified. If not set, the value of orderid will be used as the subscriptionname.

mailreceipt

Use this to receive an email with information about the payment when it is completed. This is NOT used for your customer's order confirmation.

googletracker

This field is used in order to track your orders using Google Analytics. Typically it will be in the form UA-XXXXX-X.

In Analytics, these pages are the tracked:

/epay-close.html => Payment window is closed.
/epay-decline.html => Payment rejected - the customer can try again.
/epay-accept.html => Payment accepted.
/epay-payment.html => Customer is sent to the payment window.
/epay-selectpayment.html => Customer chooses payment.

You have to set up 'cross domain auto linking' to track correctly. Please read more here: https://developers.google.com/analytics/devguides/collection/analyticsjs/cross-domain#autolink

If you want to track your conversions, we recommend that you use ownreceipt to send your customer to your own order receipt page.

backgroundcolor

This defines the background color for the payment window if windowstate is either 1 or 2. For windowstate = 1, the background color is affected by the opacity parameter.

opacity

This specifies the opacity of the backgroundcolor if windowstate is 1. The opacity can be set to a value between 0 and 100.

declinetext

This overwrites the text shown when a payment is declined.

timeout

Define a time span in which it is possible to complete the payment. The value of timeout equals the number of minutes, e.g. "15" for 15 minutes.

invoice

The invoice parameter is used to handle invoice payments. Click here to read more about invoice data.