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

ParameterTypeRequiredRecommendedDescription
VoucherCodeStringYesVoucherCode of an active voucher

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

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

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.

Refund Request

Parameters

Service-specific parameters

ParameterTypeRequiredRecommendedDescription
OriginalTransactionKeyStringYesTransaction key of the payment that needs to be refunded. Note: This is a basic request variable, not a service-specific variable.

Example request

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

Refund Response

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

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

Example request

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

GetBalance Response

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 by uploading a batch file. In case you want to create Vouchers with a batch file, you can request an example file through [email protected].

CreateApplication Request

Parameters

Service-specific parameters

ParameterTypeRequiredRecommendedDescription
GroupReferenceStringReference to group vouchers
UsageTypeDecimalYesSingle (1) or Multiple (2).
ValidFromDatetimeYesDate from which the voucher is valid
ValidUntilDatetimeDate until which the voucher is valid
CreationBalanceDecimalYesValue of the voucher

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

ParameterTypeRequiredRecommendedDescription
GroupReferenceStringReference to group vouchers
UsageTypeDecimalYesSingle (1) or Multiple (2).
ValidFromDatetimeYesDate from which the voucher is valid
ValidUntilDatetimeDate until which the voucher is valid
CreationBalanceDecimalYesValue of the voucher

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.

DeactivateVoucher Request

Parameters

Service-specific parameters

ParameterTypeRequiredRecommendedDescription
VoucherCodeStringYesVoucherCode of an active voucher

Example request

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

DeactivateVoucher Response

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
}

Updated 2 months ago