iDEAL

Integrating iDEAL
Integrate iDEAL using our Web SDK.
Ideal is an online payment method that enables consumers to pay through their own bank.
To enable IDEAL for your account, please contact customer support to set this up.
﻿
Prerequisites
Make sure you have implemented the following prerequisites from the Web SDK integration guide:
﻿Create a paymentSession﻿﻿
﻿Add the Payment Form to your Website﻿﻿
﻿
Step One: Add the iDEAL payment tab
The fields referred to in this step are part of the iFrame configuration object supplied in the: 
createCardDetails() (Step Two in the Prerequisites) ﻿.

Call:
judo.createCardDetails('payment-iFrame', iFrameConfiguration)
To add the iDEAL payment tab:
Ensure the array set for the enabledPaymentMethods field includes ‘IDEAL’.
For example:
enabledPaymentMethods: ['CARD', 'IDEAL']
﻿
﻿
Transaction Timeout
You can alter the timeout for iDEAL transactions by setting the field idealPollingTimeout.
Set it as the number of ms you want the timeout to be.

For example:
idealPollingTimeout: 40000 would set the transaction timeout to 40000ms (40 seconds).
If the field is not provided, the default value is 60000ms
﻿
Step Two: Making an iDEAL Transaction
Define the idealConfiguration object for the payment

Ensure the details used when creating the paymentSession match the values set in the following configuration:
iDEAL Configuration Example
const idealConfiguration = {
    judoId: "yourJudoId",
    merchantPaymentReference: "yourPaymentReference",
    merchantConsumerReference: "yourConsumerReference",
    currency: "EUR",
    amount: 10,
    country: "NL",
    accountHolderName: "Account Holder Name",
    paymentMethod: "IDEAL"
}

const idealConfiguration = {
    judoId: "yourJudoId",
    merchantPaymentReference: "yourPaymentReference",
    merchantConsumerReference: "yourConsumerReference",
    currency: "EUR",
    amount: 10,
    country: "NL",
    accountHolderName: "Account Holder Name",
    paymentMethod: "IDEAL"
}
﻿
To successfully process an iDEAL transaction, the currency must be ‘EUR’ (Euros).
Parameter
Description
judoId
String
Required﻿
Unique ID supplied by Judopay.
Specific to a merchant and/or location.
Format:
100100100
Maximum length 9 characters.
Do not include spaces or dashes.
amount
Decimal
Required﻿
﻿
﻿
The amount to process. 
Format:
Two decimal places
For currencies using a different structure please contact Judopay for support.
currency
String
Required﻿
The currency of the transaction. 
The ISO 4217 alphabetic currency code:
For iDEAL payments this must be EUR.
yourConsumerReference
String
Required﻿
Unique reference to anonymously identify your customer.
Advisable to use GUIDs.
Must be below 40 characters.
yourPaymentReference
String
Required﻿
Your unique reference for this payment. 
Format:
Maximum length 50 characters.
This value should be unique in order to protect your customers against duplicate transactions. 
With a server side integration, if a payment reference is not supplied, the transaction will not be processed.
paymentMethod
String
Required﻿
The payment method being used.
Ensure this is set to IDEAL.
accountHolderName
String
Required﻿
The name of the account holder related to this transaction.
country
String
Required﻿
The 2-letter ISO country code from which the consumer will be paying.
This must be set to NL for iDEAL payments.
﻿
2. Call getPaymentMethod() in your function that handles the payment button click for card payments.
(If this is not already set up, add a function to handle this).


getPaymentMethod() returns information on which tab is open in the iFrame. 
Call the appropriate Web SDK method to trigger the correct transaction.

For example:
If the card form tab is open, getPaymentMethod will return “CARD”.
For a payment, call:
invokePayment()
For a preAuth, call:
invokePreauth()
If the iDEAL tab is open, getPaymentMethod will return “IDEAL”.
Call:
invokePaymentWithIDEAL()
Get Payment Method Example
 function handlePaymentButtonClick() {
    const paymentMethod = judo.getPaymentMethod()
    
    if(paymentMethod === 'CARD') {
          judo.invokePayment(paymentSession, paymentConfiguration)
          .then(handleSuccess)
          .catch(handleError)
    }
    else if(paymentMethod === 'IDEAL') {
          judo.invokePaymentWithIDEAL(paymentSession, idealConfiguration)
          .then(handleSuccess)
          .catch(handleError)
    }
}
 function handlePaymentButtonClick() {
    const paymentMethod = judo.getPaymentMethod()
    
    if(paymentMethod === 'CARD') {
          judo.invokePayment(paymentSession, paymentConfiguration)
          .then(handleSuccess)
          .catch(handleError)
    }
    else if(paymentMethod === 'IDEAL') {
          judo.invokePaymentWithIDEAL(paymentSession, idealConfiguration)
          .then(handleSuccess)
          .catch(handleError)
    }
}
﻿
If you do not already have an event handler on your payment button to invoke the handlePaymentButtonClick():
Add the onclick attribute to your payment button:
<button id="submit-payment-button" onclick="handlePaymentButtonClick()"> Pay Now </button>
Make sure you have set :id ="submit-payment-button".
This is required to perform form validation, where the Pay button will be greyed out until all the information has been entered.
﻿
Step Three: Handle the Response
﻿
﻿

Parameter	Description
judoId String Required	Unique ID supplied by Judopay. Specific to a merchant and/or location. Format: 100100100 Maximum length 9 characters. Do not include spaces or dashes.
amount Decimal Required	The amount to process. Format: Two decimal places For currencies using a different structure please contact Judopay for support.
currency String Required	The currency of the transaction. The ISO 4217 alphabetic currency code: For iDEAL payments this must be EUR.
yourConsumerReference String Required	Unique reference to anonymously identify your customer. Advisable to use GUIDs. Must be below 40 characters.
yourPaymentReference String Required	Your unique reference for this payment. Format: Maximum length 50 characters. This value should be unique in order to protect your customers against duplicate transactions. With a server side integration, if a payment reference is not supplied, the transaction will not be processed.
paymentMethod String Required	The payment method being used. Ensure this is set to IDEAL.
accountHolderName String Required	The name of the account holder related to this transaction.
country String Required	The 2-letter ISO country code from which the consumer will be paying. This must be set to NL for iDEAL payments.

Updated 18 Oct 2024

PayPal

Klarna

iDEAL

Integrating iDEAL

Prerequisites

Step One: Add the iDEAL payment tab

Transaction Timeout

Step Two: Making an iDEAL Transaction

iDEAL Configuration Parameter Descriptions

Step Three: Handle the Response