POST json/Transaction

Creates a new transaction in the Buckaroo Payment Engine

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Currency	string	None.
AmountDebit	decimal number	None.
AmountCredit	decimal number	None.
Invoice	string	None.
Order	string	None.
Description	string	None.
ClientIP	IPAddress	None.
ReturnURL	string	None.
ReturnURLCancel	string	None.
ReturnURLError	string	None.
ReturnURLReject	string	None.
OriginalTransactionKey	string	None.
StartRecurrent	boolean	None.
ContinueOnIncomplete	ContinueOnIncomplete	None.
ServicesSelectableByClient	string	None.
ServicesExcludedForClient	string	None.
PushURL	string	None.
PushURLFailure	string	None.
ClientUserAgent	string	None.
OriginalTransactionReference	TransactionReference	None.
Services	ServicesRequest	None.
CustomParameters	CustomParameters	None.
AdditionalParameters	TransactionRequestAdditionalParameters	None.

Request Formats

application/json, text/json

Sample:

{
  "Currency": "sample string 1",
  "AmountDebit": 1.0,
  "AmountCredit": 1.0,
  "Invoice": "sample string 2",
  "Order": "sample string 3",
  "Description": "sample string 4",
  "ClientIP": {
    "Type": 0,
    "Address": "sample string 1"
  },
  "ReturnURL": "sample string 5",
  "ReturnURLCancel": "sample string 6",
  "ReturnURLError": "sample string 7",
  "ReturnURLReject": "sample string 8",
  "OriginalTransactionKey": "sample string 9",
  "StartRecurrent": true,
  "ContinueOnIncomplete": 0,
  "ServicesSelectableByClient": "sample string 13",
  "ServicesExcludedForClient": "sample string 14",
  "PushURL": "sample string 15",
  "PushURLFailure": "sample string 16",
  "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"
      }
    ]
  }
}

text/html

Sample:

{"Currency":"sample string 1","AmountDebit":1.0,"AmountCredit":1.0,"Invoice":"sample string 2","Order":"sample string 3","Description":"sample string 4","ClientIP":{"Type":0,"Address":"sample string 1"},"ReturnURL":"sample string 5","ReturnURLCancel":"sample string 6","ReturnURLError":"sample string 7","ReturnURLReject":"sample string 8","OriginalTransactionKey":"sample string 9","StartRecurrent":true,"ContinueOnIncomplete":0,"ServicesSelectableByClient":"sample string 13","ServicesExcludedForClient":"sample string 14","PushURL":"sample string 15","PushURLFailure":"sample string 16","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

Resource Description

TransactionResponse

Name	Type	Additional information
Key	string	None.
Status	Status	None.
RequiredAction	TransactionRequestResponseRequiredAction	None.
Services	Collection of TransactionRequestResponseServiceResponse	None.
CustomParameters	CustomParameters	None.
AdditionalParameters	TransactionRequestAdditionalParameters	None.
RequestErrors	TransactionRequestResponseRequestErrors	None.
Invoice	string	None.
ServiceCode	string	None.
IsTest	boolean	None.
Currency	string	None.
AmountDebit	decimal number	None.
AmountCredit	decimal number	None.
TransactionType	string	None.
MutationType	MutationType	None.
RelatedTransactions	Collection of RelatedTransaction	None.
ConsumerMessage	TransactionRequestResponseConsumerMessage	None.
Order	string	None.
IssuingCountry	string	None.
StartRecurrent	boolean	None.
Recurring	boolean	None.
CustomerName	string	None.
PayerHash	string	None.
PaymentKey	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Key": "sample string 1",
  "Status": {
    "Code": {
      "Code": 1,
      "Description": "sample string 2"
    },
    "SubCode": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "DateTime": "2024-04-19T03:23:38.1276703+02: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": "sample string 8",
  "StartRecurrent": true,
  "Recurring": true,
  "CustomerName": "sample string 11",
  "PayerHash": "sample string 12",
  "PaymentKey": "sample string 13"
}

text/html

Sample:

{"Key":"sample string 1","Status":{"Code":{"Code":1,"Description":"sample string 2"},"SubCode":{"Code":"sample string 1","Description":"sample string 2"},"DateTime":"2024-04-19T03:23:38.1276703+02: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":"sample string 8","StartRecurrent":true,"Recurring":true,"CustomerName":"sample string 11","PayerHash":"sample string 12","PaymentKey":"sample string 13"}