Requests

Requests


Pay

The Pay action is used to perform a single KBC payment.

Base JSON request

Use the base request as instructed on this page

Pay request

Parameters

Basic parameters

Example request

{
  "Currency": "EUR",
  "AmountDebit": 10.00,
  "Invoice": "Test invoice 123",
  "Services": {
    "ServiceList": [
      {
        "Name": "KBCPaymentButton",
        "Action": "Pay"
      }
    ]
  }
}

Pay response

If the request has a valid structure and a valid signature, a transaction will be created in the Payment Engine and a response will be returned. In this case, an additional action is required before the transaction can be completed. The customer needs to be redirected to the payment environment through the returned redirectURL.

Parameters

Basic parameters

Example response

{
    "Key": "DD60791D60B0411DB03191FC00F2XXXX",
    "Status": {
        "Code": {
            "Code": 791,
            "Description": "Pending processing"
        },
        "SubCode": {
            "Code": "S002",
            "Description": "An additional action is required: TestStatusRedirect"
        },
        "DateTime": "2018-09-11T11:25:49"
    },
    "RequiredAction": {
        "RedirectURL": "https://testcheckout.buckaroo.nl/html/redirect.ashx?r=80C7203386304B17A3064EA6B2C4XXXX",
        "RequestedInformation": null,
        "PayRemainderDetails": null,
        "Name": "Redirect",
        "TypeDeprecated": 0
    },
    "Services": null,
    "CustomParameters": null,
    "AdditionalParameters": null,
    "RequestErrors": null,
    "Invoice": "Test invoice 123",
    "ServiceCode": "KbcPaymentButton",
    "IsTest": true,
    "Currency": "EUR",
    "AmountDebit": 10,
    "TransactionType": "C480",
    "MutationType": 1,
    "RelatedTransactions": null,
    "ConsumerMessage": null,
    "Order": null,
    "IssuingCountry": null,
    "StartRecurrent": false,
    "Recurring": false,
    "CustomerName": null,
    "PayerHash": null,
    "PaymentKey": "E68A061D20E142D0A813E530213AXXXX"
}

Pay push

Parameters

Basic parameters

Example push

{
   "Transaction": {
      "Key": "DD60791D60B0411DB03191FC00F2XXXX",
      "Invoice": "Test invoice 123",
      "ServiceCode": "KbcPaymentButton",
      "Status": {
         "Code": {
            "Code": 190,
            "Description": "Success"
         },
         "SubCode": {
            "Code": "S990",
            "Description": "The request was successful."
         },
         "DateTime": "2018-09-11T11:27:08"
      },
      "IsTest": true,
      "Order": null,
      "Currency": "EUR",
      "AmountDebit": 10,
      "TransactionType": "C480",
      "Services": null,
      "CustomParameters": null,
      "AdditionalParameters": null,
      "MutationType": 1,
      "RelatedTransactions": null,
      "IsCancelable": false,
      "IssuingCountry": null,
      "StartRecurrent": false,
      "Recurring": false,
      "CustomerName": null,
      "PayerHash": null,
      "PaymentKey": "E68A061D20E142D0A813E530213AXXXX"
   }
}

Refund

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

Important note:

A refund can only be done after the money has been received by Buckaroo. This usually takes up to 2 working days after the initial success response of the payment.

Refund request

Parameters

Service specific parameters

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

Example request

{
  "Currency": "EUR",
  "AmountCredit": 1.00,
  "Invoice": "test invoice 123",
  "OriginalTransactionKey": "DD60791D60B0411DB03191FC00F2XXXX",
  "Services": {
    "ServiceList": [
      {
        "Name": "KBCPaymentButton",
        "Action": "Refund"
      }
    ]
  }
}

Refund response

Parameters

Basic parameters

Example response

{
    "Key": "C8220EE23D624C73BFED1E7405C4XXXX",
    "Status": {
        "Code": {
            "Code": 190,
            "Description": "Success"
        },
        "SubCode": {
            "Code": "S990",
            "Description": "The request was successful."
        },
        "DateTime": "2018-09-11T11:30:14"
    },
    "RequiredAction": null,
    "Services": null,
    "CustomParameters": null,
    "AdditionalParameters": null,
    "RequestErrors": null,
    "Invoice": "test invoice 123",
    "ServiceCode": "KbcPaymentButton",
    "IsTest": true,
    "Currency": "EUR",
    "AmountCredit": 1,
    "TransactionType": "C481",
    "MutationType": 1,
    "RelatedTransactions": [
        {
            "RelationType": "refund",
            "RelatedTransactionKey": "DD60791D60B0411DB03191FC00F2XXXX"
        }
    ],
    "ConsumerMessage": null,
    "Order": null,
    "IssuingCountry": null,
    "StartRecurrent": false,
    "Recurring": false,
    "CustomerName": null,
    "PayerHash": null,
    "PaymentKey": "482572BF6CE74C8B97C7966081C6XXXX"
}

Refund push

Parameters

Basic parameters

Example push

{
   "Transaction": {
      "Key": "C8220EE23D624C73BFED1E7405C4XXXX",
      "Invoice": "test invoice 123",
      "ServiceCode": "KbcPaymentButton",
      "Status": {
         "Code": {
            "Code": 190,
            "Description": "Success"
         },
         "SubCode": null,
         "DateTime": "2018-09-11T11:30:14"
      },
      "IsTest": true,
      "Order": null,
      "Currency": "EUR",
      "AmountCredit": 1,
      "TransactionType": "C481",
      "Services": null,
      "CustomParameters": null,
      "AdditionalParameters": null,
      "MutationType": 1,
      "RelatedTransactions": [
         {
            "RelationType": "refund",
            "RelatedTransactionKey": "DD60791D60B0411DB03191FC00F2XXXX"
         }
      ],
      "IsCancelable": false,
      "IssuingCountry": null,
      "StartRecurrent": false,
      "Recurring": false,
      "CustomerName": null,
      "PayerHash": null,
      "PaymentKey": null
   }
}

Was this article helpful?

What's Next