iDeal

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

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.

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.

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:

1. The following parameters required for any payment must be specified:
   • project_id—project identifier obtained from ecommpay during integration
   • payment_id—payment identifier unique within the project
   • payment_currency—payment currency code in the ISO-4217 alpha-3 format
   • payment_amount—payment amount in the smallest currency unit
   • customer_id—customer identifier unique within the project
2. The following parameters required for any payment must be specified: project_id, payment_id, payment_currency, payment_amount, customer_id.
3. The currency of a payment can only be EUR.
4. Additionally, it is required to specify the firs and last names of the customer in the customer_first_name and customer_last_name parameters. If any of these parameters are missing, the payment form may display input fields for entering the missing values (details are available in Submission of additional payment information).
5. If you need to have the payment form displayed with the iDeal method selected, set the force_payment_method parameter to ideal.
6. Additionally, any other parameters available for working with Payment Page can be used (details).
7. 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.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "EUR",
   "customer_id": "customer1",
   "customer_first_name": "John",
   "customer_last_name": "Johnson",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "EUR",
   "customer_id": "customer1",
   "customer_first_name": "John",
   "customer_last_name": "Johnson",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Callback format

The iDeal method uses the standard format for callbacks to deliver purchase results. For more information, see Handling callbacks.

The following is the example of a callback with information about a 10.00 EUR purchase made in the 238 project.

{
        "project_id": 238,
        "payment": {
            "id": "TEST_15452119890903333",
            "type": "purchase",
            "status": "success",
            "date": "2018-12-20T13:40:56+0000",
            "method": "ideal",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": "ECT_TEST_1545211989090"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 18496000002369,
            "type": "sale",
            "status": "success",
            "date": "2018-12-20T13:40:56+0000",
            "created_date": "2018-12-20T13:40:15+0000",
            "request_id": "768e72d3284eb2b269e4f3",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1170,
                "payment_id": "353827769",
                "date": "2018-12-20T13:40:56+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "ylWj/35wPzQRs+9dWcCYMduHnXwxMxYZy17g=="
    }

The following is the example of a callback with information about a declined purchase.

{
        "project_id": 1569,
        "payment": {
            "id": "145408-190628095914-cmY0LnByZ=",
            "type": "purchase",
            "status": "decline",
            "date": "2019-06-28T09:59:58+0000",
            "method": "ideal",
            "sum": {
                "amount": 300,
                "currency": "EUR"
            },
            "description": "3 Tage Premium-Mitgliedschaft"
        },
        "customer": {
            "id": "145408"
        },
        "operation": {
            "id": 33841000003201,
            "type": "sale",
            "status": "decline",
            "date": "2019-06-28T09:59:58+0000",
            "created_date": "2019-06-28T09:59:16+0000",
            "request_id": "cef7a32aa22a4e4bc8",
            "sum_initial": {
                "amount": 300,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 300,
                "currency": "EUR"
            },
            "provider": {
                "id": 1170,
                "payment_id": "474810276",
                "date": "2019-06-28T09:59:45+0000",
                "auth_code": ""
            },
            "code": "20301",
            "message": "Account owner cancelled operation"
        },
        "signature": "LifBDhURocEq9eVkzL1UxRCp1JNbQ9M46TyotjGT5io17TSw=="
    }

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 processing—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.
• Handling operation processing information—about error and response codes that are used in the payment platform to record information about performing of operations.

General information

To process a purchase through Gate by using the iDeal method, the merchant's web service is required to do the following:

1. Send a request with all the required parameters and signature to the ecommpay URL.
2. Receive an intermediate callback from the payment platform and redirect the customer to the iDeal service.
3. 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:

1. 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.
2. Each request must include the following objects and parameters:
   • Object general—general purchase information:
     • project_id—project identifier obtained from ecommpay during integration
     • payment_id—payment identifier unique within the project
     • signature—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 unit
     • currency—payment currency code in the ISO-4217 alpha-3 format
   • Object customer—customer information:
     • id—customer identifier unique within the project
     • ip_address—customer IP address relevant for the initiated payment
   • return_url—URL for redirecting the customer:
     • return—URL for redirecting a customer during any step of the purchase
3. Additionally, it is recommended to specify the first and last names of the customer in the first_name and last_name parameters of the customer object. If any of these parameters are missing, the payment platform may send the list of missing parameters in a callback requesting additional information submission (details are available in Submission of additional payment information).
4. The currency of a payment can only be EUR.
5. 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.

{
    "general": {
        "project_id": 2990,
        "payment_id": "payment_id",
        "signature": "PJkV8ej\/UG0OMeSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
      "ip_address": "192.0.2.0",
      "first_name": "John",
      "last_name": "Johnson",
      "id": "123"
    },
    "payment": {
      "amount": 1000,
      "currency": "EUR"
    },
    "return_url": {
      "return": "http://example.com"
    }
}

{
    "general": {
        "project_id": 2990,
        "payment_id": "payment_id",
        "signature": "PJkV8ej\/UG0OMeSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
      "ip_address": "192.0.2.0",
      "first_name": "John",
      "last_name": "Johnson",
      "id": "123"
    },
    "payment": {
      "amount": 1000,
      "currency": "EUR"
    },
    "return_url": {
      "return": "http://example.com"
    }
}

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 body
• method—parameter specifying the HTTP method for sending the request (GET or POST)
• url—parameter containing a link for redirection

  "redirect_data": {
    "body": {},
    "method": "GET",
    "url": "https://www.example.com/pay"
  }

Final callback format

The iDeal method uses the standard format for callbacks to deliver purchase results. For more information, see Handling callbacks.

The following is the example of a callback with information about a 10.00 EUR purchase made in the 238 project.

{
        "project_id": 238,
        "payment": {
            "id": "TEST_15452119890903333",
            "type": "purchase",
            "status": "success",
            "date": "2018-12-20T13:40:56+0000",
            "method": "ideal",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": "ECT_TEST_1545211989090"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 18496000002369,
            "type": "sale",
            "status": "success",
            "date": "2018-12-20T13:40:56+0000",
            "created_date": "2018-12-20T13:40:15+0000",
            "request_id": "768e72d3284eb2b269e4f3",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1170,
                "payment_id": "353827769",
                "date": "2018-12-20T13:40:56+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "ylWj/35wPzQRs+9dWcCYMduHnXwxMxYZy17g=="
    }

The following is the example of a callback with information about a declined purchase.

{
        "project_id": 1569,
        "payment": {
            "id": "145408-190628095914-cmY0LnByZ=",
            "type": "purchase",
            "status": "decline",
            "date": "2019-06-28T09:59:58+0000",
            "method": "ideal",
            "sum": {
                "amount": 300,
                "currency": "EUR"
            },
            "description": "3 Tage Premium-Mitgliedschaft"
        },
        "customer": {
            "id": "145408"
        },
        "operation": {
            "id": 33841000003201,
            "type": "sale",
            "status": "decline",
            "date": "2019-06-28T09:59:58+0000",
            "created_date": "2019-06-28T09:59:16+0000",
            "request_id": "cef7a32aa22a4e4bc8",
            "sum_initial": {
                "amount": 300,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 300,
                "currency": "EUR"
            },
            "provider": {
                "id": 1170,
                "payment_id": "474810276",
                "date": "2019-06-28T09:59:45+0000",
                "auth_code": ""
            },
            "code": "20301",
            "message": "Account owner cancelled operation"
        },
        "signature": "LifBDhURocEq9eVkzL1UxRCp1JNbQ9M46TyotjGT5io17TSw=="
    }

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 processing—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 Gate.
• Handling operation processing information—about error and response codes that are used in the payment platform to record information about performing of operations.

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:

1. 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.
2. Each request must include the following objects and parameters:
   • Object general—general refund information:
     • project_id—project identifier obtained from ecommpay during integration
     • payment_id—identifier of the payment that needs to be refundedpayment identifier
     • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification)
   • Object payment—refund information:
     • description—refund description or comment
     • amount—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
3. 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.

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "description": "test refund",
    "amount": 1000,
    "currency": "EUR"
  },
  "customer": {
    "ip_address": "192.0.2.0"
  }
}

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "description": "test refund",
    "amount": 1000,
    "currency": "EUR"
  },
  "customer": {
    "ip_address": "192.0.2.0"
  }
}

Callback format

The iDeal method uses the standard format for callbacks to deliver refund results. For more information, see Handling callbacks.

The following is the example of a callback with information about a 1.00 EUR refund made in the 238 project.

 
{
        "project_id": 238,
        "payment": {
            "id": "TEST_15611060328012",
            "type": "purchase",
            "status": "refunded",
            "date": "2019-06-21T11:15:40+0000",
            "method": "ideal",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": ""
        },
        "provider_extra_fields": {
            "description": "Refund"
        },
        "operation": {
            "id": 36084000003050,
            "type": "refund",
            "status": "success",
            "date": "2019-06-21T11:15:40+0000",
            "created_date": "2019-06-21T11:15:38+0000",
            "request_id": "ec1a34153dc43fe1bae7b6397",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "provider": {
                "id": 1170,
                "payment_id": "105796085",
                "date": "2019-06-21T11:15:39+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "DtwI1Wbg6Wda71k/xy0dGWGE2qHhfA7naVeEk0wtfqg=="
    }

The following is the example of a callback with information about a declined refund.

{
        "project_id": 238,
        "payment": {
            "id": "TEST_15611060328012",
            "type": "purchase",
            "status": "success",
            "date": "2019-06-21T08:39:50+0000",
            "method": "ideal",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": ""
        },
        "errors": [
            {
                "code": "100",
                "message": "General decline",
                "description": "Gate. Operation was declined. General Gate error"
            }
        ],
        "operation": {
            "id": 36084000003046,
            "type": "refund",
            "status": "decline",
            "date": "2019-06-21T09:42:44+0000",
            "created_date": "2019-06-21T09:42:44+0000",
            "request_id": "5d0c7bf5304685ab9c9613a8e9a86",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "provider": {
                "id": 1170,
                "payment_id": ""
            },
            "code": "100",
            "message": "General decline"
        },
        "signature": "AX+FugJdXi3kHaIUiIjCpaTk94+4gIvrhj/6n3PBA=="
    }

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 processing—about the types, processing models, and possible statuses of supported payments and operations.
• Purchase refunds—about performing of refunds by using Gate.
• Handling operation processing information—about error and response codes that are used in the payment platform to record information about performing of operations.