These docs are for v1.2. Click to read the latest docs for v3.0.

Create the Checkout

To create the checkout you need to combine the data from the service (via: load Configuration), the Images & Icons with the details of the transactions. With some basic JavaScript of Server-Side Scripting you can show the different Payment Options.

paymentMethodList

In this list you find all active Payment methods with the preferences based on the Merchant and Sales Location. You can loop trough this list and display the Payment Methods. If you have a multilanguage checkout, you can show if available the name of the Payment Method based on the Locale of the payer. If it does not exist in the nameTranslation Object, fallback to the ' name' object as default.

"paymentMethodList": {
			"iDEAL": {
                "id": 10,																	
				"nameTranslations": {
					"nl_NL": "iDEAL",
					"de_DE": "iDEAL"
				},
				"state": "ACTIVE",										 
				"useOnlyInStore": "0",
				"image": "/payment_profiles/100x100/10.png",
				"min_amount": "1",
				"max_amount": "1000000",
				"requiredFields": "",
				"options": {
					"1": {
						"name": "ABN Amro",
						"image": "/payment_issuers/icon/PNG/1.png"
					},
					"11": {
						"name": "Van Lanschot",
						"image": "/payment_issuers/icon/PNG/11.png"
					}
				}
						
			},

If there is a options List, you can put the option list direct in the checkout. If there is only 1 item in the option list we recommand that you do not show the option in the checkout, but auto select it and send it in to the Transaction Gateway Unit.

IP Filtering

If you receive the IP-filter array for some payment methods you need to show or hide the payment block, based on the type. This feature is used for shared checkouts where an payer can make a eCom transaction (from home) and a POS (instore) transaction in the same software.

Type

Action

ALLOW_FROM_ALL

Show the Payment Option to all IP addresses, except the ones in the exceptionList.

DENY_FROM_ALL

Do not show the Payment Option to any payer, except the ones that are connect trough an IP address in the exceptionList

"ipFilter": {
					"1": { 
						"name": "kantoor enschede",
						"type": "ALLOW_FROM_ALL",									
						"exceptionList": ["192.168.10.23","192.168.10.24"]
					}

paymentMethodOrder

The PaymentmethodOrder object contains information about preferred display of paymentMethods. We suggest that you use the county of delivery of the product as 'indicator for the country, you can also use the first 2 digits of the browser language or the shop's checkout language.

"paymentMethodOrder": {                                             
        "default: {
            "relevant": [10,20],
            "other": [739,1813,694],
        },
        "NL": {                                                                       
            "relevant": [10,20,739],
            "other": [694,1813]
        },
        "DE": {
            "relevant": [694,20],           
            "other": [10,739,1813]
        }
      },

There is always a default paymentMethodOrder with: 'relevant' and 'other'. Payment methods that are not in these 2, should not be shown if the country of the user is not declared in the Country list.

Example Checkout

2192

Excample checkout page

If the user is from The Netherlands, we will show the Payment Methods that are in [10,20,739) and other will be filled with the icons of [694,1813]. Other payment Methods are not shown, As the locale is set to the nl-NL, we pick the language-tag according to that locale per payment method.

Payment Method with OptionGroup

581