POST json/DataRequest

This performs a datarequest on the Buckaroo Payment Engine

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ClientIP	IPAddress	None.
ReturnURL	string	None.
ReturnURLCancel	string	None.
ReturnURLError	string	None.
ReturnURLReject	string	None.
Invoice	string	None.
Description	string	None.
Currency	string	None.
Amount	decimal number	None.
AmountCredit	decimal number	None.
OriginalTransactionKey	string	None.
OriginalTransactionReference	TransactionReference	None.
ContinueOnIncomplete	ContinueOnIncomplete	None.
ClientUserAgent	string	None.
PushURL	string	None.
PushURLFailure	string	None.
Services	Services	None.
CustomParameters	DataCustomParameters	None.
AdditionalParameters	DataAdditionalParameters	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientIP": {
    "Type": 0,
    "Address": "sample string 1"
  },
  "ReturnURL": "sample string 1",
  "ReturnURLCancel": "sample string 2",
  "ReturnURLError": "sample string 3",
  "ReturnURLReject": "sample string 4",
  "Invoice": "sample string 5",
  "Description": "sample string 6",
  "Currency": "sample string 7",
  "Amount": 8.0,
  "AmountCredit": 9.0,
  "OriginalTransactionKey": "sample string 10",
  "OriginalTransactionReference": {
    "Type": "sample string 1",
    "Reference": "sample string 2"
  },
  "ContinueOnIncomplete": 0,
  "ClientUserAgent": "sample string 11",
  "PushURL": "sample string 12",
  "PushURLFailure": "sample string 13",
  "Services": {
    "Global": [
      {
        "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"
      }
    ],
    "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": {
    "List": [
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      }
    ]
  }
}

text/html

Sample:

{"ClientIP":{"Type":0,"Address":"sample string 1"},"ReturnURL":"sample string 1","ReturnURLCancel":"sample string 2","ReturnURLError":"sample string 3","ReturnURLReject":"sample string 4","Invoice":"sample string 5","Description":"sample string 6","Currency":"sample string 7","Amount":8.0,"AmountCredit":9.0,"OriginalTransactionKey":"sample string 10","OriginalTransactionReference":{"Type":"sample string 1","Reference":"sample string 2"},"ContinueOnIncomplete":0,"ClientUserAgent":"sample string 11","PushURL":"sample string 12","PushURLFailure":"sample string 13","Services":{"Global":[{"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"}],"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":{"List":[{"Name":"sample string 1","Value":"sample string 2"},{"Name":"sample string 1","Value":"sample string 2"}]}}

Response Information

Resource Description

DataResponse

Name	Type	Additional information
Key	string	None.
Status	Status	None.
RequiredAction	DataRequestResponseRequiredAction	None.
Services	Collection of DataResponseService	None.
CustomParameters	DataCustomParameters	None.
AdditionalParameters	DataAdditionalParameters	None.
RequestErrors	DataRequestResponseRequestErrors	None.
ServiceCode	string	None.
IsTest	boolean	None.
ConsumerMessage	DataRequestResponseConsumerMessage	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-12-11T22:07:54.5390987+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"
      }
    ],
    "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": {
    "List": [
      {
        "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"
      }
    ]
  },
  "ServiceCode": "sample string 2",
  "IsTest": true,
  "ConsumerMessage": {
    "MustRead": true,
    "CultureName": "sample string 2",
    "Title": "sample string 3",
    "PlainText": "sample string 4",
    "HtmlText": "sample string 5"
  }
}

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-12-11T22:07:54.5390987+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"}],"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":{"List":[{"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"}]},"ServiceCode":"sample string 2","IsTest":true,"ConsumerMessage":{"MustRead":true,"CultureName":"sample string 2","Title":"sample string 3","PlainText":"sample string 4","HtmlText":"sample string 5"}}