Custom variables

Apart from the Buckaroo variables, it is also possible to add Merchant related variables to each transaction request. Additional variables can also be included to the response and push updates. There are two variable types:

Custom variables

These are configured in advance in the Payment Plaza. The advantage of this is that these are visible and searchable in the Payment Plaza, because the values are stored in the Payment Plaza. It is also possible to provide the type of field. The syntax is defined as cust_[variablename] (for example cust_event ). Custom variables are case sensitive.

Additional variables

These are not configured in advance. The additional variables can also be found in the Payment Plaza in the transaction details, but they are not searchable. The syntax is defined as add_[variablename] (for example add_MyShopNumber ).

Remark: Both custom and additional variables are optional and it is not mandatory to include these variables. Not entering these variables does not trigger an error message.

Payment flow including variables

The following explanation is listed in chronological order:

1. Submit the transaction
2. Processing the payment request.
3. Redirect after the payment has completed the payment attempt
4. Push of the results of the payment attempt
5. Request for a transaction report
6. Use of the variable in PayperEmails, reminders, letters and text messages

Custom variables in JSON

"CustomParameters": {
   "List": [
   {
       "Name": "name_of_the_plaza_field1",
       "Value": "Example of field value"
   },
   {
       "Name": "name_of_the_plaza_field2",
       "Value": "600"
   }
  ]
}

Additional variables in JSON

Transaction request:

  "AdditionalParameters": {
    "AdditionalParameter": [
      {
        "Name": "Country",
        "Value": "Germany"
      },
      {
        "Name": "ShopID",
        "Value": "12345"
      }
    ]
  }

Data request:

  "AdditionalParameters": {
    "List": [
      {
        "Name": "Country",
        "Value": "Germany"
      },
      {
        "Name": "ShopID",
        "Value": "12345"
      }
    ]
  }