Requests

      Requests


        Samenvatting van het artikel

        Generate

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

        Base JSON request

        Use the base request as instructed on this page

        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.
        IsProcessingBooleanYesWhether or not the QR code is meant for iDEAL processing. Default = collecting.
        MinAmountDecimalNoIf AmountIsChangeable = true, then this parameter can be used to determine minimum amount.
        MaxAmountDecimalYesIf AmountIsChangeable = true, then this parameter can be used to determine maximum amount.
        ImageSizeIntegerYesImage sixe (pixels). Default is 100 (100 x 100). Maximum is 5000 (5000 x 5000).
        Basic parameters

        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

        Data response

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

        Parameters

        Service specific parameters

        Parametertyperequireddescription
        QrImageUrlstringN/AURL of the QR code image.
        Basic parameters

        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
        }
        

        Was dit artikel nuttig?

        What's Next