Requests

      Requests


        Article Summary

        Pay

        The Pay action can be used to perform a payment.

        Base JSON request

        Use the base request as instructed on this page

        Pay request

        Basic parameters

        Example request

        {
          "Currency": "EUR",
          "AmountDebit": 0.01,
          "AmountCredit": null,
          "Invoice": "Knaken_0001",
          "Order": null,
          "Description": "Automated test Knaken",
          "ClientIP": {
            "Type": 0,
            "Address": "0.0.0.0"
          },
          "ReturnURL": "https://www.buckaroo.nl",
          "ReturnURLCancel": "https://www.buckaroo.nl/annuleren",
          "ReturnURLError": "https://www.buckaroo.nl/mislukt",
          "ReturnURLReject": "https://www.buckaroo.nl/geweigerd",
          "OriginalTransactionKey": null,
          "ServicesSelectableByClient": null,
          "ServicesExcludedForClient": null,
          "PushURL": null,
          "PushURLFailure": null,
          "CustomerName": "Rico",
          "ClientUserAgent": null,
          "OriginalTransactionReference": null,
          "Services": {
            "ServiceList": [
              {
                "Name": "Knaken",
                "Action": "Pay",
                "Version": 0,
                "Parameters": []
              }
            ]
          },
          "CustomParameters": null,
          "AdditionalParameters": null
        }
        

        Pay response

        Example response

        {
          "Key": "5766310E20A04C5AA362F272B04BA1234",
          "Status": {
            "Code": {
              "Code": 791,
              "Description": "Pending processing"
            },
            "SubCode": {
              "Code": "S002",
              "Description": "An additional action is required: Redirect"
            },
            "DateTime": "2024-02-05T09:49:32"
          },
          "RequiredAction": {
            "RedirectURL": "https://testcheckout.buckaroo.nl/html/redirect.ashx?r=AE39B63DF35A448BBFC3B9E6E2711234",
            "RequestedInformation": null,
            "PayRemainderDetails": null,
            "Name": "Redirect",
            "TypeDeprecated": 0
          },
          "Services": null,
          "CustomParameters": null,
          "AdditionalParameters": null,
          "RequestErrors": null,
          "Invoice": "Knaken_0001",
          "ServiceCode": "Knaken",
          "IsTest": true,
          "Currency": "EUR",
          "AmountDebit": 0.01,
          "TransactionType": "C038",
          "MutationType": 1,
          "RelatedTransactions": null,
          "ConsumerMessage": null,
          "Order": null,
          "IssuingCountry": null,
          "StartRecurrent": false,
          "Recurring": false,
          "CustomerName": "Rico",
          "PayerHash": null,
          "PaymentKey": "41CC59F712D04C73AB625CEFB5F21234"
        }
        

        Pay push

        Example push

        {
          "Transaction": {
            "Key": "5766310E20A04C5AA362F272B04B1234",
            "Invoice": "Knaken_0001",
            "ServiceCode": "Knaken",
            "Status": {
              "Code": {
                "Code": 190,
                "Description": "Success"
              },
              "SubCode": {
                "Code": "S990",
                "Description": "The request was successful."
              },
              "DateTime": "2024-02-05T09:49:40"
            },
            "IsTest": true,
            "Order": null,
            "Currency": "EUR",
            "AmountDebit": 0.01,
            "TransactionType": "C038",
            "Services": null,
            "CustomParameters": null,
            "AdditionalParameters": null,
            "MutationType": 1,
            "RelatedTransactions": null,
            "IsCancelable": false,
            "IssuingCountry": null,
            "StartRecurrent": false,
            "Recurring": false,
            "CustomerName": "Rico",
            "PayerHash": null,
            "PaymentKey": "41CC59F712D04C73AB625CEFB5F21234",
            "Description": "Automated test Knaken"
          }
        }
        

        Refund

        The Refund action can be used to perform a refund.

        Base JSON request

        Use the base request as instructed on this page

        Refund request

        Basic parameters

        Example request

        {
          "Currency": "EUR",
          "AmountDebit": null,
          "AmountCredit": 0.01,
          "Invoice": "Knaken_0001",
          "Order": null,
          "Description": "Refund_1706874945",
          "ClientIP": {
            "Type": 0,
            "Address": "0.0.0.0"
          },
          "ReturnURL": null,
          "ReturnURLCancel": null,
          "ReturnURLError": null,
          "ReturnURLReject": null,
          "OriginalTransactionKey": "5766310E20A04C5AA362F272B04B1234",
          "ServicesSelectableByClient": null,
          "ServicesExcludedForClient": null,
          "PushURL": null,
          "PushURLFailure": null,
          "ClientUserAgent": null,
          "OriginalTransactionReference": null,
          "Services": {
            "ServiceList": [
              {
                "Name": "Knaken",
                "Action": "Refund",
                "Version": 0,
                "Parameters": []
              }
            ]
          },
          "CustomParameters": null,
          "AdditionalParameters": null
        }
        

        Refund response

        Basic parameters

        Example response

        {
          "Key": "D9D881B5BE9A4EFA87C302AAD02E47C8",
          "Status": {
            "Code": {
              "Code": 190,
              "Description": "Success"
            },
            "SubCode": {
              "Code": "S990",
              "Description": "The request was successful."
            },
            "DateTime": "2024-02-02T12:55:44"
          },
          "RequiredAction": null,
          "Services": [
            {
              "Name": "Knaken",
              "Action": null,
              "Parameters": [
                {
                  "Name": "Processed",
                  "Value": "Classic"
                }
              ]
            }
          ],
          "CustomParameters": null,
          "AdditionalParameters": null,
          "RequestErrors": null,
          "Invoice": "Knaken_0001",
          "ServiceCode": "Knaken",
          "IsTest": true,
          "Currency": "EUR",
          "AmountCredit": 0.01,
          "TransactionType": "C146",
          "MutationType": 1,
          "RelatedTransactions": [
            {
              "RelationType": "refund",
              "RelatedTransactionKey": "5766310E20A04C5AA362F272B04B1234"
            }
          ],
          "ConsumerMessage": null,
          "Order": null,
          "IssuingCountry": null,
          "StartRecurrent": false,
          "Recurring": false,
          "CustomerName": null,
          "PayerHash": null,
          "PaymentKey": "A4ACF0B4DDBA4D668CC4A642B28E1234"
        }
        

        Refund push

        Parameters

        Basic parameters

        Example push

        {
          "Transaction": {
            "Key": "D9D881B5BE9A4EFA87C302AAD02E47C8",
            "Invoice": "Knaken_0001",
            "ServiceCode": "Knaken",
            "Status": {
              "Code": {
                "Code": 190,
                "Description": "Success"
              },
              "SubCode": {
                "Code": "S990",
                "Description": "The request was successful."
              },
              "DateTime": "2024-02-02T12:55:44"
            },
            "IsTest": true,
            "Order": null,
            "Currency": "EUR",
            "AmountCredit": 0.01,
            "TransactionType": "C146",
            "Services": null,
            "CustomParameters": null,
            "AdditionalParameters": null,
            "MutationType": 1,
            "RelatedTransactions": [
              {
                "RelationType": "refund",
                "RelatedTransactionKey": "5766310E20A04C5AA362F272B04B1234"
              }
            ],
            "IsCancelable": false,
            "IssuingCountry": null,
            "StartRecurrent": false,
            "Recurring": false,
            "CustomerName": "Rico",
            "PayerHash": null,
            "PaymentKey": "A4ACF0B4DDBA4D668CC4A642B28E1234",
            "Description": "Refund_1706874945"
          }
        }
        

        Was this article helpful?

        What's Next