Direct Support Site

Results for

icon-search-large No search results yet
Enter your search query above
Page topics

Integration

You can process transactions via various integration modes. Check out our dedicated guides for more information about the payment flow for each mode. 

Find a high level overview in the "Process flows" tab

  • All JSON object examples feature only the mandatory properties for a valid request
  • Check out the respective chapter in our API reference for the API calls to learn which other properties you can add

Depending on the integration mode, differences apply:

Hosted Checkout Page

Add the following properties to a standard Create Hosted Checkout request:


{
	"HostedCheckoutSpecificInput": {
		"ReturnUrl": "https://yourReturnUrl.com"
	},
	"Order": {
		"AmountOfMoney": {
			"Amount": 100,
			"CurrencyCode": "EUR"
		}
	}
}

Properties Remarks

hostedCheckoutSpecificInput.returnURL

The URL we redirect your customers to after the payment has been finalised

order.amountOfMoney

Amount

CurrencyCode

Amount: The gross amount you want to charge for this order
CurrencyCode: The ISO 4217 currency code for this amount

Hosted Tokenization Page

Add the following properties to a standard Create Payment request (including mandatory 3-D Secure v2 parameters):


{
	"CardPaymentMethodSpecificInput": {
		"Token": "tokenId",
		"ThreeDSecure": {
			"RedirectionData": {
				"ReturnUrl": "https://yourRedirectionUrl.com"
				}
			}
		},
		"Order": {
			"AmountOfMoney": {
				"Amount": 100,
				"CurrencyCode": "EUR"
			},
			"Customer": {
				"Device": {
                                "AcceptHeader": 
"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3", "Locale": "en_EN", "TimezoneOffsetUtcMinutes": -180, "UserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.142 Safari/537.36", "Browserdata": { "ColorDepth": 24, "JavaScriptEnabled": false, "ScreenHeight": "1080", "ScreenWidth": "1920" } } } } }

Properties Remarks

cardPaymentMethodSpecificInput.Token

Token: The tokenised credit card credentials you have received by tokenising the credentials/getting the token. Learn more in our dedicated Hosted Tokenization Page guide

cardPaymentMethodSpecificInput.ThreeDSecure

redirectionData.returnURL

skipAuthentication

returnURL: The URL we redirect your customers to after the payment has been finalised
skipAuthentication: Indicate whether to roll out 3-D Secure for this order

order.amountOfMoney

Amount

CurrencyCode

Amount: The gross amount you want to charge for this order
CurrencyCode: The ISO 4217 currency code for this amount

customer.device

acceptHeader

locale

timezoneOffsetUtcMinutes

userAgent

browserdata

      colorDepth

      javaScriptEnabled

      screenHeight

      screenWidth

Minimum properties to comply with PSD2-regulations for 3-D Secure authentication.

Check our dedicated guide to learn how to request 3-D Secure correctly and our API reference for more information about the properties.

Server-to-server

Add the following properties to a standard Create Payment request (including mandatory 3-D Secure v2 parameters):

{
	"CardPaymentMethodSpecificInput": {
		"PaymentProductId": 1,
		"SkipAuthentication": false,
		"Card": {
			"CardholderName": "John Doe",
			"CardNumber": "0000000000000000",
			"Cvv": 123,
			"ExpiryDate": 1236
		},
		"ThreeDSecure": {
			"RedirectionData": {
				"ReturnUrl": "https://yourRedirectionUrl.com"
			}
		}
	},
	"Order": {
		"AmountOfMoney": {
			"Amount": 100,
			"CurrencyCode": "EUR"
		},
		"Customer": {
			"Device": {
				"AcceptHeader": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3",
				"Locale": "en_EN",
				"TimezoneOffsetUtcMinutes": -180,
				"UserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.142 Safari/537.36",
				"Browserdata": {
					"ColorDepth": 24,
					"JavaScriptEnabled": false,
					"ScreenHeight": "1080",
					"ScreenWidth": "1920"
				}
			}
		}
	}
}

Properties Remarks

cardPaymentMethodSpecificInput.paymentProductId

cardPaymentMethodSpecificInput.card

      cardholderName
      cardNumber
      cvv
      expiryDate

cardPaymentMethodSpecificInput.ThreeDSecure

redirectionData.returnURL

skipAuthentication

paymentProductId: The numeric identifier of the payment method on our platform. Find this id in the "Overview" tab


cardPaymentMethodSpecificInput.card: The credentials of the card used for the payment
Make sure to fulfill the necessary PCI DSS requirements for sending sensitive data

returnURL: The URL we redirect your customers to after the payment has been finalised
skipAuthentication: Indicate whether to roll out 3-D Secure for this order

order.amountOfMoney

Amount

CurrencyCode

Amount: The gross amount you want to charge for this order
CurrencyCode: The ISO 4217 currency code for this amount

customer.device

acceptHeader

locale

timezoneOffsetUtcMinutes

userAgent

browserdata

      colorDepth

      javaScriptEnabled

      screenHeight

      screenWidth

Minimum properties to comply with PSD2-regulations for 3-D Secure authentication.

Check our dedicated guide to learn how to request 3-D Secure correctly and our API reference for more information about the properties.

Find detailed information about the different API calls/properties in our API reference