Parameters

📘
We are working on this section!
You can use the 'suggest edits' , send an email to [email protected] or use our developers Slack channel to contribute.

Basic parameters

Here are the parameters that can be used directly in the JSON request.

Parameter	Description	Format	Example
transactionId	The Id of the transaction.	String	EX-0000-0000-0000
serviceId	The service id of your service starting with SL.	String	SL-0000-0000
description	Is shown on the statement of the payer.	String (32)
reference	The merchant identification of this transaction. This field only allows alphanumeric characters.	String (64)
language	The ISO-639 language code consisting of 2 uppercase letters.	String (2)	XX (e.g. EN, NL, DE)
expire	Expire date in `<<glossary:UNIX Time>>` format.	Integer	1641288359
returnUrl	The URL where the customer has to be sent to after the payment.	Uri	`<https://www.my-website.com/return>`
exchangeUrl	The URL where we exchange the status of a transaction.	Uri	`<https://my-website.com/exchange>`
domainId	The ID of the duplicate content URL.	String	WU-XXXX-XXXX
amount	The data for the transaction amount	Object
paymentMethod	The data for the payment method to be used	Object
transfer	The data for the transfer of funds to another merchant account.	Object
integration	Use test mode or live.	Object
customer	Data of the enduser.	Object
order	Order data containing several objects.	Object
stats	Data for tracking on your side.	Object
notification	Notification data.	Object
[transferData](#TransferData- parameters)	Data to be tracked in the transaction.	Array of Objects
transaction	Transaction data.	Object

Amount parameters

Here are the parameters that can be used within the 'amount' object.

Parameter	Description	Format	Example
value	The amount in cents.	Integer	10
currency	The currency in ISO-4217 format.	String (3)	XXX (e.g. EUR, GBP, USD)

Payment Method parameters

Here are the parameters that can be used within the 'paymentMethod' object.

Parameter	Description	Format	Example
id	The ID of the payment option.	Integer (4)	10 (iDEAL) See list
subId	The chosen sub ID of the payment option e.g. the bank id for iDEAL.	Integer (4)	1 (ABN AMRO) See list

Integration parameter

Here are the parameters that can be used within the 'integration' object. This overrules the setting for the Sales Location in the Admin.

Parameter	Description	Format	Example
testMode	Use testmode or not, regardless of the actual status of the Sales Location.	Boolean	false, true (0,1)

Transfer parameters

Here are the parameters that can be used within the 'transfer' object.

Parameter	Description	Format	Example
value	Use a valid MerchantId or orderId.	String	M-1234-1234 or 12345678
type	Use transaction, merchant or alliance to change the beneficiary owner of the transaction.	String
data	Option to send multiple values via an array which can be tracked in the stats.	Array

Order parameters

Here are the parameters that can be used within the 'order' object.

Parameter	Description	Format	Example
countryCode	When used this countryCode takes preference over the one set in the deliveryAddress and is then used as the countryCode for this transaction	string (2)	XX (e.g. NL, BE, DE)
deliveryDate	The date of delivery	Date	2022-01-01
invoiceDate	The date of the invoice	Date	2022-01-01
customer	The data of the customer	Object
deliveryAddress	The data of the delivery address.	Object
invoiceAddress	The data of the invoice address.	Object
products	The data of the products of the order	Object

Customer parameters

Here are the parameters that can be used within the 'customer' object.

Parameter	Description	Format	Example
firstName	The forename (also known as a given name, Christian name or a first name). Must contain at least two characters.	String (64)	John
lastName	The surname (also known as a family name or a last name).	String (64)	Doe
ipAddress	An ip address.	String	139.130.4.5
birthDate	Date of birth as defined in ISO-6801.	Date	1981-12-31
gender	The subject's gender. Choose either M for male or F for female.	String (1)	M, F
phone	The subject's phone number. Optionally prepended with a + and country code.	String	+31612345678
email	An email address.	String	[email protected]
locale	The language that can be used in the payment pages available locales	String XX-xx	nl_NL
trust	Indicates whether you trust the payer, scale -10 -> 10 (10 Reliable, -10 Unreliable).	Integer	-5
reference	Unique reference of the payer. This field only allows alphanumeric characters.	String (64)	customer12345678
company	The data of a company when processing a business order.	Object

Bank Account parameters

Here are the parameters that can be used within the 'bankAccount' object.

Parameter	Description	Format	Example
iban	The International Bank Account Number (IBAN).	String	NL91ABNA0417164300
bic	Business Identifier Codes (BIC/SWIFT) of the customer's bank.	String	INGBNL2A
owner	The owner of the bank account.	String

Company parameters

Here are the parameters that can be used within the 'company' object.

Parameter	Description	Format	Example
name	The name of your merchant.	String	Wayne Enterprises
coc	Your Chamber of Commerce registration number. This format differs per country.	String	12345678
vat	Value added tax identification number (VAT identification number).	String	NL807960147B01
countryCode	The ISO-3166 country code consisting of 2 uppercase letters.	String (2)	XX (like NL, BE, DE)

Location parameters

Parameter	Description	Format	Example
streetName	The name of the street.	String (128)
streetNumber	The street number.	String (32)
streetNumberExtension	A house number extension is required to deal with appartments or other addresses sharing the same front door.	String (32)
zipCode	A zip/postal code. see https://en.wikipedia.org/wiki/List_of_postal_codes for a list of formats per country.	String (16)
city	The name of a city	String (128)	New York
regionCode	The ISO-3166-2 region code for Canada & US	String (12)	XX-XX (like US-NY, CA-AB)
countryCode	The ISO-3166 country code consisting of 2 uppercase letters.	String (2)	XX (like NL. BE, DE, US)

Delivery or Invoice Address parameters

Here are the parameters that can be used within the 'deliveryAddress' or 'invoiceAddress' objects.

Parameter	Description	Format	Example
firstName	The forename (also known as a given name, Christian name or a first name).	String (64)	John
lastName	The surname (also known as a family name or a last name).	String (64)	Doe
streetName	The name of the street.	String (128)
streetNumber	The street number.	String (32)
streetNumberExtension	A house number extension is required to deal with appartments or other addresses sharing the same front door.	String (32)
zipCode	A zip/postal code. see https://en.wikipedia.org/wiki/List_of_postal_codes for a list of formats per country.	String (16)	10021
city	The name of a city	String (128)	New York
regionCode	The ISO-3166-2 region code for Canada & US	String	XX-XX (like US-NY, CA-AB)
countryCode	The ISO-3166 country code consisting of 2 uppercase letters.	String (2)	XX (like NL. BE, DE, US)

Products parameters

Here are the parameters that can be used within the 'products' object.

Parameter	Description	Format	Example
id	The product identifier.	String
description	The description of the product.	String
type	The type of product. See list of product types.	String	shipping, article, discount, rounding, handling, payment, credit, giftcard, emoney, crypto
quantity	The quantity.	Float
vatCode	The VAT code to use.	String (1)	N, H, L
price	The date for the price of the product.	Object

Price parameters

Here are the parameters that can be used within the 'price' object.

Parameter	Description	Format	Example
value	The amount in cents.	Integer
currency	The currency in ISO-4217 format.	String (3)	XXX (like EUR, GBP, USD)

Stats parameters

Here are the parameters that can be used within the 'statistics' or 'stats' objects.

Parameter	Description	Format	Example
info	The used info code which can be tracked in the stats.	String (64)	Campagne 99
tool	The used tool code which can be tracked in the stats.	String (64)	Google
extra1	The first free value which can be tracked in the stats	String (64)
extra2	The second free value which can be tracked in the stats.	String (64)
extra3	The third free value which can be tracked in the stats.	String (64)
domainId	The ID of the duplicate content URL.	String	WU-XXXX-XXXX

Notification parameters

Here are the parameters that can be used within the 'notification' object.

Parameter	Description	Format	Example
type	Use "push" for push messages, or "email" to send out an email.	String	push, email
recipient	The recipient of the notification. Use "push" or "email"	String	For push messages, use your device id (AD-0000-0000). For email, provide a valid email address.

Transaction parameters

Here are the parameters that can be used within the 'transaction' object.

Parameter	Description	Format	Example
type	Defines the type of the transaction. Possible values are: CIT = Customer Initiated Transaction, MIT = Merchant Initiated Transaction, MOTO = Customer initiated payment where card number is entered manually, POS = Point of sale, ECOM (simple webshop transaction).	String	CIT, MIT, MOTO, POS
exchangeUrl	The URL of the exchange that needs to be called.	String
expireDate	Timestamp (`<<glossary:UNIX Time>>`) of the date the transaction should expire.	Number	1636396628

Options parameter

Here is the parameter that can be used within the 'transaction' object.

Parameter	Description	Format	Example
tokenization	Include the tokenize option in the options array and set the value to override the default settings for this payment. Possible values are: -1 = disable, 1 = enable or 0 = use default.	Number	-1, 0, 1

Payment parameters

Here are the parameters that can be used within the 'transaction' object.

Parameter	Description	Format	Example
method	Defines the method in which the card details are submitted. Choose CSE when submitting the details in cse format, card when submitting plain card data. Note: the corresponding array must be included in the request.	String	cse, card, token
cse	The data for Client Side Encrypted cards.	Object
card	The card data.	Object
token	The data of the token.	Object
browser	The data of the client's browser.	Object
auth	The data of the authorization.	Object

CSE parameters

Here are the parameters that can be used within the 'cse' object.

Parameter	Description	Format	Example
data	The encrypted card details, base64 encoded. See the card option for the fields that should be part of the encrypted card data.	String
identifier	ID of the public key that is used to encrypt the card details.	String

Card parameters

Here are the parameters that can be used within the 'cse' object.

Parameter	Description	Format	Example
number	The customer's card number.	String
expire_month	Expire month of the card in MM format (2 digits).	String (2)	02
expire_year	Year the card expires in YY format (2 digits).	String (2)	26
cvc	Card verification code / safekey code of the card used.	String (3)	111
name	The name of the consument as printed on the card.	String	J. Doe

Token parameter

Here is the parameter that can be used within the 'token' object.

Parameter	Description	Format	Example
id	Token retrieved form earlier transaction with the card.	String (17)	VY-1002-3004-5006

Browser parameters

Here are the parameters that can be used within the 'browser' object.

Parameter	Description	Format	Example
javaEnabled	Indicator that represents the ability of the cardholder browser to execute Java.	String	true, false
javascriptEnabled	Indicator that represents the ability of the cardholder browser to execute Javascript.	String	true, false
language	Value representing the browser language as defined in IETF BCP47.	String (5)	nl-NL, nl-BE, fr-BE, de-DE etc.
colorDepth	Value representing the bit depth of the colour palette for displaying images, in bits per pixel. Possible values: 1 = 1 bit, 4 = 4 bits, 8 = 8 bits, 15 = 15 bits, 16 = 16 bits, 24 = 24 bits, 32 = 32 bits, 48 = 48 bits.	Number	1, 4, 8, 15, 16, 24, 32, 48
screenHeight	Total height of the card holder’s screen in pixels.	Number
screenWidth	Total width of the card holder’s screen in pixels.	Number
tz	Time difference between UTC time and the Cardholder browser local time, in minutes.	Number

Auth parameters

Here are the parameters that can be used within the 'auth' object.

Parameter	Description	Format	Example
dsTransactionId	The identifier of the `<<glossary:3DSECURE>>` authentication session.	String
acquirerID	The identifier of the 3DS2 authentication session.	String
cryptogram	Authentication value/cryptogram received from your `<<glossary:3DSECURE>>` or Wallet provider.	String
eci	ECI (Electronic Commerce Indicator) returned by `<<glossary:3DSECURE>>` provider indicating the outcome of authentication attempted.	Number
version	Provide the protocol version returned by your 3DSecure provider.	String
type	The type of 3DSecure authentication.	String	challenged, frictionless, wallet
walletProvider	When processing Wallet payments like Apple Pay or Google Pay the corresponding value must be selected. Submitting Wallet cryptograms without the wallet provider correctly set, can result in declines or non-3ds processed transactions.	String	applepay, googlepay
payTdsTransactionId		String
payTdsAcquirerId		Number

systemstates

This object returns information about the state of a requested Object from the PAY core in the merchant Management API's, so you can easily track the entities (users or tokens) that were in interaction with the Object. You can save this data to check if the data is updated.

Deleted objects are shown for 35 days, after that period an object is permanent deleted.

Parameter	Description	Format	Example
createdAt	Timestamp when the object was created for the first time.	YYYY-MM-DDTYY:MM:SS + Timezone	2022-03-18T14:35:21+02:00
createdBy	Entity that created the Object, can be a accountcode or a Token	systemObject format YY-####-####	A-3230-3029 AT-1234-5678
modifiedAt	Timestamp when the object was modified for the last time	YYYY-MM-DDTYY:MM:SS + Timezone	2022-03-18T14:35:21+02:00
modifiedBy	Entity that modified the object	systemObject format YY-####-####	A-3230-3029 AT-1234-5678
deletedAt	Deleted date, can be null for active records,.	YYYY-MM-DDTYY:MM:SS + Timezone or 'null'	2022-03-18T14:35:21+02:00
deletedBys	Entity that deleted the object	systemObject format YY-####-####	A-3230-3029 AT-1234-5678

[
   {
      "code":"CY-####-####",
      "name":"XXXXXXXXXXX",
      "description":"XXXXXXXXX",
      "sequence": 1,
      "available":true|false,
      "translations":{
         "name":{
            "nl_NL":"XXXXXXXXX",
            "en_GB":"XXXXXXXXX",
            "it_IT":"XXXXXXXXX"
         },
         "description":{
            "nl_NL":"XXXXXXXXX"
         }
      },
      "createdAt":"2022-03-18T14:35:21+02:00",
      "createdBy":"XX-####-####",          				//can be an AT code (systemToken) or an A-code (loged in user) or AL-code (licence)
      "modifiedAt":"2022-03-18T15:24:52+02:00",
      "modifiedBy":"XX-####-####",
      "deletedAt":null,														//Entry is not deleted yet
      "deletedBy":null
   }
]

Translations

We use multi language options to deliver our services to merchant, users and payers (entities). In most cases you will get the basic fields in English and - when available - an array with active locales and their translations. If the entity is assigned to a locale that is available we suggest that you show that translation. If it doesn't exist, please fall back to the default.

We use the BCP-47 standard for the naming of possible locales.

Parameter	Description	Format	Example
# object#	Name of the object that is translated.	String (64)	Sale
# object#[nl-NL]	The translation for the object in locale [nl-NL]	String (132)	Korting
# object#[nl-BE]	The translation for the object in locale [nl-BE]	String (132)	Solden
# object#[de-DE]	The translation for the object in locale [de-DE]	String (132)	Verkauf

[
   {
      "code":"CY-####-####",
      "name":"Elektronics",                  			       		                // Default name of the entity.
      "description":"Televisions, home cinema sets  and other electornic devices",  // Default description of the entity
      "sequence": 1,
      "available":true|false,
      "translations":{
         "name":{
            "nl_NL":"Elektronica",      // Dutch translation of the 'name' object
            "it_IT":"Elettro"		    // Italian translation of the 'name' object
         },
         "description":{
            "nl_NL":"TV's en zo"         // Dutch translation of the 'description' object
         }
      }
   }
]