Guides
StatusPlazaCreate Account

Requests

Suggest Edits

Pay

The Pay action is the default action. The action is used to perform a single payment with the Buckaroo Voucher.

Base JSON request

📘

Note

Use the base request as instructed on this page.

Parameters

Basic Parameters:

  • Find basic parameters here.

Pay Request

Parameters

  • Service Specific Parameters:
ParameterTypeRequiredDescription
bicStringNoThe international bank code identifying the customer's bank. This can be provided, otherwise, the customer selects their bank on Giropay.
CustomerIBANStringNoThe customer's IBAN for the Giropay transaction. Prevents fraud by ensuring the IBAN used on Giropay matches the one provided on the website.

Example Request

{
   "Currency": "EUR",
   "AmountDebit": 10.00,
   "Invoice": "testinvoice 123",
   "Services": {
      "ServiceList": [
         {
            "Name": "giropay",
            "Action": "Pay",
            "Parameters": [
               {
                  "Name": "bic",
                  "Value": "GENODETT488"
               },
               {
                  "Name": "CustomerIBAN",
                  "Value": "NL13TEST0123456789"
               }
            ]
         }
      ]
   }
}

Pay Response

Parameters

ParameterTypeRequiredRecommendedDescription
consumerBICstringThe international bankcode identifying the customer's bank.

Example Response

{
   "Key": "6473D552EB7F4074817A9A6F1BFBxxxx",
   "Status": {
      "Code": {
         "Code": 791,
         "Description": "Pending processing"
      },
      "SubCode": {
         "Code": "S002",
         "Description": "An additional action is required: Verify at Giropay"
      },
      "DateTime": "2018-04-16T16:05:28"
   },
   "RequiredAction": {
      "RedirectURL": "https://testcheckout.buckaroo.nl/html/redirect.ashx?r=D71F06AB0C9540FC8C76BF7FA76xxxx",
      "RequestedInformation": null,
      "PayRemainderDetails": null,
      "Name": "Redirect",
      "TypeDeprecated": 0
   },
   "Services": [
      {
         "Name": "giropay",
         "Action": null,
         "Parameters": [
            {
               "Name": "consumerBIC",
               "Value": "GENODETT488"
            }
         ]
      }
   ],
   "CustomParameters": null,
   "AdditionalParameters": null,
   "RequestErrors": null,
   "Invoice": "testinvoice 123",
   "ServiceCode": "giropay",
   "IsTest": true,
   "Currency": "EUR",
   "AmountDebit": 10.00,
   "TransactionType": "C241",
   "MutationType": 1,
   "RelatedTransactions": null,
   "ConsumerMessage": null,
   "Order": null,
   "IssuingCountry": null,
   "StartRecurrent": false,
   "Recurring": false,
   "CustomerName": null,
   "PayerHash": null,
   "PaymentKey": "397BB56968074AE7AC99EFC8A264xxxx"
}

Pay Push

When the consumer has completed the payment, the transaction status will be pushed to a success status.

Parameters

ParameterTypeRequiredRecommendedDescription
consumerBICstringThe international bankcode identifying the customer's bank.
consumerBankleitzahlstringThe national bank code of the customer's account, which is part of their IBAN.

Example Push

{
   "Transaction": {
      "Key": "8A69B71E57244B71866104A0D636xxxx",
      "Invoice": "testinvoice 123",
      "ServiceCode": "giropay",
      "Status": {
         "Code": {
            "Code": 190,
            "Description": "Success"
         },
         "SubCode": {
            "Code": "S001",
            "Description": "Transaction successfully processed"
         },
         "DateTime": "2018-04-16T16:04:16"
      },
      "IsTest": true,
      "Order": null,
      "Currency": "EUR",
      "AmountDebit": 10,
      "TransactionType": "C241",
      "Services": [
         {
            "Name": "giropay",
            "Action": null,
            "Parameters": [
               {
                  "Name": "consumerBIC",
                  "Value": "GENODETT488"
               },
               {
                  "Name": "consumerBankleitzahl",
                  "Value": "44448888"
               },
               {
                  "Name": "consumerIBAN",
                  "Value": "NL13TEST0123456789"
               }
            ],
            "VersionAsProperty": 2
         }
      ],
      "CustomParameters": null,
      "AdditionalParameters": null,
      "MutationType": 1,
      "RelatedTransactions": null,
      "IsCancelable": false,
      "IssuingCountry": null,
      "StartRecurrent": false,
      "Recurring": false,
      "CustomerName": null,
      "PayerHash": null,
      "PaymentKey": "C5D95257D04343E2BC34576D309Exxxx"
   }
}

Refund

To refund a successful Giropay transaction, use the Refund action. A bank transfer is initiated to return the original transaction amount to the consumer.

Refund Request

ParameterTypeRequiredDescription
OriginalTransactionKeyStringYesTransaction key of the original transaction to refund

Example Request

{
   "Currency": "EUR",
   "AmountCredit": 1,
   "Invoice": "testinvoice 123",
   "OriginalTransactionKey": "30D459B07FD648A993ACF7D4DXXXXXX",
   "Services": {
      "ServiceList": [
         {
            "Name": "giropay",
            "Action": "Refund"
         }
      ]
   }
}

Refund Response

Parameters

ParameterTypeRequiredRecommendedDescription
customeraccountnamestringThe customer's accountname at the bank to which the refund was performed.
CustomerIBANstringThe customer's IBAN to which the refund was performed.
CustomerBICstringThe international bankcode, identifying the customer's bank, belonging to the IBAN to which the refund was performed.

Example Response

{
   "Key": "BE6434EE6C8440B882A2A90C0XXXXX",
   "Status": {
      "Code": {
         "Code": 690,
         "Description": "Rejected"
      },
      "SubCode": {
         "Code": "S122",
         "Description": "The transaction is non-refundable."
      },
      "DateTime": "2017-07-20T10:21:57"
   },
   "RequiredAction": null,
   "Services": null,
   "CustomParameters": null,
   "AdditionalParameters": null,
   "RequestErrors": null,
   "Invoice": "testinvoice 123",
   "ServiceCode": "giropay",
   "IsTest": true,
   "Currency": "EUR",
   "AmountCredit": 1,
   "TransactionType": "C242",
   "MutationType": 1,
   "RelatedTransactions": [
      {
         "RelationType": "refund",
         "RelatedTransactionKey": "30D459B07FD648A993ACF7D4D0BXXXXX"
      }
   ],
   "ConsumerMessage": null,
   "Order": null,
   "IssuingCountry": null,
   "StartRecurrent": false,
   "Recurring": false,
   "CustomerName": null,
   "PayerHash": null,
   "PaymentKey": "499003EB3FFC4B49B65F639C5EXXXXX"
}

Refund Push

Parameters

ParameterTypeRequiredRecommendedDescriptionParameterTypeRequiredRecommended
customeraccountnamestringThe customer's accountname at the bank to which the refund was performed.
CustomerIBANstringThe customer's IBAN to which the refund was performed.
CustomerBICstringThe international bankcode, identifying the customer's bank, belonging to the IBAN to which the refund was performed.

Example Push

{
   "Transaction": {
      "Key": "BE6434EE6C8440B882A2A90C0F2XXXXX",
      "Invoice": "testinvoice 123",
      "ServiceCode": "giropay",
      "Status": {
         "Code": {
            "Code": 690,
            "Description": "Afgewezen"
         },
         "SubCode": {
            "Code": "S122",
            "Description": "De transactie kan niet worden gerefund."
         },
         "DateTime": "2017-07-20T10:21:57+02:00"
      },
      "IsTest": true,
      "Order": null,
      "Currency": "EUR",
      "AmountCredit": 1,
      "TransactionType": "C242",
      "Services": null,
      "CustomParameters": null,
      "AdditionalParameters": null,
      "MutationType": 1,
      "RelatedTransactions": [
         {
            "RelationType": "refund",
            "RelatedTransactionKey": "30D459B07FD648A993ACF7D4D0XXXXX"
         }
      ],
      "IsCancelable": false,
      "IssuingCountry": null,
      "StartRecurrent": false,
      "Recurring": false,
      "CustomerName": null,
      "PayerHash": null,
      "PaymentKey": "499003EB3FFC4B49B65F639C5EXXXXXX"
   }
}

Updated 2 months ago