General

This service can be used to do iDEAL payments through an QR code. Through a data request, a QR code can be generated. After scanning this code by the customer, an iDEAL payment will be initialized.

  • Servicecode: idealqr
  • Actions: Generate
  • Channel: Web, Backoffice, Batch-file

Generate

Create a QR code for an iDEAL payment with this request.

View in playground

Request


Data request

Amount
Required

Amount to be paid. If AmountIsChangeable = true, then it will be the initial default amount.

AmountIsChangeable
Required

Whether or not the amount can be changed by the customer.

PurchaseId
Required

A reference/purchase ID of the payment. May only contain alphanumeric characters. Max. 35 characters.

Description
Required

A description of the payment. Max. 35 characters.

IsOneOff
Required

Whether or not the QR code can be used for one or multiple payments.

Expiration
Required

Expiration date of the QR code. Format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS.

IsProcessing

Whether or not the QR code is meant for iDEAL processing. Default = collecting.

MinAmount

If AmountIsChangeable = true, then this parameter can be used to determine minimum amount.

MaxAmount

If AmountIsChangeable = true, then this parameter can be used to determine maximum amount.

ImageSize

Image sixe (pixels). Default is 100 (100 x 100). Maximum is 5000 (5000 x 5000).

JSON

copy
{
   "Services": {
      "ServiceList": [
         {
            "Name": "IdealQr",
            "Action": "Generate",
            "Parameters": [
               {
                  "Name": "Description",
                  "GroupType": "",
                  "GroupID": "",
                  "Value": "Test purchase"
               },
               {
                  "Name": "MinAmount",
                  "GroupType": "",
                  "GroupID": "",
                  "Value": "0.10"
               },
               {
                  "Name": "MaxAmount",
                  "GroupType": "",
                  "GroupID": "",
                  "Value": "10.0"
               },
               {
                  "Name": "ImageSize",
                  "GroupType": "",
                  "GroupID": "",
                  "Value": "2000"
               },
               {
                  "Name": "PurchaseId",
                  "GroupType": "",
                  "GroupID": "",
                  "Value": "Testpurchase123"
               },
               {
                  "Name": "IsOneOff",
                  "GroupType": "",
                  "GroupID": "",
                  "Value": "false"
               },
               {
                  "Name": "Amount",
                  "GroupType": "",
                  "GroupID": "",
                  "Value": "1.00"
               },
               {
                  "Name": "AmountIsChangeable",
                  "GroupType": "",
                  "GroupID": "",
                  "Value": "true"
               },
               {
                  "Name": "Expiration",
                  "GroupType": "",
                  "GroupID": "",
                  "Value": "2018-09-30"
               },
               {
                  "Name": "IsProcessing",
                  "GroupType": "",
                  "GroupID": "",
                  "Value": "false"
               }
            ]
         }
      ]
   }
}

Response


Data response

The response will return an URL of the QR code image.

QrImageUrl

URL of the QR code image.

JSON

copy
{
   "Key": "D4D534D1B8BC48829DCD772366FD2xxx",
   "Status": {
      "Code": {
         "Code": 190,
         "Description": "Success"
      },
      "SubCode": {
         "Code": "S001",
         "Description": "Transaction successfully processed"
      },
      "DateTime": "2017-09-25T15:22:53"
   },
   "RequiredAction": null,
   "Services": [
      {
         "Name": "IdealQr",
         "Action": null,
         "Parameters": [
            {
               "Name": "QrImageUrl",
               "Value": "https://qrcode.ideal.nl/qrcode/8b2646bd-9d68-4154-8295-2a91fa157xxx.png"
            }
         ]
      }
   ],
   "CustomParameters": null,
   "AdditionalParameters": null,
   "RequestErrors": null,
   "ServiceCode": "IdealQr",
   "IsTest": true,
   "ConsumerMessage": null
}