Generate iDEAL Payment QR Code


Generate Request

Parameters

Service Specific Parameters

ParameterTypeRequiredRecommendedDescription
AmountdecimalYesAmount to be paid. If AmountIsChangeable = true, then it will be the initial default amount.
AmountIsChangeableBooleanYesWhether or not the amount can be changed by the customer.
PurchaseIdStringYesA reference/purchase ID of the payment. May only contain alphanumeric characters. Max. 35 characters.
DescriptionStringYesA description of the payment. Max. 35 characters.
IsOneOffBooleanYesWhether or not the QR code can be used for one or multiple payments.
ExpirationDateYesExpiration date of the QR code. Format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS.
IsProcessingBooleanNoWhether or not the QR code is meant for iDEAL processing. Default = false (iDEAL collecting).
MinAmountDecimalNoIf AmountIsChangeable = true, then this parameter can be used to determine minimum amount.
MaxAmountDecimalNoIf AmountIsChangeable = true, then this parameter can be used to determine maximum amount.
ImageSizeIntegerNoImage size (pixels). Default is 100 (100 x 100). Maximum is 5000 (5000 x 5000).

Example Request

{
   "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"
               }
            ]
         }
      ]
   }
}

Generate Response

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

Parameters

Service Specific Parameters

ParameterTypeRequiredDescription
QrImageUrlStringN/AURL of the QR code image.

Example Response

{
   "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"
            }
         ]
      }
   ],
   "CustomParameters": null,
   "AdditionalParameters": null,
   "RequestErrors": null,
   "ServiceCode": "IdealQr",
   "IsTest": true,
   "ConsumerMessage": null
}