Requests

Pay

The default action for iDEAL is Pay. This action requires as input the issuing bank of the consumer. Upon receiving this input, the consumer will be redirected to the issuing bank for verification and confirmation of the payment. An iDEAL payment has a lifetime of 15 minutes; this means that as soon as the consumer is redirected to the issuer, the payment must be completed within 15 minutes or it will expire. In the event that the consumer irregularly ends the payment process (for example by closing the browser window before returning to the webshop), the payment status will be retrieved from the acquirer as soon as the 15 minute lifespan is expired and the merchant webshop is updated via a push response. It is therefore recommended to enable the push response in the Payment Plaza when implementing iDEAL. A successful payment will include the BIC, the IBAN, the beneficiary of the bank account from which the payment was made and the name of the selected issuer.

Pay request

Parameters

Service specific parameters

Example request

{
  "Currency": "EUR",
  "AmountDebit": 10.00,
  "Invoice": "testinvoice 123",
  "Services": {
    "ServiceList": [
      {
        "Name": "ideal",
        "Action": "Pay",
        "Parameters": [
          {
            "Name": "issuer",
            "Value": "ABNANL2A"
          }
        ]
      }
    ]
  }
}

Pay response

If the request has a valid structure and a valid signature, a transaction will be created in the Payment Engine and a response will be returned. In this case, an additional action is required before the transaction can be completed. The customer needs to be redirected to the payment environment through the returned redirectURL.

Parameters

Service specific parameters

Example response:

{
    "Key": "4E8BD922192746C3918BF4077CXXXXXX",
    "Status": {
        "Code": {
            "Code": 791,
            "Description": "Pending processing"
        },
        "SubCode": {
            "Code": "S002",
            "Description": "An additional action is required: RedirectToIdeal"
        },
        "DateTime": "2022-03-28T11:23:42"
    },
    "RequiredAction": {
        "RedirectURL": "https://testcheckout.buckaroo.nl/html/redirect.ashx?r=904A6432D283440ABD4418BF16XXXXXX",
        "RequestedInformation": null,
        "PayRemainderDetails": null,
        "Name": "Redirect",
        "TypeDeprecated": 0
    },
    "Services": [
        {
            "Name": "ideal",
            "Action": null,
            "Parameters": [
                {
                    "Name": "consumerIssuer",
                    "Value": "ABN AMRO"
                },
                {
                    "Name": "transactionId",
                    "Value": "0000000000000001"
                }
            ]
        }
    ],
    
    
    "CustomParameters": null,
    "AdditionalParameters": null,
    "RequestErrors": null,
    "Invoice": "testinvoice 123",
    "ServiceCode": "ideal",
    "IsTest": true,
    "Currency": "EUR",
    "AmountDebit": 10.0,
    "TransactionType": "C021",
    "MutationType": 1,
    "RelatedTransactions": null,
    "ConsumerMessage": null,
    "Order": null,
    "IssuingCountry": null,
    "StartRecurrent": false,
    "Recurring": false,
    "CustomerName": null,
    "PayerHash": null,
    "PaymentKey": "644545E2409D4223AC09E880ADXXXXXX"
}
}

Pay push

Service specific parameters

Example push

{
  "Transaction": {
    "Key": "4E8BD922192746C3918BF4077CXXXXXX",
    "Invoice": "testinvoice 123",
    "ServiceCode": "ideal",
    "Status": {
      "Code": {
        "Code": 190,
        "Description": "Success"
      },
      "SubCode": {
        "Code": "S001",
        "Description": "Transaction successfully processed"
      },
      "DateTime": "2017-03-28T11:24:14"
    },
    "IsTest": true,
    "Order": null,
    "Currency": "EUR",
    "AmountDebit": 10.0,
    "TransactionType": "C021",
    "Services": [
      {
        "Name": "ideal",
        "Action": null,
        "Parameters": [
          {
            "Name": "consumerIssuer",
            "Value": "ABN AMRO"
          },
          {
            "Name": "transactionId",
            "Value": "0000000000000001"
          },
          {
            "Name": "consumerName",
            "Value": "J. de Tèster"
          },
          {
            "Name": "consumerIBAN",
            "Value": "NL44RABO0123456789"
          },
          {
            "Name": "consumerBIC",
            "Value": "RABONL2U"
          }
        ],
        "VersionAsProperty": 2
      }
    ],
    "CustomParameters": null,
    "AdditionalParameters": null,
    "MutationType": 1,
    "RelatedTransactions": null,
    "IsCancelable": false,
    "IssuingCountry": null,
    "StartRecurrent": false,
    "Recurring": false,
    "CustomerName": "J. de Tèster",
    "PayerHash": "d2e447e9bd91d6e5b4507c2699f2dfa117c60e2e70a13854df4dad57aa54f26785f710b5c6022a9feaf8eace18125f5b1c6929a2ec9a4ff0e88182f9fe085ec3",
    "PaymentKey": "644545E2409D4223AC09E880ADXXXXXX"
  }
}

Refund

To refund a successfully performed iDEAL transaction, use the action Refund. This is only available for ideal collecting. A bank transfer is then initiated which transfers the amount of the original transaction to the consumer.

Refund request

{
  "Currency": "EUR",
  "AmountCredit": 1.00,
  "Invoice": "testinvoice 123",
  "OriginalTransactionKey": "4E8BD922192746C3918BF4077CXXXXXX",
  "Services": {
    "ServiceList": [
      {
        "Name": "ideal",
        "Action": "Refund"
      }
    ]
  }
}

Refund response

{
    "Key": "F996EE747ECD43CDA8851C5F83XXXXXX",
    "Status": {
        "Code": {
            "Code": 190,
            "Description": "Success"
        },
        "SubCode": {
            "Code": "S001",
            "Description": "Transaction successfully processed"
        },
        "DateTime": "2017-03-31T09:03:45"
    },
    "RequiredAction": null,
    "Services": [
        {
            "Name": "ideal",
            "Action": null,
            "Parameters": [
                {
                    "Name": "customeraccountname",
                    "Value": "J. de Tèster"
                },
                {
                    "Name": "CustomerIBAN",
                    "Value": "NL44RABO0123456789"
                },
                {
                    "Name": "CustomerBIC",
                    "Value": "RABONL2U"
                }
            ]
        }
    ],
    "CustomParameters": null,
    "AdditionalParameters": null,
    "RequestErrors": null,
    "Invoice": "testinvoice 123",
    "ServiceCode": "ideal",
    "IsTest": true,
    "Currency": "EUR",
    "AmountCredit": 1,
    "TransactionType": "C121",
    "MutationType": 1,
    "RelatedTransactions": [
        {
            "RelationType": "refund",
            "RelatedTransactionKey": "4E8BD922192746C3918BF4077CXXXXXX"
        }
    ],
    "ConsumerMessage": null,
    "Order": null,
    "IssuingCountry": null,
    "StartRecurrent": false,
    "Recurring": false,
    "CustomerName": "J. de Tèster",
    "PayerHash": null,
    "PaymentKey": "AE8B6E18A2684846AAAF06A63FXXXXXX"
}