Last Updated: 13 November 2024 | Change Log

iDEAL

iDEAL is an online bank transfer and is the most common payment method in the Netherlands. It allows customers to pay for goods or services through their bank account.

Note

Make yourself familiar with our API Principles to ensure a resilient integration.

Product Overview

Why use iDeal?

iDeal is a popular, secure and reliable online bank transfer that requires no pre-registration or enrolment. It's easy to use as your customers use their own online bank banking to complete transactions.

Feature summary

Payment type	Countries	Currencies	Recurring	Reversals	Partial Reversals	Disputes	Auth and Settlement (Sale)
Bank transfer	NL	EUR	❌	Refund - yes Cancel- No	Partial refund - yes Partial cancel- No	❌	✅

The minimum amount for a single transaction is: 0.01 EUR
The maximum amount for a single transaction is: 50.000 EUR

Available banks and bank codes

Bank name	`bankCode`
ABN AMRO	ABN_AMRO
ASN Bank	ASN
Bunq	BUNQ
ING	ING
Knab	KNAB
Rabobank	RABOBANK
RegioBank	REGIOBANK
Revolut	REVOLUT
SNS	SNS
Triodos	TRIODOS
Van Lanschot	VAN_LANSCHOT

Set your headers

Setting your headers is an important part of an API request. The headers represent the meta-data associated with your API request.

Authorization: {your_credentials}
Content-Type: application/json
WP-Api-Version: 2023-06-01

Header	Description
`Authorization`	We use the `Authorization` header to identify and authenticate you within Access Worldpay. You must use the `Authorization` header for any request you send to our APM API, unless you are using client certificate authentication over TLS. If you must use this, read our reference guide on Authenticating with SSL/TLS.
`Content-Type`	We require the `Content-Type` header if the request you're sending includes a request body, and if the HTTP method is a `POST` or a `PUT`.
`WP-Api-Version`	We use the `WP-Api-Version` header to identify which version of our APM API you are using. You must use the `WP-Api-Version` header for any request you send to our API.

If you're using both the Content-Type and WP-Api-Version headers, they must match.

Note

Replace {your_credentials} with your base64-encoded Basic Auth username and password. To get your Access Worldpay credentials contact your Implementation Manager.

Take a payment

POST https://try.access.worldpay.com/apmPayments

Example request:

application/json

{
  "transactionReference": "Memory265-13/08/1876",
  "merchant": {
    "entity": "default"
  },
  "instruction": {
    "narrative": {
      "line1": "Mind Palace Ltd"
    },
    "value": {
      "amount": 1234,
      "currency": "EUR"
    },
    "paymentInstrument": {
      "type": "ideal",
      "language": "en",
      "successURL": "https://example.com/success",
      "pendingURL": "https://example.com/pending",
      "failureURL": "https://example.com/failure",
      "cancelURL": "https://example.com/cancel"
    }
  }
}

Parameters

Parameter	Required?	Description	Data type	Length
`instruction`	✅	An object that contains all the information related to the payment.	Object	N/A
`instruction.narrative`	✅	An object that helps your customers better identify you on their statement.	Object	See our formatting rules
`instruction.narrative.line1`	✅	The first line of the narrative which appears on your customer's statement (If a character is not supported it is replaced with a space.). See narrative `line1` format for more details.	Object	24
`instruction.paymentInstrument`	✅	An object that contains information about the payment method.	Object	N/A
`instruction.paymentInstrument.type`	✅	An object that contains the payment type and details. It defines which alternative payment method you wish to use. Value is `ideal`.	Object	N/A
`instruction.paymentInstrument.language`	❌	An object that contains the language of your customer. Follows ISO 639-1 standard.	String	2
`instruction.paymentInstrument.cancelURL`	❌	When your customer cancels a transaction, we redirect your customer to that cancel URL.	String	N/A
`instruction.paymentInstrument.failureURL`	❌	When a payment fails, we redirect your customer to the failure URL.	String	N/A
`instruction.paymentInstrument.pendingURL`	❌	When we receive the payment result for a pending payment transaction, we redirect your customer to that pending URL.	String	N/A
`instruction.paymentInstrument.successURL`	❌	When we receive the payment result for a successful payment, we redirect your customer to that success URL.	String	N/A
`instruction.value`	✅	An object that contains information about the payment transaction.	Object	N/A
`instruction.value.amount`	✅	The payment amount. This is a whole number with an exponent e.g. if exponent is two, 250 is 2,50. You can find the relevant exponent in our currency table.	Integer	N/A
`instruction.value.currency`	✅	The payment currency. Refer to the individual APM page for supported currencies.	Integer	3
`merchant`	✅	An object that contains information about the merchant.	Object	N/A
`merchant.entity`	✅	Direct your payment to assist with billing, reporting and reconciliation. This is mandatory for Authentication and Queries. Contact your Implementation Manager for more details.	String	Must be between 1 and 32 characters.
`transactionReference`	✅	A unique reference generated by you that is used to identify a payment throughout its lifecycle. See transaction reference format.	String	Must be between 1 to 64 characters.
`instruction.paymentInstrument.language`	❌	An object that contains the customer's language. Follows ISO 639-1 standard.	String	2

Recommendation

We suggest you provide the cancelURL,failureURL, pendingURL and successURL attribute to redirect your customer to, once you have received the payment result.

Response

Successful request response

an HTTP code 201
an id which is unique to the payment - we recommend storing the id to use for managing your payment
a url to redirect your customer to the APM provider to complete the payment
a link to query the payment status

Example

{
    "paymentId": "nFxASqw-LV9HE_rr1mMONJmqBDeXmnv5dzt9IxAXgXbfpu0O_8mOnTpFSIM9gnTSygCKQgvlwQdUbu5rExIpJA_5Uq2LEGXXAanycRpxfDPNA-E70zIWdnaMb2gJhC8AIhbOkM6xDiVNu90YCXo2snTzi_k1sEOQnKIAJNTW3Qc",
    "lastEvent": "pending",
    "_links": {
        "self": {
            "href": "https://access.worldpay.com/apmPayments/nFxASqw-LV9HE_rr1mMONJmqBDeXmnv5dzt9IxAXgXbfpu0O_8mOnTpFSIM9gnTSygCKQgvlwQdUbu5rExIpJA_5Uq2LEGXXAanycRpxfDPNA-E70zIWdnaMb2gJhC8AIhbOkM6xDiVNu90YCXo2snTzi_k1sEOQnKIAJNTW3Qc"
        }
    },
    "_actions": {},
    "url": "https://payments.worldpay.com/app/hpp/integration/wpg/corporate?OrderKey="
}

Note

In case of an error, you can get further information in our error reference.

Next Steps

Manage your iDeal payment

iDEAL

Why use iDeal?

Feature summary

Available banks and bank codes

Set your headers

Take a payment

Example request:

Parameters

Response

Successful request response

Example

Do you like our page?