Requests

Requests


Pay

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

Base JSON request

Use the base request as instructed on this page

Pay request

Parameters

Service specific parameters

Parameter Type Required Recommended Description
VoucherCode string Required VoucherCode of an active voucher
Basic parameters

Example request

{
  "Currency": "EUR",
  "AmountDebit": 10.00,
  "Invoice": "testinvoice 123",
  "Services": {
    "ServiceList": [
      {
        "Name": "buckaroovoucher",
        "Action": "Pay",
        "Parameters": [
          {
            "Name": "vouchercode",
            "Value": "WP6W-XXXX-XXXX-56T7"
          }
        ]
      }
    ]
  }
}

Pay response

Parameters

Basic parameters

Example response

{
  "Key": "3171784167F8478C803090XXXXXXXXXX",
  "Status": {
    "Code": {
      "Code": 190,
      "Description": "Success"
    },
    "SubCode": {
      "Code": "S001",
      "Description": "Transaction successfully processed"
    },
    "DateTime": "2020-06-04T09:51:51"
  },
  "RequiredAction": null,
  "Services": [
    {
      "Name": "buckaroovoucher",
      "Action": null,
      "Parameters": [
        {
          "Name": "VoucherCode",
          "Value": "WP6W-XXXX-XXXX-56T7"
        }
      ]
    }
  ],
  "CustomParameters": null,
  "AdditionalParameters": null,
  "RequestErrors": null,
  "Invoice": "testinvoice 123",
  "ServiceCode": "buckaroovoucher",
  "IsTest": true,
  "Currency": "EUR",
  "AmountDebit": 10,
  "TransactionType": "V800",
  "MutationType": 2,
  "RelatedTransactions": null,
  "ConsumerMessage": null,
  "Order": null,
  "IssuingCountry": null,
  "StartRecurrent": false,
  "Recurring": false,
  "CustomerName": null,
  "PayerHash": null,
  "PaymentKey": "D847D4B2EA8043EC90D441XXXXXXXXXX"
}

Pay push

Parameters

Basic parameters

Example push

{
  "Transaction":{
    "Key":"3171784167F8478C803090XXXXXXXXXX",
    "Invoice":"testinvoice 123",
    "ServiceCode":"buckaroovoucher",
    "Status":{
      "Code":{
        "Code":190,
        "Description":"Success"
      },
      "SubCode":{
        "Code":"S001",
        "Description":"Transaction successfully processed"
      },
      "DateTime":"2020-06-04T09:51:51"
    },
    "IsTest":true,
    "Order":null,
    "Currency":"EUR",
    "AmountDebit":10.00,
    "TransactionType":"V800",
    "Services":[
      {
        "Name":"buckaroovoucher",
        "Action":null,
        "Parameters":[
          {
            "Name":"VoucherCode",
            "Value":"WP6W-XXXX-XXXX-56T7"
          }
        ],
        "VersionAsProperty":1
      }
    ],
    "CustomParameters":null,
    "AdditionalParameters":null,
    "MutationType":2,
    "RelatedTransactions":null,
    "IsCancelable":false,
    "IssuingCountry":null,
    "StartRecurrent":false,
    "Recurring":false,
    "CustomerName":null,
    "PayerHash":null,
    "PaymentKey":"D847D4B2EA8043EC90D441XXXXXXXXXX"
  }
}

Refund

The Refund action can be used to perform a refund on an earlier voucher transaction. There is no customer interaction needed to do this.

Base JSON request

Use the base request as instructed on this page

Refund request

Parameters

Service specific parameters

Parameter Type Required Recommended Description
originaltransaction string Required Transaction key of the payment that needs to be refunded. Please note: This is a basic request variable, not a service specific variable.
Basic parameters

Example request

{
  "Currency": "EUR",
  "AmountCredit": 10.00,
  "Invoice": "testinvoice 123",
  "OriginalTransactionKey": "3171784167F8478C803090XXXXXXXXXX",
  "Services": {
    "ServiceList": [
      {
        "Name": "buckaroovoucher",
        "Action": "Refund"
      }
    ]
  }
}

Refund response

Parameters

Basic parameters

Example response

{
  "Key": "A419347FFC534AE3B34256XXXXXXXXXX",
  "Status": {
    "Code": {
      "Code": 190,
      "Description": "Success"
    },
    "SubCode": {
      "Code": "S001",
      "Description": "Transaction successfully processed"
    },
    "DateTime": "2020-06-04T09:59:30"
  },
  "RequiredAction": null,
  "Services": null,
  "CustomParameters": null,
  "AdditionalParameters": null,
  "RequestErrors": null,
  "Invoice": "testinvoice 123",
  "ServiceCode": "buckaroovoucher",
  "IsTest": true,
  "Currency": "EUR",
  "AmountCredit": 10,
  "TransactionType": "V801",
  "MutationType": 2,
  "RelatedTransactions": [
    {
      "RelationType": "refund",
      "RelatedTransactionKey": "3171784167F8478C803090XXXXXXXXXX"
    }
  ],
  "ConsumerMessage": null,
  "Order": null,
  "IssuingCountry": null,
  "StartRecurrent": false,
  "Recurring": false,
  "CustomerName": null,
  "PayerHash": null,
  "PaymentKey": "AF266BBB414F4BB28563BDXXXXXXXXXX"
}

Refund push

Parameters

Basic parameters

Example push

{
  "Transaction":{
    "Key":"A419347FFC534AE3B34256XXXXXXXXXX",
    "Invoice":"testinvoice 123",
    "ServiceCode":"buckaroovoucher",
    "Status":{
      "Code":{
        "Code":190,
        "Description":"Success"
      },
      "SubCode":null,
      "DateTime":"2020-06-04T09:59:30"
    },
    "IsTest":true,
    "Order":null,
    "Currency":"EUR",
    "AmountCredit":10.00,
    "TransactionType":"V801",
    "Services":null,
    "CustomParameters":null,
    "AdditionalParameters":null,
    "MutationType":2,
    "RelatedTransactions":[
      {
        "RelationType":"refund",
        "RelatedTransactionKey":"3171784167F8478C803090XXXXXXXXXX"
      }
    ],
    "IsCancelable":false,
    "IssuingCountry":null,
    "StartRecurrent":false,
    "Recurring":false,
    "CustomerName":null,
    "PayerHash":null,
    "PaymentKey":null
  }
}

GetBalance

Base JSON request

Use the base request as instructed on this page

GetBalance request

Parameters

Basic parameters

Example request

{
  "Currency": "EUR",
  "Services": {
    "ServiceList": [
      {
        "Name": "buckaroovoucher",
        "Action": "GetBalance",
        "Parameters": [
          {
            "Name": "vouchercode",
            "Value": "WP6W-XXXX-XXXX-56T7"
          }
        ]
      }
    ]
  }
}

GetBalance response

Parameters

Basic parameters

Example response

{
  "Key": "D9BE327DD7A54D99B0B52DXXXXXXXXXX",
  "Status": {
    "Code": {
      "Code": 190,
      "Description": "Success"
    },
    "SubCode": {
      "Code": "S001",
      "Description": "Transaction successfully processed"
    },
    "DateTime": "2020-06-04T09:35:58"
  },
  "RequiredAction": null,
  "Services": [
    {
      "Name": "buckaroovoucher",
      "Action": null,
      "Parameters": [
        {
          "Name": "CurrentBalance",
          "Value": "17.7500"
        }
      ]
    }
  ],
  "CustomParameters": null,
  "AdditionalParameters": null,
  "RequestErrors": null,
  "ServiceCode": "buckaroovoucher",
  "IsTest": true,
  "ConsumerMessage": null
}

CreateApplication

Vouchers can be created through the CreateApplication action, which can either be done through an API request or uploading a batchfile. In case you want to create Vouchers with a batchfile, you can request an example file through support@buckaroo.nl.

Base JSON request

Use the base request as instructed on this page

CreateApplication request

Parameters

Service specific parameters

Parameter Type Required Recommended Description
GroupReference string Reference to group vouchers
UsageType decimal Required Single (1) or Multiple (2).
ValidFrom datetime Required Date from which the voucher is valid.
ValidUntil datetime Date until which the voucher is valid.
CreationBalance decimal Required Value of the voucher.
Basic parameters

Example request

{
  "Currency": "EUR",
  "Services": {
    "ServiceList": [
      {
        "Name": "buckaroovoucher",
        "Action": "CreateApplication",
        "Parameters": [
          {
            "Name": "UsageType",
            "Value": "1"
          },
          {
            "Name": "ValidFrom",
            "Value": "2020-06-03"
          },
          {
            "Name": "ValidUntil",
            "Value": "2021-06-03"
          },
          {
            "Name": "CreationBalance",
            "Value": "17.75"
          }
        ]
      }
    ]
  }
}

CreateApplication response

Parameters

Service specific parameters

Parameter Type Required Recommended Description
GroupReference string Reference to group vouchers
UsageType decimal Required Single (1) or Multiple (2).
ValidFrom datetime Required Date from which the voucher is valid.
ValidUntil datetime Date until which the voucher is valid.
CreationBalance decimal Required Value of the voucher.
Basic parameters

Example response

{
  "Key": "8E64E1B0865C4FB096FCD1XXXXXXXXXX",
  "Status": {
    "Code": {
      "Code": 190,
      "Description": "Success"
    },
    "SubCode": {
      "Code": "S001",
      "Description": "Transaction successfully processed"
    },
    "DateTime": "2020-06-04T09:29:48"
  },
  "RequiredAction": null,
  "Services": [
    {
      "Name": "buckaroovoucher",
      "Action": null,
      "Parameters": [
        {
          "Name": "VoucherCode",
          "Value": "WP6W-XXXX-XXXX-56T7"
        },
        {
          "Name": "CreationBalance",
          "Value": "17.75"
        },
        {
          "Name": "ValidFrom",
          "Value": "06/03/2020 00:00:00"
        },
        {
          "Name": "ValidUntil",
          "Value": "06/03/2021 00:00:00"
        }
      ]
    }
  ],
  "CustomParameters": null,
  "AdditionalParameters": null,
  "RequestErrors": null,
  "ServiceCode": "buckaroovoucher",
  "IsTest": true,
  "ConsumerMessage": null
}

DeactivateVoucher

Perform this call to deactivate an active voucher.

Base JSON request

Use the base request as instructed on this page

DeactivateVoucher request

Parameters

Service specific parameters

Parameter Type Required Recommended Description
VoucherCode string Required VoucherCode of an active voucher
Basic parameters

Example request

{
  "Services": {
    "ServiceList": [
      {
        "Name": "buckaroovoucher",
        "Action": "DeactivateVoucher",
        "Parameters": [
          {
            "Name": "VoucherCode",
            "Value": "xxxxxxxxxxxxxxxxxxx"
          },
        ]
      }
    ]
  }
}

DeactivateVoucher response

Parameters

Basic parameters

Example response

{
   "Key": "694DDFE90A5646DBA001A015411XXXX",
   "Status": {
      "Code": {
         "Code": 190,
         "Description": "Success"
      },
      "SubCode": {
         "Code": "S001",
         "Description": "Transaction successfully processed"
      },
      "DateTime": "2020-06-02T13:31:49"
   },
   "RequiredAction": null,
   "Services": null,
   "CustomParameters": null,
   "AdditionalParameters": null,
   "RequestErrors": null,
   "ServiceCode": "buckaroovoucher",
   "IsTest": false,
   "ConsumerMessage": null
}

Was dit artikel nuttig?

What's Next