Requests

      Requests


        Article Summary

        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.

        Base JSON request

        Use the base request as instructed on this page

        Create request

        The Create request is a data request and is used to create a new wallet. It is possible to provide customer details but this is not required. Customer details can be added or updated at a later moment by the Update request. The WalletId must be unique, regardless of test or live. It is not possible to delete a wallet, but only to (de)activate it.

        Parameters

        Service specific parameters

        ParameterTypeRequiredDescription
        WalletIdstringYesUnique identifier of the Buckaroo Wallet for the merchant. Should be provided when performing updates on the wallet.
        ConsumerFirstNamestringFirst name of the customer
        ConsumerLastNamestringLast name of the customer
        ConsumerEmailstringEmail address of the customer
        ConsumerIbanstringIBAN number of the customer.
        Basic parameters

        Example request

        {
          "Currency": "EUR",
          "Services": {
            "ServiceList": [
              {
                "Name": "BuckarooWalletCollecting",
                "Action": "Create",
                "Parameters": [
                  {
                    "Name": "WalletId",
                    "Value": "SomeMerchantUniqueValue"
                  },
                  {
                    "Name": "ConsumerFirstName",
                    "Value": "First Name"
                  },
                  {
                    "Name": "ConsumerLastName",
                    "Value": "Last Name"
                  },
                  {
                    "Name": "ConsumerEmail",
                    "Value": "test@gmail.com"
                  },
                  {
                    "Name": "ConsumerIban",
                    "Value": "NL13TEST0123456789"
                  }
                ]
              }
            ]
          }
        }
        

        Create response

        Parameters

        Service specific parameters

        ParameterTypeRequiredDescription
        WalletGuidstringUnique identifier of the Wallet used by Buckaroo.
        WalletIdstringUnique identifier of the Buckaroo Wallet for the merchant. Should be provided when performing updates on the wallet.
        Basic parameters

        Example response

        {
          "Key": "1757B313E57E4973997DD8C5235A3D48",
          "Status": {
            "Code": {
              "Code": 190,
              "Description": "Success"
            },
            "SubCode": {
              "Code": "S001",
              "Description": "Transaction successfully processed"
            },
            "DateTime": "2021-12-23T11:09:24"
          },
          "RequiredAction": null,
          "Services": [
            {
              "Name": "BuckarooWalletCollecting",
              "Action": null,
              "Parameters": [
                {
                  "Name": "WalletGuid",
                  "Value": "313BC97B38084203A4592A0515044"
                },
                {
                  "Name": "WalletId",
                  "Value": "SomeMerchantUniqueValue"
                }
              ]
            }
          ],
          "CustomParameters": null,
          "AdditionalParameters": null,
          "RequestErrors": null,
          "ServiceCode": "BuckarooWalletCollecting",
          "IsTest": true,
          "ConsumerMessage": null
        }
        

        Update

        The Update request is a data request that can be used to update information of a wallet, with the exception of the WalletId itself. Additionally, the Wallet status can be updated.

        Update request

        Parameters

        Service specific parameters

        ParameterTypeRequiredDescription
        WalletIdstringYesUnique identifier of the Buckaroo Wallet for the merchant. Cannot be updated.. Should be provided to specify the wallet that needs to be updated.
        ConsumerFirstNamestringFirst name of the customer
        ConsumerLastNamestringLast name of the customer
        ConsumerEmailstringEmail address of the customer
        ConsumerIbanstringIBAN number of the customer.
        StatusstringStatus of the wallet. Possible values: Active, Disabled
        Basic parameters

        Example request

        {
          "Services": {
            "ServiceList": [
              {
                "Name": "BuckarooWalletCollecting",
                "Action": "Update",
                "Parameters": [
                  {
                    "Name": "WalletId",
                    "Value": "SomeMerchantUniqueValue"
                  },
                  {
                    "Name": "ConsumerFirstName",
                    "Value": "First Name"
                  },
                  {
                    "Name": "ConsumerLastName",
                    "Value": "Last Name"
                  },
                  {
                    "Name": "ConsumerEmail",
                    "Value": "test@gmail.com"
                  },
                  {
                    "Name": "ConsumerIban",
                    "Value": "NL13TEST0123456789"
                  },
                  {
                    "Name": "Status",
                    "Value": "Disabled"
                  }
                ]
              }
            ]
          }
        }
        

        Update response

        Parameters

        Service specific parameters

        ParameterTypeRequiredDescription
        WalletGuidstringUnique identifier of the Wallet used by Buckaroo.
        WalletIdstringUnique identifier of the Buckaroo Wallet for the merchant. Should be provided when performing updates on the wallet.
        Basic parameters

        Example response

        {
            "Key": "1757B313E57E4973997DD8C5235A3D48",
            "Status": {
                "Code": {
                    "Code": 190,
                    "Description": "Success"
                },
                "SubCode": {
                    "Code": "S001",
                    "Description": "Transaction successfully processed"
                },
                "DateTime": "2021-12-23T11:09:24"
            },
            "RequiredAction": null,
            "Services": [
                {
                    "Name": "BuckarooWalletCollecting",
                    "Action": null,
                    "Parameters": [
                        {
                            "Name": "WalletGuid",
                            "Value": "313BC97B38084203A4592A0515044"
                        },
                        {
                            "Name": "WalletId",
                            "Value": "SomeMerchantUniqueValue"
                        }
                    ]
                }
            ],
            "CustomParameters": null,
            "AdditionalParameters": null,
            "RequestErrors": null,
            "ServiceCode": "BuckarooWalletCollecting",
            "IsTest": true,
            "ConsumerMessage": null
        }
        

        GetInfo

        The GetInfo request is a data request that can be used to retrieve information of a Wallet.

        GetInfo request

        Parameters

        Service specific parameters

        ParameterTypeRequiredDescription
        WalletIdstringYesUnique identifier of the Buckaroo Wallet for the merchant. Cannot be updated.. Should be provided to specify the wallet that needs to be updated.
        Basic parameters

        Example request

        {
          "Services": {
            "ServiceList": [
              {
                "Name": "BuckarooWalletCollecting",
                "Action": "GetInfo",
                "Parameters": [
                  {
                    "Name": "WalletId",
                    "Value": "SomeMerchantUniqueValue"
                  }
                ]
              }
            ]
          }
        }
        

        GetInfo response

        Parameters

        Service specific parameters

        ParameterTypeRequiredDescription
        WalletGuidstringUnique identifier of the Wallet used by Buckaroo.
        WalletIdstringUnique identifier of the Buckaroo Wallet for the merchant
        ConsumerFirstNamestringFirst name of the customer
        ConsumerLastNamestringLast name of the customer
        ConsumerEmailstringEmail address of the customer
        ConsumerIbanstringIBAN number of the customer.
        StatusstringStatus of the wallet
        CurrencystringCurrency of the wallet balance
        CurrentBalancestringCurrence balance of the Wallet
        CurrentUsableBalancestringBalance that is usable for mutations like payments and withdrawals.
        Basic parameters

        Example response

        {
            "Key": "1757B313E57E4973997DD8C5235A3D48",
            "Status": {
                "Code": {
                    "Code": 190,
                    "Description": "Success"
                },
                "SubCode": {
                    "Code": "S001",
                    "Description": "Transaction successfully processed"
                },
                "DateTime": "2021-12-23T11:09:24"
            },
            "RequiredAction": null,
            "Services": [
                {
                    "Name": "BuckarooWalletCollecting",
                    "Action": null,
                    "Parameters": [
                        {
                            "Name": "WalletGuid",
                            "Value": "313BC97B38084203A4592A051504"
                        },
                        {
                            "Name": "WalletId",
                            "Value": "SomeMerchantUniqueValue"
                        },
                        {
                            "Name": "ConsumerFirstName",
                            "Value": "First Name"
                        },
                        {
                            "Name": "ConsumerLastName",
                            "Value": "Last Name"
                          
                        {
                            "Name": "ConsumerEmail",
                            "Value": "test@gmail.com"
                        },
                        {
                            "Name": "ConsumerIban",
                            "Value": "NL13TEST0123456789"
                        },
                        {
                            "Name": "Status",
                            "Value": "Disabled"
                        },
                        {
                            "Name": "Currency",
                            "Value": "EUR"
                        },
                        {
                            "Name": "CurrentBalance",
                            "Value": "10.00"
                        },
                        {
                            "Name": "CurrentUsableBalance",
                            "Value": "10.00"
                        }
                    ]
                }
            ],
            "CustomParameters": null,
            "AdditionalParameters": null,
            "RequestErrors": null,
            "ServiceCode": "BuckarooWalletCollecting",
            "IsTest": true,
            "ConsumerMessage": null
        }
        

        Was this article helpful?