Transaction (POST)

❗️

Post

Live: https://checkout.buckaroo.nl/json/Transaction
Test: https://testcheckout.buckaroo.nl/json/Transaction

Creates a new transaction in the Buckaroo Payment Engine

Header

The authentication of this JSON API is based on a standard HMAC Authentication implementation.

Request Information

URI parameters

None.

Body Parameters

TransactionRequest

NameTypeDescription
CurrencystringNone
AmountDebitdecimal numberNone
AmountCreditdecimal numberNone
InvoicestringNone
OrderstringNone
DescriptionstringNone
ClientIPIPAddressNone
ReturnURLstringNone
ReturnURLCancelstringNone
ReturnURLErrorstringNone
ReturnURLRejectstringNone
OriginalTransactionKeystringNone
StartRecurrentbooleanNone
ContinueOnIncompleteContinueOnIncompleteNone
ServicesSelectableByClientstringNone
ServicesExcludedForClientstringNone
PushURLstringNone
PushURLFailurestringNone
ClientUserAgentstringNone
OriginalTransactionReferenceTransactionReferenceNone
ServicesServicesRequestNone
CustomParametersCustomParametersNone
AdditionalParametersTransactionRequestAdditionalParametersNone

Models

NameTypeDescription
IPAddress

Request Formats

Sample:

{
  "Currency": "EUR",
  "AmountDebit": 1.0,
  "AmountCredit": 1.0,
  "Invoice": "Test Invoice 1234",
  "Order": "sample string 3",
  "Description": "Example for docs",
  "ClientIP": {
    "Type": 0,
    "Address": "192.168.2.1"
  },
  "ReturnURL": "https://www.buckaroo.nl/return",
  "ReturnURLCancel": "https://www.buckaroo.nl/returncancel",
  "ReturnURLError": "https://www.buckaroo.nl/returnerror",
  "ReturnURLReject": "https://www.buckaroo.nl/returnreject",
  "OriginalTransactionKey": "sample string 9",
  "StartRecurrent": true,
  "ContinueOnIncomplete": 0,
  "ServicesSelectableByClient": "ideal,mastercard,visa,giftcard",
  "ServicesExcludedForClient": "payconiq,nexi",
  "PushURL": "https://www.buckaroo.nl/push",
  "PushURLFailure": "https://www.buckaroo.nl/pushfail",
  "ClientUserAgent": "sample string 17",
  "OriginalTransactionReference": {
    "Type": "sample string 1",
    "Reference": "sample string 2"
  },
  "Services": {
    "ServiceList": [
      {
        "Name": "sample string 1",
        "Action": "sample string 2",
        "Version": 3,
        "Parameters": [
          {
            "Name": "sample string 1",
            "GroupType": "sample string 2",
            "GroupID": "sample string 3",
            "Value": "sample string 4"
          },
          {
            "Name": "sample string 1",
            "GroupType": "sample string 2",
            "GroupID": "sample string 3",
            "Value": "sample string 4"
          }
        ]
      },
      {
        "Name": "sample string 1",
        "Action": "sample string 2",
        "Version": 3,
        "Parameters": [
          {
            "Name": "sample string 1",
            "GroupType": "sample string 2",
            "GroupID": "sample string 3",
            "Value": "sample string 4"
          },
          {
            "Name": "sample string 1",
            "GroupType": "sample string 2",
            "GroupID": "sample string 3",
            "Value": "sample string 4"
          }
        ]
      }
    ]
  },
  "CustomParameters": {
    "List": [
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      }
    ]
  },
  "AdditionalParameters": {
    "AdditionalParameter": [
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      }
    ]
  }
}

Response Information

NameTypeDescription
KeystringNone
StatusStatusNone
RequiredActionTransactionRequestResponseRequiredActionNone
ServicesTransactionRequestResponseServiceResponseNone
CustomParametersCustomParametersNone
AdditionalParametersTransactionRequestAdditionalParametersNone
RequestErrorsTransactionRequestResponseRequestErrorsNone
InvoicestringNone
ServiceCodestringNone
IsTestbooleanNone
CurrencystringNone
AmountDebitdecimal numberNone
AmountCreditdecimal numberNone
TransactionTypestringNone
MutationTypeMutationTypeNone
RelatedTransactionsCollection of RelatedTransactionNone
ConsumerMessageTransactionRequestResponseConsumerMessageNone
OrderstringNone
IssuingCountrystringNone
StartRecurrentbooleanNone
RecurringbooleanNone
CustomerNamestringNone
PayerHashstringNone
PaymentKeystringNone

Response Formats

application/json, text/json
Sample:

{
  "Key": "4E8BD922192746C3918BF4077CXXXXXX",
  "Status": {
    "Code": {
      "Code": 1,
      "Description": "sample string 2"
    },
    "SubCode": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "DateTime": "2022-02-09T10:30:36.0795641+01:00"
  },
  "RequiredAction": {
    "RedirectURL": "sample string 1",
    "RequestedInformation": [
      {
        "Name": "sample string 1",
        "DataType": 0,
        "MaxLength": 2,
        "Required": true,
        "Description": "sample string 4"
      },
      {
        "Name": "sample string 1",
        "DataType": 0,
        "MaxLength": 2,
        "Required": true,
        "Description": "sample string 4"
      }
    ],
    "PayRemainderDetails": {
      "RemainderAmount": 1.0,
      "Currency": "sample string 2",
      "GroupTransaction": "sample string 3"
    },
    "Name": "Redirect",
    "TypeDeprecated": 0
  },
  "Services": [
    {
      "Name": "sample string 1",
      "Action": "sample string 2",
      "Parameters": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "VersionAsProperty": 1
    },
    {
      "Name": "sample string 1",
      "Action": "sample string 2",
      "Parameters": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "VersionAsProperty": 1
    }
  ],
  "CustomParameters": {
    "List": [
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      }
    ]
  },
  "AdditionalParameters": {
    "AdditionalParameter": [
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      }
    ]
  },
  "RequestErrors": {
    "ChannelErrors": [
      {
        "Service": "sample string 1",
        "Action": "sample string 2",
        "Name": "sample string 3",
        "Error": "sample string 4",
        "ErrorMessage": "sample string 5"
      },
      {
        "Service": "sample string 1",
        "Action": "sample string 2",
        "Name": "sample string 3",
        "Error": "sample string 4",
        "ErrorMessage": "sample string 5"
      }
    ],
    "ServiceErrors": [
      {
        "Name": "sample string 1",
        "Error": "sample string 2",
        "ErrorMessage": "sample string 3"
      },
      {
        "Name": "sample string 1",
        "Error": "sample string 2",
        "ErrorMessage": "sample string 3"
      }
    ],
    "ActionErrors": [
      {
        "Service": "sample string 1",
        "Name": "sample string 2",
        "Error": "sample string 3",
        "ErrorMessage": "sample string 4"
      },
      {
        "Service": "sample string 1",
        "Name": "sample string 2",
        "Error": "sample string 3",
        "ErrorMessage": "sample string 4"
      }
    ],
    "ParameterErrors": [
      {
        "Service": "sample string 1",
        "Action": "sample string 2",
        "Name": "sample string 3",
        "Error": "sample string 4",
        "ErrorMessage": "sample string 5"
      },
      {
        "Service": "sample string 1",
        "Action": "sample string 2",
        "Name": "sample string 3",
        "Error": "sample string 4",
        "ErrorMessage": "sample string 5"
      }
    ],
    "CustomParameterErrors": [
      {
        "Name": "sample string 1",
        "Error": "sample string 2",
        "ErrorMessage": "sample string 3"
      },
      {
        "Name": "sample string 1",
        "Error": "sample string 2",
        "ErrorMessage": "sample string 3"
      }
    ]
  },
  "Invoice": "sample string 2",
  "ServiceCode": "sample string 3",
  "IsTest": true,
  "Currency": "sample string 5",
  "AmountDebit": 1.0,
  "AmountCredit": 1.0,
  "TransactionType": "sample string 6",
  "MutationType": 0,
  "RelatedTransactions": [
    {
      "RelationType": "sample string 1",
      "RelatedTransactionKey": "sample string 2"
    },
    {
      "RelationType": "sample string 1",
      "RelatedTransactionKey": "sample string 2"
    }
  ],
  "ConsumerMessage": {
    "MustRead": true,
    "CultureName": "sample string 2",
    "Title": "sample string 3",
    "PlainText": "sample string 4",
    "HtmlText": "sample string 5"
  },
  "Order": "sample string 7",
  "IssuingCountry": "NL",
  "StartRecurrent": true,
  "Recurring": true,
  "CustomerName": "sample string 11",
  "PayerHash": "sample string 12",
  "PaymentKey": "sample string 13"
}