Requests

Pay Request

Parameters

Service Specific Parameters

Parameter	Type	Required	Recommended	Description
issuer	string	No	Not Recommended. In order to make full use of the iDEAL 2.0 functionality, it is required to let the issuing bank selection take place on Currence's landing page. This can be done by omitting the issuer parameter.	BIC code of the issuing bank of the consumer. Please refer to the list of banks in the general section for the list of BIC codes.

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

Parameter	Type	Required	Description
consumerIssuer	string	N/A	The name of the issuer (bank) of the consumer.
transactionId	string	N/A	This is the iDEAL transaction ID.

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

Parameter	Type	Required	Description
consumerIssuer	string	N/A	The name of the issuer (bank) of the consumer.
transactionId	string	N/A	This is the iDEAL transaction ID.
consumerName	string	N/A	The beneficiary of the bank account from which the payment was made.
consumerIBAN	string	N/A	The international bank account number (IBAN code) of the bank of the consumer. Please note: This field is optional. In some countries, banks are not allowed to provide this information to third parties.

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

Service Specific Parameters

Parameter	Type	Required	Description
customeraccountname	string	N/A	The beneficiary of the bank account from which the payment was made.
consumerIBAN	string	N/A	The international bank account number (IBAN code) of the bank of the consumer. Please note: This field is optional. In some countries, banks are not allowed to provide this information to third parties.
consumerBIC	string	N/A	The bank identifier (BIC code) of the bank of the consumer. Please note: This field is optional. In some countries, banks are not allowed to provide this information to third parties.

Example 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"
}

Fast Checkout

In order to process a payment with Fast Checkout, merchants must use the action: PayFastCheckout and also must not include Issuer in their requests, because that is not allowed with PayFastCheckout.

More information can be found on this page.

PayFastCheckout Request

{
  "Currency": "EUR",
  "AmountDebit": 0.01,
  "Invoice": "testinvoice 123",
  "Services": {
    "ServiceList": [
      {
        "Name": "ideal",
        "Action": "PayFastCheckout",
        "Parameters": []
      }
    ]
  }
}

PayFastCheckout Response

{
    "Key": "4E8BD922192746C3918BF4077CXXXXXX",
    "Status": {
        "Code": 791,
        "Description": "Pending processing"
    },
    "SubCode": {
        "Code": "S002",
        "Description": "An additional action is required: RedirectToIdeal"
    },
    "DateTime": "2024-03-18T13:30:34"
    },
    "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": "transactionId",
                    "Value": "0000000000000002"
                }
            ]
        }
    ],
    "CustomParameters": null,
    "AdditionalParameters": null,
    "RequestErrors": null,
    "Invoice": "testinvoice 123",
    "ServiceCode": "ideal",
    "IsTest": true,
    "Currency": "EUR",
    "AmountDebit": 0.01,
    "TransactionType": "C021",
    "MutationType": 1,
    "RelatedTransactions": null,
    "ConsumerMessage": null,
    "Order": null,
    "IssuingCountry": null,
    "StartRecurrent": false,
    "Recurring": false,
    "CustomerName": null,
    "PayerHash": null,
    "PaymentKey": "644545E2409D4223AC09E880ADXXXXXX"
}

PayFastCheckout Push

{
  "Transaction": {
    "Key": "4E8BD922192746C3918BF4077CXXXXXX",
    "Invoice": "testinvoice 123",
    "ServiceCode": "ideal",
    "Status": {
      "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"
          },
          {
            "Name": "Description",
            "Value": "Dummy Description"
          },
          {
            "Name": "ContactDetailsFirstName",
            "Value": "John"
          },
          {
            "Name": "ContactDetailsLastName",
            "Value": "Dijkstra"
          },
          {
            "Name": "ContactDetailsPhoneNumber",
            "Value": "+31612345678"
          },
          {
            "Name": "ContactDetailsEmail",
            "Value": "[email protected]"
          },
          {
            "Name": "ShippingAddressFirstName",
            "Value": "Edsger W."
          },
          {
            "Name": "ShippingAddressLastName",
            "Value": "Dijkstra"
          },
          {
            "Name": "ShippingAddressCompanyName",
            "Value": "Cookie factory"
          },
          {
            "Name": "ShippingAddressPostalCode",
            "Value": "3512NS"
          },
          {
            "Name": "ShippingAddressAddition",
            "Value": "C"
          },
          {
            "Name": "ShippingAddressHouseNumber",
            "Value": "100"
          },
          {
            "Name": "ShippingAddressStreet",
            "Value": "Bankastraat"
          },
          {
            "Name": "ShippingAddressCountryName",
            "Value": "Netherlands"
          },
          {
            "Name": "InvoiceAddressFirstName",
            "Value": "Edsger W."
          },
          {
            "Name": "InvoiceAddressLastName",
            "Value": "Dijkstra"
          },
          {
            "Name": "InvoiceAddressCompanyName",
            "Value": "Cookie factory"
          },
          {
            "Name": "InvoiceAddressPostalCode",
            "Value": "123ZZ"
          },
          {
            "Name": "InvoiceAddressAddition",
            "Value": "C"
          },
          {
            "Name": "InvoiceAddressHouseNumber",
            "Value": "100"
          },
          {
            "Name": "InvoiceAddressStreet",
            "Value": "Bankastraat"
          },
          {
            "Name": "InvoiceAddressCity",
            "Value": "Amsterdam"
          },
          {
            "Name": "InvoiceAddressCountryName",
            "Value": "Netherlands"
          }
        ],
        "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"
  }
}