iDeal
Overview
Introduction
iDeal is a payment method which allows to process payments in euros by using bank accounts in the Netherlands. This method supports purchases and refunds.
This article provides information about working with the iDeal method: general insights are presented in the Overview section, while information about the actions required to process payments and perform other actions is presented in the sections that follow.
General information
Payment method type | bank payments |
---|---|
Payment instruments | bank accounts |
Countries and regions | NL |
Payment currencies | EUR |
Currency conversion | on the ecommpay side |
One-time purchases | + |
Credential-on-file purchases | – |
Full refunds | + |
Partial refunds | + |
Payouts | – |
Chargebacks | – |
Notes | – |
Onboarding and access fee | refer to your ecommpay key account manager, additional information available in the ecommpay shop |
Interaction diagram
Payment processing by using the iDeal method involves the merchant's web service, one of ecommpay interfaces, the ecommpay payment platform, and technical facilities of the iDeal service.
Operations support
Various platform interfaces can be used to process payments and perform operations using the iDeal method. Purchases can be processed by using Payment Page, Gate and Dashboard (using payment links), refunds—by using Gate and Dashboard. At the same time, regardless of the interfaces used, the following limitations are applicable.
When working with the iDeal the following limitations are applicable.
Amounts, EUR | ||
---|---|---|
minimum | maximum | |
Purchases | 0,01 | – |
Full refunds | – | – |
Partial refunds | – | – |
Processing scenarios
To perform a purchase by using the iDeal method, you need to redirect customer to the iDeal service, while to make a refund, you need to receive a request from the customer and notify the customer about the result of the refund via the web service.
Scenarios for performing operations via the main interfaces of the payment platform correspond to those presented in the diagrams. Similarly, when additional features (such as payment links) are used, scenarios for performing operations also correspond to the specifics of those features.
Purchase by using Payment Page
General information
To process a purchase through Payment Page by using the iDeal method, the merchant's web service is required to send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of purchase processing are provided below.
Information about the formats of requests and callbacks used for processing payments by using the iDeal method via Payment Page is presented further in this section; general information about working with the Payment Page API is presented in Interaction concepts.
Request format
There are several things you need to consider when requesting a payment through the iDeal method:
- The following parameters required for any payment must be specified:
project_id
—project identifier obtained from ecommpay during integrationpayment_id
—payment identifier unique within the projectpayment_currency
—payment currency code in the ISO-4217 alpha-3 formatpayment_amount
—payment amount in the smallest currency unitcustomer_id
—customer identifier unique within the project
- The following parameters required for any payment must be specified:
project_id
,payment_id
,payment_currency
,payment_amount
,customer_id
. - The currency of a payment can only be EUR.
- Additionally, it is required to specify the first and last names of the customer, as well as the customer email in the following parameters:
customer_first_name
,customer_last_name
andcustomer_email
. - If you need to have the payment form displayed with the iDeal method selected, set the
force_payment_method
parameter toideal
. - Additionally, any other parameters available for working with Payment Page can be used (details).
- After all target parameters are specified, generate a signature (details).
Thus, a correct request for opening the payment form using the iDeal method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information and signature.
Callback format
The iDeal method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.
The following is the example of a callback with information about a 10.00 EUR
purchase made in the 238
project.
The following is the example of a callback with information about a declined purchase.
Useful links
The following articles can be useful when implementing purchases via Payment Page:
- Interaction concepts—about the interaction with the payment platform by using Payment Page.
- Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
- Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
- One-time one-step purchase—about processing of one-time one-step purchases by using Payment Page.
- Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.
Purchases by using Gate
General information
To process a purchase through Gate by using the iDeal method, the merchant's web service is required to do the following:
- Send a request with all the required parameters and signature to the ecommpay URL.
- Receive an intermediate callback from the payment platform and redirect the customer to the iDeal service.
- Receive the final callback from the payment platform.
The full sequence and special aspects of purchase processing are provided below.
Information about the formats of requests and callbacks used for processing payments by using the iDeal method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.
Request format
There are several things you need to consider when sending purchase requests by using the iDeal method:
- To initiate each purchase, send a separate POST request to the
/v2/payment/online-banking/ideal/sale
endpoint. This is an online banking endpount group: /v2/payment/online-banking/{payment_method}/sale. - Each request must include the following objects and parameters:
- Object
general
—general purchase information:project_id
—project identifier obtained from ecommpay during integrationpayment_id
—payment identifier unique within the projectsignature
—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
- Object
payment
—payment information:amount
—payment amount in the smallest currency unitcurrency
—payment currency code in the ISO-4217 alpha-3 format
- Object
customer
—customer information:id
—customer identifier unique within the projectip_address
—customer IP address relevant for the initiated paymentfirst_name
—customer first namelast_name
—customer last nameemail
—customer email address
return_url
—URL for redirecting the customer:return
—URL for redirecting a customer during any step of the purchase
- Object
- The currency of a payment can only be EUR.
- Additionally, any other parameters included in the specification can be used.
Thus, a correct purchase request by using the iDeal method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information and URL for redirection, as well as signature.
Formats of intermediate callbacks for customer redirection
Each payment made with the iDeal method requires redirection of customers from the merchant's web service to the iDeal service. To redirect a customer it is necessary to receive an intermediate callback from the payment platform and use the information included in the redirect_data
object. The format of such callbacks is standard (details), and the following objects and parameters are included in the redirect_data
object:
body
—object with data to be sent in the request bodymethod
—parameter specifying the HTTP method for sending the request (GET
orPOST
)url
—parameter containing a link for redirection
Final callback format
The iDeal method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.
The following is the example of a callback with information about a 10.00 EUR
purchase made in the 238
project.
The following is the example of a callback with information about a declined purchase.
Useful links
The following articles can be useful when implementing purchases via Gate:
- Interaction concepts—about the interaction with the payment platform by using Gate.
- Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
- Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
- One-time one-step purchase—about processing of one-time one-step purchases by using Payment Page.
- Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.
Refunds by using Gate
General information
To perform a refund through Gate by using the iDeal method, send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of refund performing are provided below.
Information about the formats of requests and callbacks used for performing refunds by using the iDeal method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.
Request format
There are several things you need to consider when sending refund requests by using the iDeal method:
- To initiate each refund, send a separate POST request to the
/v2/payment/online-banking/ideal/refund
enpoint. This is an online banking endpoint group: /v2/payment/online-banking/{payment_method}/refund. - Each request must include the following objects and parameters:
- Object
general
—general refund information:project_id
—project identifier obtained from ecommpay during integrationpayment_id
—identifier of the payment that needs to be refundedpayment identifiersignature
—request signature generated after all required parameters are specified (details—in the Signature generation and verification)
- Object
payment
—refund information:description
—refund description or commentamount
—refund amount in the smallest currency unit (required for a partial refund)currency
—refund currency code in the ISO-4217 alpha-3 format (required for a partial refund)
- Object
customer
—customer information:ip_address
—customer IP address relevant for the initiated refund
- Object
- Additionally, any other parameters included in the specification can be used.
Thus, a correct refund request by using the iDeal method must contain the project and payment identifiers, description of the refund, the customer IP address, signature, and, if necessary, currency code and refund amount.
Callback format
The iDeal method uses the standard format for callbacks to deliver refund results. For more information, see Callbacks.
The following is the example of a callback with information about a 1.00 EUR
refund made in the 238
project.
The following is the example of a callback with information about a declined refund.
Useful links
The following articles can be useful when implementing refunds via Gate:
- Interaction concepts—about the interaction with the payment platform by using Gate.
- Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
- Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
- Purchase refunds—about performing of refunds by using Gate.
- Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.
Analysis of payments results
To analyse information about payments made with the iDeal method and other methods, you can use:
- Dashboard interface toolkit with various lists and analytic panels.
- Reports in CSV file format, available via the Reports section (one-time and periodically).
- Data in JSON format, sent by program requests to a specified URL available by using the Data API interface.
If you have any questions, refer to the documentation (Dashboard and Using Data API) and ecommpay technical support.