Batch API

Description

The batch API supports multiple transaction requests combined into 1 request to our Batch API endpoints:

Test end point: https://testcheckout.buckaroo.nl/json/batch/Transactions

Live end point: https://checkout.buckaroo.nl/json/batch/Transactions

Request

Example

Copy
[
   [
      {
         "AmountDebit": 10,
         "Currency": "EUR",
         "Invoice": "BATCHA12455110000",
         "Description": "124551 BATCHA12455110000",
         "StartRecurrent": "True",
         "Culture": "nl-NL",
         "Services": {
            "ServiceList": [
               {
                  "Name": "CreditManagement3",
                  "Action": "CreateCombinedInvoice",
                  "Parameters": [
                     {
                        "Name": "InvoiceAmount",
                        "Value": "10.00"
                     },
                     {
                        "Name": "InvoiceDate",
                        "Value": "2020-02-10"
                     },
                     {
                        "Name": "DueDate",
                        "Value": "2020-10-03"
                     },
                     {
                        "Name": "SchemeKey",
                        "Value": "DefaultNone"
                     },
                     {
                        "Name": "Code",
                        "GroupType": "Debtor",
                        "Value": "JanVanPietersen123"
                     }
                  ]
               },
               {
                  "Name": "SepaDirectDebit",
                  "Action": "Pay",
                  "Parameters": [
                     {
                        "Name": "customeraccountname",
                        "Value": "John Smith"
                     },
                     {
                        "Name": "CustomerIBAN",
                        "Value": "NL32INGB00000XXXXX"
                     },
                     {
                        "Name": "CollectDate",
                        "Value": "2020-04-03"
                     }
                  ]
               }
            ]
         }
      },
      {
         "AmountDebit": 10,
         "Currency": "EUR",
         "Invoice": "BATCHA12455110001",
         "Description": "124551 BATCHA12455110000",
         "StartRecurrent": "True",
         "Culture": "nl-NL",
         "Services": {
            "ServiceList": [
               {
                  "Name": "CreditManagement3",
                  "Action": "CreateCombinedInvoice",
                  "Parameters": [
                     {
                        "Name": "InvoiceAmount",
                        "Value": "10.00"
                     },
                     {
                        "Name": "InvoiceDate",
                        "Value": "2020-02-10"
                     },
                     {
                        "Name": "DueDate",
                        "Value": "2020-10-03"
                     },
                     {
                        "Name": "SchemeKey",
                        "Value": "DefaultNone"
                     },
                     {
                        "Name": "Code",
                        "GroupType": "Debtor",
                        "Value": "JanVanPietersen123"
                     }
                  ]
               },
               {
                  "Name": "SepaDirectDebit",
                  "Action": "Pay",
                  "Parameters": [
                     {
                        "Name": "customeraccountname",
                        "Value": "John Smith"
                     },
                     {
                        "Name": "CustomerIBAN",
                        "Value": "NL32INGB00000XXXXX"
                     },
                     {
                        "Name": "CollectDate",
                        "Value": "2020-04-03"
                     }
                  ]
               }
            ]
         }
      }
   ]
]

Success response

A correct batch API request will result in a gateway response with the message that the transactions are queued for processing at Buckaroo.

Example

Copy
{
   "Message": "2 transactions were queued for processing."
}

Error response

  • The batch API has basic validation: required parameters and value formats. Such validation errors are returned in the gateway response.
  • The error field is an Array of objects with the properties “Reference” and “Message”. The reference refers to the InvoiceNumber used in the request. The message will contain the error message related to the request using the referenced InvoiceNumber.
  • If one or more basic validation errors occur, the entire batch will be rejected and therefor nothing will be processed. The gateway response will return every validation error found per transaction object, referring to each object by its invoice number.
  • The batch API does not perform service specific validations, for example Credit Management validations like correct scheme key, invoice and due dates and duplicate invoice numbers.
  • Service specific validation errors are notified through the transaction push response.

Example

Copy
{
   "Message": "One or more validation errors occurred.",
   "Errors": [
      {
         "Reference": "INV00001",
         "Message": "amount should be provided for the action."
      }
   ]
}